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 chain::{BestBlock, Confirm, Listen, Watch, keysinterface::KeysInterface};
14 use chain::channelmonitor::ChannelMonitor;
15 use chain::transaction::OutPoint;
16 use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
17 use ln::channelmanager::{ChainParameters, ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure, PaymentId, MIN_CLTV_EXPIRY_DELTA};
18 use routing::gossip::{P2PGossipSync, NetworkGraph, NetworkUpdate};
19 use routing::router::{PaymentParameters, Route, get_route};
20 use ln::features::{InitFeatures, InvoiceFeatures};
22 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler};
23 use util::enforcing_trait_impls::EnforcingSigner;
26 use util::test_utils::{panicking, TestChainMonitor};
27 use util::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PaymentPurpose};
28 use util::errors::APIError;
29 use util::config::UserConfig;
30 use 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;
45 use core::cell::RefCell;
47 use 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` when connecting blocks. During disconnection only
111 /// `transaction_unconfirmed` is called.
112 TransactionsFirstReorgsOnlyTip,
113 /// Provides the full block via the `chain::Listen` interface. In the current code this is
114 /// equivalent to `TransactionsFirst` with some additional assertions.
119 fn random_style() -> ConnectStyle {
120 #[cfg(feature = "std")] {
121 use core::hash::{BuildHasher, Hasher};
122 // Get a random value using the only std API to do so - the DefaultHasher
123 let rand_val = std::collections::hash_map::RandomState::new().build_hasher().finish();
124 let res = match rand_val % 7 {
125 0 => ConnectStyle::BestBlockFirst,
126 1 => ConnectStyle::BestBlockFirstSkippingBlocks,
127 2 => ConnectStyle::BestBlockFirstReorgsOnlyTip,
128 3 => ConnectStyle::TransactionsFirst,
129 4 => ConnectStyle::TransactionsFirstSkippingBlocks,
130 5 => ConnectStyle::TransactionsFirstReorgsOnlyTip,
131 6 => ConnectStyle::FullBlockViaListen,
134 eprintln!("Using Block Connection Style: {:?}", res);
137 #[cfg(not(feature = "std"))] {
138 ConnectStyle::FullBlockViaListen
143 pub fn connect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, depth: u32) -> BlockHash {
144 let skip_intermediaries = match *node.connect_style.borrow() {
145 ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks|
146 ConnectStyle::BestBlockFirstReorgsOnlyTip|ConnectStyle::TransactionsFirstReorgsOnlyTip => true,
150 let height = node.best_block_info().1 + 1;
151 let mut block = Block {
152 header: BlockHeader { version: 0x2000000, prev_blockhash: node.best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: height, bits: 42, nonce: 42 },
157 let prev_blockhash = block.header.block_hash();
158 do_connect_block(node, block, skip_intermediaries);
160 header: BlockHeader { version: 0x20000000, prev_blockhash, merkle_root: TxMerkleNode::all_zeros(), time: height + i, bits: 42, nonce: 42 },
164 let hash = block.header.block_hash();
165 do_connect_block(node, block, false);
169 pub fn connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: &Block) {
170 do_connect_block(node, block.clone(), false);
173 fn call_claimable_balances<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
174 // Ensure `get_claimable_balances`' self-tests never panic
175 for funding_outpoint in node.chain_monitor.chain_monitor.list_monitors() {
176 node.chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances();
180 fn do_connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: Block, skip_intermediaries: bool) {
181 call_claimable_balances(node);
182 let height = node.best_block_info().1 + 1;
183 #[cfg(feature = "std")] {
184 eprintln!("Connecting block using Block Connection Style: {:?}", *node.connect_style.borrow());
186 if !skip_intermediaries {
187 let txdata: Vec<_> = block.txdata.iter().enumerate().collect();
188 match *node.connect_style.borrow() {
189 ConnectStyle::BestBlockFirst|ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::BestBlockFirstReorgsOnlyTip => {
190 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
191 call_claimable_balances(node);
192 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
193 node.node.best_block_updated(&block.header, height);
194 node.node.transactions_confirmed(&block.header, &txdata, height);
196 ConnectStyle::TransactionsFirst|ConnectStyle::TransactionsFirstSkippingBlocks|ConnectStyle::TransactionsFirstReorgsOnlyTip => {
197 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
198 call_claimable_balances(node);
199 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
200 node.node.transactions_confirmed(&block.header, &txdata, height);
201 node.node.best_block_updated(&block.header, height);
203 ConnectStyle::FullBlockViaListen => {
204 node.chain_monitor.chain_monitor.block_connected(&block, height);
205 node.node.block_connected(&block, height);
209 call_claimable_balances(node);
210 node.node.test_process_background_events();
211 node.blocks.lock().unwrap().push((block, height));
214 pub fn disconnect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, count: u32) {
215 call_claimable_balances(node);
216 #[cfg(feature = "std")] {
217 eprintln!("Disconnecting {} blocks using Block Connection Style: {:?}", count, *node.connect_style.borrow());
220 let orig = node.blocks.lock().unwrap().pop().unwrap();
221 assert!(orig.1 > 0); // Cannot disconnect genesis
222 let prev = node.blocks.lock().unwrap().last().unwrap().clone();
224 match *node.connect_style.borrow() {
225 ConnectStyle::FullBlockViaListen => {
226 node.chain_monitor.chain_monitor.block_disconnected(&orig.0.header, orig.1);
227 Listen::block_disconnected(node.node, &orig.0.header, orig.1);
229 ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks => {
231 node.chain_monitor.chain_monitor.best_block_updated(&prev.0.header, prev.1);
232 node.node.best_block_updated(&prev.0.header, prev.1);
235 ConnectStyle::BestBlockFirstReorgsOnlyTip|ConnectStyle::TransactionsFirstReorgsOnlyTip => {
236 for tx in orig.0.txdata {
237 node.chain_monitor.chain_monitor.transaction_unconfirmed(&tx.txid());
238 node.node.transaction_unconfirmed(&tx.txid());
242 node.chain_monitor.chain_monitor.best_block_updated(&prev.0.header, prev.1);
243 node.node.best_block_updated(&prev.0.header, prev.1);
246 call_claimable_balances(node);
250 pub fn disconnect_all_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
251 let count = node.blocks.lock().unwrap().len() as u32 - 1;
252 disconnect_blocks(node, count);
255 pub struct TestChanMonCfg {
256 pub tx_broadcaster: test_utils::TestBroadcaster,
257 pub fee_estimator: test_utils::TestFeeEstimator,
258 pub chain_source: test_utils::TestChainSource,
259 pub persister: test_utils::TestPersister,
260 pub logger: test_utils::TestLogger,
261 pub keys_manager: test_utils::TestKeysInterface,
264 pub struct NodeCfg<'a> {
265 pub chain_source: &'a test_utils::TestChainSource,
266 pub tx_broadcaster: &'a test_utils::TestBroadcaster,
267 pub fee_estimator: &'a test_utils::TestFeeEstimator,
268 pub chain_monitor: test_utils::TestChainMonitor<'a>,
269 pub keys_manager: &'a test_utils::TestKeysInterface,
270 pub logger: &'a test_utils::TestLogger,
271 pub network_graph: NetworkGraph<&'a test_utils::TestLogger>,
272 pub node_seed: [u8; 32],
273 pub features: InitFeatures,
276 pub struct Node<'a, 'b: 'a, 'c: 'b> {
277 pub chain_source: &'c test_utils::TestChainSource,
278 pub tx_broadcaster: &'c test_utils::TestBroadcaster,
279 pub chain_monitor: &'b test_utils::TestChainMonitor<'c>,
280 pub keys_manager: &'b test_utils::TestKeysInterface,
281 pub node: &'a ChannelManager<EnforcingSigner, &'b TestChainMonitor<'c>, &'c test_utils::TestBroadcaster, &'b test_utils::TestKeysInterface, &'c test_utils::TestFeeEstimator, &'c test_utils::TestLogger>,
282 pub network_graph: &'b NetworkGraph<&'c test_utils::TestLogger>,
283 pub gossip_sync: P2PGossipSync<&'b NetworkGraph<&'c test_utils::TestLogger>, &'c test_utils::TestChainSource, &'c test_utils::TestLogger>,
284 pub node_seed: [u8; 32],
285 pub network_payment_count: Rc<RefCell<u8>>,
286 pub network_chan_count: Rc<RefCell<u32>>,
287 pub logger: &'c test_utils::TestLogger,
288 pub blocks: Arc<Mutex<Vec<(Block, u32)>>>,
289 pub connect_style: Rc<RefCell<ConnectStyle>>,
291 impl<'a, 'b, 'c> Node<'a, 'b, 'c> {
292 pub fn best_block_hash(&self) -> BlockHash {
293 self.blocks.lock().unwrap().last().unwrap().0.block_hash()
295 pub fn best_block_info(&self) -> (BlockHash, u32) {
296 self.blocks.lock().unwrap().last().map(|(a, b)| (a.block_hash(), *b)).unwrap()
298 pub fn get_block_header(&self, height: u32) -> BlockHeader {
299 self.blocks.lock().unwrap()[height as usize].0.header
303 impl<'a, 'b, 'c> Drop for Node<'a, 'b, 'c> {
306 // Check that we processed all pending events
307 assert!(self.node.get_and_clear_pending_msg_events().is_empty());
308 assert!(self.node.get_and_clear_pending_events().is_empty());
309 assert!(self.chain_monitor.added_monitors.lock().unwrap().is_empty());
311 // Check that if we serialize the Router, we can deserialize it again.
313 let mut w = test_utils::TestVecWriter(Vec::new());
314 self.network_graph.write(&mut w).unwrap();
315 let network_graph_deser = <NetworkGraph<_>>::read(&mut io::Cursor::new(&w.0), self.logger).unwrap();
316 assert!(network_graph_deser == *self.network_graph);
317 let gossip_sync = P2PGossipSync::new(
318 &network_graph_deser, Some(self.chain_source), self.logger
320 let mut chan_progress = 0;
322 let orig_announcements = self.gossip_sync.get_next_channel_announcement(chan_progress);
323 let deserialized_announcements = gossip_sync.get_next_channel_announcement(chan_progress);
324 assert!(orig_announcements == deserialized_announcements);
325 chan_progress = match orig_announcements {
326 Some(announcement) => announcement.0.contents.short_channel_id + 1,
330 let mut node_progress = None;
332 let orig_announcements = self.gossip_sync.get_next_node_announcement(node_progress.as_ref());
333 let deserialized_announcements = gossip_sync.get_next_node_announcement(node_progress.as_ref());
334 assert!(orig_announcements == deserialized_announcements);
335 node_progress = match orig_announcements {
336 Some(announcement) => Some(announcement.contents.node_id),
342 // Check that if we serialize and then deserialize all our channel monitors we get the
343 // same set of outputs to watch for on chain as we have now. Note that if we write
344 // tests that fully close channels and remove the monitors at some point this may break.
345 let feeest = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
346 let mut deserialized_monitors = Vec::new();
348 for outpoint in self.chain_monitor.chain_monitor.list_monitors() {
349 let mut w = test_utils::TestVecWriter(Vec::new());
350 self.chain_monitor.chain_monitor.get_monitor(outpoint).unwrap().write(&mut w).unwrap();
351 let (_, deserialized_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
352 &mut io::Cursor::new(&w.0), self.keys_manager).unwrap();
353 deserialized_monitors.push(deserialized_monitor);
357 let broadcaster = test_utils::TestBroadcaster {
358 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone()),
359 blocks: Arc::new(Mutex::new(self.tx_broadcaster.blocks.lock().unwrap().clone())),
362 // Before using all the new monitors to check the watch outpoints, use the full set of
363 // them to ensure we can write and reload our ChannelManager.
365 let mut channel_monitors = HashMap::new();
366 for monitor in deserialized_monitors.iter_mut() {
367 channel_monitors.insert(monitor.get_funding_txo().0, monitor);
370 let mut w = test_utils::TestVecWriter(Vec::new());
371 self.node.write(&mut w).unwrap();
372 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut io::Cursor::new(w.0), ChannelManagerReadArgs {
373 default_config: *self.node.get_current_default_configuration(),
374 keys_manager: self.keys_manager,
375 fee_estimator: &test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) },
376 chain_monitor: self.chain_monitor,
377 tx_broadcaster: &broadcaster,
378 logger: &self.logger,
383 let persister = test_utils::TestPersister::new();
384 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
385 let chain_monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &broadcaster, &self.logger, &feeest, &persister, &self.keys_manager);
386 for deserialized_monitor in deserialized_monitors.drain(..) {
387 if let Err(_) = chain_monitor.watch_channel(deserialized_monitor.get_funding_txo().0, deserialized_monitor) {
391 assert_eq!(*chain_source.watched_txn.lock().unwrap(), *self.chain_source.watched_txn.lock().unwrap());
392 assert_eq!(*chain_source.watched_outputs.lock().unwrap(), *self.chain_source.watched_outputs.lock().unwrap());
397 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) {
398 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001, a_flags, b_flags)
401 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) {
402 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);
403 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &channel_ready);
404 (announcement, as_update, bs_update, channel_id, tx)
408 /// Gets an RAA and CS which were sent in response to a commitment update
409 macro_rules! get_revoke_commit_msgs {
410 ($node: expr, $node_id: expr) => {
412 use $crate::util::events::MessageSendEvent;
413 let events = $node.node.get_and_clear_pending_msg_events();
414 assert_eq!(events.len(), 2);
416 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
417 assert_eq!(*node_id, $node_id);
420 _ => panic!("Unexpected event"),
422 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
423 assert_eq!(*node_id, $node_id);
424 assert!(updates.update_add_htlcs.is_empty());
425 assert!(updates.update_fulfill_htlcs.is_empty());
426 assert!(updates.update_fail_htlcs.is_empty());
427 assert!(updates.update_fail_malformed_htlcs.is_empty());
428 assert!(updates.update_fee.is_none());
429 updates.commitment_signed.clone()
431 _ => panic!("Unexpected event"),
437 /// Get an specific event message from the pending events queue.
439 macro_rules! get_event_msg {
440 ($node: expr, $event_type: path, $node_id: expr) => {
442 let events = $node.node.get_and_clear_pending_msg_events();
443 assert_eq!(events.len(), 1);
445 $event_type { ref node_id, ref msg } => {
446 assert_eq!(*node_id, $node_id);
449 _ => panic!("Unexpected event"),
455 /// Get an error message from the pending events queue.
457 macro_rules! get_err_msg {
458 ($node: expr, $node_id: expr) => {
460 let events = $node.node.get_and_clear_pending_msg_events();
461 assert_eq!(events.len(), 1);
463 $crate::util::events::MessageSendEvent::HandleError {
464 action: $crate::ln::msgs::ErrorAction::SendErrorMessage { ref msg }, ref node_id
466 assert_eq!(*node_id, $node_id);
469 _ => panic!("Unexpected event"),
475 /// Get a specific event from the pending events queue.
477 macro_rules! get_event {
478 ($node: expr, $event_type: path) => {
480 let mut events = $node.node.get_and_clear_pending_events();
481 assert_eq!(events.len(), 1);
482 let ev = events.pop().unwrap();
484 $event_type { .. } => {
487 _ => panic!("Unexpected event"),
494 /// Gets an UpdateHTLCs MessageSendEvent
495 macro_rules! get_htlc_update_msgs {
496 ($node: expr, $node_id: expr) => {
498 let events = $node.node.get_and_clear_pending_msg_events();
499 assert_eq!(events.len(), 1);
501 $crate::util::events::MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
502 assert_eq!(*node_id, $node_id);
505 _ => panic!("Unexpected event"),
512 macro_rules! get_channel_ref {
513 ($node: expr, $lock: ident, $channel_id: expr) => {
515 $lock = $node.node.channel_state.lock().unwrap();
516 $lock.by_id.get_mut(&$channel_id).unwrap()
522 macro_rules! get_feerate {
523 ($node: expr, $channel_id: expr) => {
526 let chan = get_channel_ref!($node, lock, $channel_id);
533 macro_rules! get_opt_anchors {
534 ($node: expr, $channel_id: expr) => {
537 let chan = get_channel_ref!($node, lock, $channel_id);
543 /// Returns a channel monitor given a channel id, making some naive assumptions
545 macro_rules! get_monitor {
546 ($node: expr, $channel_id: expr) => {
548 use bitcoin::hashes::Hash;
549 let mut monitor = None;
550 // Assume funding vout is either 0 or 1 blindly
552 if let Ok(mon) = $node.chain_monitor.chain_monitor.get_monitor(
553 $crate::chain::transaction::OutPoint {
554 txid: bitcoin::Txid::from_slice(&$channel_id[..]).unwrap(), index
566 /// Returns any local commitment transactions for the channel.
568 macro_rules! get_local_commitment_txn {
569 ($node: expr, $channel_id: expr) => {
571 $crate::get_monitor!($node, $channel_id).unsafe_get_latest_holder_commitment_txn(&$node.logger)
576 /// Check the error from attempting a payment.
578 macro_rules! unwrap_send_err {
579 ($res: expr, $all_failed: expr, $type: pat, $check: expr) => {
581 &Err(PaymentSendFailure::AllFailedRetrySafe(ref fails)) if $all_failed => {
582 assert_eq!(fails.len(), 1);
588 &Err(PaymentSendFailure::PartialFailure { ref results, .. }) if !$all_failed => {
589 assert_eq!(results.len(), 1);
591 Err($type) => { $check },
600 /// Check whether N channel monitor(s) have been added.
602 macro_rules! check_added_monitors {
603 ($node: expr, $count: expr) => {
605 let mut added_monitors = $node.chain_monitor.added_monitors.lock().unwrap();
606 assert_eq!(added_monitors.len(), $count);
607 added_monitors.clear();
612 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: u64) -> ([u8; 32], Transaction, OutPoint) {
613 let chan_id = *node.network_chan_count.borrow();
615 let events = node.node.get_and_clear_pending_events();
616 assert_eq!(events.len(), 1);
618 Event::FundingGenerationReady { ref temporary_channel_id, ref counterparty_node_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
619 assert_eq!(counterparty_node_id, expected_counterparty_node_id);
620 assert_eq!(*channel_value_satoshis, expected_chan_value);
621 assert_eq!(user_channel_id, expected_user_chan_id);
623 let tx = Transaction { version: chan_id as i32, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: vec![TxOut {
624 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
626 let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
627 (*temporary_channel_id, tx, funding_outpoint)
629 _ => panic!("Unexpected event"),
632 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 {
633 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, &node_b.node.get_our_node_id(), channel_value, 42);
634 assert_eq!(temporary_channel_id, expected_temporary_channel_id);
636 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_ok());
637 check_added_monitors!(node_a, 0);
639 let funding_created_msg = get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id());
640 assert_eq!(funding_created_msg.temporary_channel_id, expected_temporary_channel_id);
641 node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &funding_created_msg);
643 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
644 assert_eq!(added_monitors.len(), 1);
645 assert_eq!(added_monitors[0].0, funding_output);
646 added_monitors.clear();
649 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()));
651 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
652 assert_eq!(added_monitors.len(), 1);
653 assert_eq!(added_monitors[0].0, funding_output);
654 added_monitors.clear();
657 let events_4 = node_a.node.get_and_clear_pending_events();
658 assert_eq!(events_4.len(), 0);
660 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
661 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
662 node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
664 // Ensure that funding_transaction_generated is idempotent.
665 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_err());
666 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
667 check_added_monitors!(node_a, 0);
672 // Receiver must have been initialized with manually_accept_inbound_channels set to true.
673 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]) {
674 let initiator_channels = initiator.node.list_usable_channels().len();
675 let receiver_channels = receiver.node.list_usable_channels().len();
677 initiator.node.create_channel(receiver.node.get_our_node_id(), 100_000, 10_001, 42, initiator_config).unwrap();
678 let open_channel = get_event_msg!(initiator, MessageSendEvent::SendOpenChannel, receiver.node.get_our_node_id());
680 receiver.node.handle_open_channel(&initiator.node.get_our_node_id(), InitFeatures::known(), &open_channel);
681 let events = receiver.node.get_and_clear_pending_events();
682 assert_eq!(events.len(), 1);
684 Event::OpenChannelRequest { temporary_channel_id, .. } => {
685 receiver.node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &initiator.node.get_our_node_id(), 0).unwrap();
687 _ => panic!("Unexpected event"),
690 let accept_channel = get_event_msg!(receiver, MessageSendEvent::SendAcceptChannel, initiator.node.get_our_node_id());
691 assert_eq!(accept_channel.minimum_depth, 0);
692 initiator.node.handle_accept_channel(&receiver.node.get_our_node_id(), InitFeatures::known(), &accept_channel);
694 let (temporary_channel_id, tx, _) = create_funding_transaction(&initiator, &receiver.node.get_our_node_id(), 100_000, 42);
695 initiator.node.funding_transaction_generated(&temporary_channel_id, &receiver.node.get_our_node_id(), tx.clone()).unwrap();
696 let funding_created = get_event_msg!(initiator, MessageSendEvent::SendFundingCreated, receiver.node.get_our_node_id());
698 receiver.node.handle_funding_created(&initiator.node.get_our_node_id(), &funding_created);
699 check_added_monitors!(receiver, 1);
700 let bs_signed_locked = receiver.node.get_and_clear_pending_msg_events();
701 assert_eq!(bs_signed_locked.len(), 2);
702 let as_channel_ready;
703 match &bs_signed_locked[0] {
704 MessageSendEvent::SendFundingSigned { node_id, msg } => {
705 assert_eq!(*node_id, initiator.node.get_our_node_id());
706 initiator.node.handle_funding_signed(&receiver.node.get_our_node_id(), &msg);
707 check_added_monitors!(initiator, 1);
709 assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
710 assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0)[0], tx);
712 as_channel_ready = get_event_msg!(initiator, MessageSendEvent::SendChannelReady, receiver.node.get_our_node_id());
714 _ => panic!("Unexpected event"),
716 match &bs_signed_locked[1] {
717 MessageSendEvent::SendChannelReady { node_id, msg } => {
718 assert_eq!(*node_id, initiator.node.get_our_node_id());
719 initiator.node.handle_channel_ready(&receiver.node.get_our_node_id(), &msg);
721 _ => panic!("Unexpected event"),
724 receiver.node.handle_channel_ready(&initiator.node.get_our_node_id(), &as_channel_ready);
726 let as_channel_update = get_event_msg!(initiator, MessageSendEvent::SendChannelUpdate, receiver.node.get_our_node_id());
727 let bs_channel_update = get_event_msg!(receiver, MessageSendEvent::SendChannelUpdate, initiator.node.get_our_node_id());
729 initiator.node.handle_channel_update(&receiver.node.get_our_node_id(), &bs_channel_update);
730 receiver.node.handle_channel_update(&initiator.node.get_our_node_id(), &as_channel_update);
732 assert_eq!(initiator.node.list_usable_channels().len(), initiator_channels + 1);
733 assert_eq!(receiver.node.list_usable_channels().len(), receiver_channels + 1);
735 (tx, as_channel_ready.channel_id)
738 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 {
739 let create_chan_id = node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
740 let open_channel_msg = get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id());
741 assert_eq!(open_channel_msg.temporary_channel_id, create_chan_id);
742 node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), a_flags, &open_channel_msg);
743 let accept_channel_msg = get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id());
744 assert_eq!(accept_channel_msg.temporary_channel_id, create_chan_id);
745 node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), b_flags, &accept_channel_msg);
747 sign_funding_transaction(node_a, node_b, channel_value, create_chan_id)
750 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) {
751 confirm_transaction_at(node_conf, tx, conf_height);
752 connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
753 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()));
756 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]) {
758 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
759 assert_eq!(events_6.len(), 3);
760 let announcement_sigs_idx = if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[1] {
761 assert_eq!(*node_id, node_recv.node.get_our_node_id());
763 } else if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[2] {
764 assert_eq!(*node_id, node_recv.node.get_our_node_id());
766 } else { panic!("Unexpected event: {:?}", events_6[1]); };
767 ((match events_6[0] {
768 MessageSendEvent::SendChannelReady { ref node_id, ref msg } => {
769 channel_id = msg.channel_id.clone();
770 assert_eq!(*node_id, node_recv.node.get_our_node_id());
773 _ => panic!("Unexpected event"),
774 }, match events_6[announcement_sigs_idx] {
775 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
776 assert_eq!(*node_id, node_recv.node.get_our_node_id());
779 _ => panic!("Unexpected event"),
783 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]) {
784 let conf_height = core::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
785 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
786 confirm_transaction_at(node_a, tx, conf_height);
787 connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
788 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
791 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) {
792 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat, a_flags, b_flags);
793 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
797 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) {
798 node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
799 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
800 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
802 let events_7 = node_b.node.get_and_clear_pending_msg_events();
803 assert_eq!(events_7.len(), 1);
804 let (announcement, bs_update) = match events_7[0] {
805 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
808 _ => panic!("Unexpected event"),
811 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
812 let events_8 = node_a.node.get_and_clear_pending_msg_events();
813 assert_eq!(events_8.len(), 1);
814 let as_update = match events_8[0] {
815 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
816 assert!(*announcement == *msg);
817 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
818 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
821 _ => panic!("Unexpected event"),
824 *node_a.network_chan_count.borrow_mut() += 1;
826 ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
829 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) {
830 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001, a_flags, b_flags)
833 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) {
834 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat, a_flags, b_flags);
835 update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
836 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
839 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) {
840 let mut no_announce_cfg = test_default_channel_config();
841 no_announce_cfg.channel_handshake_config.announced_channel = false;
842 nodes[a].node.create_channel(nodes[b].node.get_our_node_id(), channel_value, push_msat, 42, Some(no_announce_cfg)).unwrap();
843 let open_channel = get_event_msg!(nodes[a], MessageSendEvent::SendOpenChannel, nodes[b].node.get_our_node_id());
844 nodes[b].node.handle_open_channel(&nodes[a].node.get_our_node_id(), a_flags, &open_channel);
845 let accept_channel = get_event_msg!(nodes[b], MessageSendEvent::SendAcceptChannel, nodes[a].node.get_our_node_id());
846 nodes[a].node.handle_accept_channel(&nodes[b].node.get_our_node_id(), b_flags, &accept_channel);
848 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[a], &nodes[b].node.get_our_node_id(), channel_value, 42);
849 nodes[a].node.funding_transaction_generated(&temporary_channel_id, &nodes[b].node.get_our_node_id(), tx.clone()).unwrap();
850 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()));
851 check_added_monitors!(nodes[b], 1);
853 let cs_funding_signed = get_event_msg!(nodes[b], MessageSendEvent::SendFundingSigned, nodes[a].node.get_our_node_id());
854 nodes[a].node.handle_funding_signed(&nodes[b].node.get_our_node_id(), &cs_funding_signed);
855 check_added_monitors!(nodes[a], 1);
857 let conf_height = core::cmp::max(nodes[a].best_block_info().1 + 1, nodes[b].best_block_info().1 + 1);
858 confirm_transaction_at(&nodes[a], &tx, conf_height);
859 connect_blocks(&nodes[a], CHAN_CONFIRM_DEPTH - 1);
860 confirm_transaction_at(&nodes[b], &tx, conf_height);
861 connect_blocks(&nodes[b], CHAN_CONFIRM_DEPTH - 1);
862 let as_channel_ready = get_event_msg!(nodes[a], MessageSendEvent::SendChannelReady, nodes[b].node.get_our_node_id());
863 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()));
864 let as_update = get_event_msg!(nodes[a], MessageSendEvent::SendChannelUpdate, nodes[b].node.get_our_node_id());
865 nodes[b].node.handle_channel_ready(&nodes[a].node.get_our_node_id(), &as_channel_ready);
866 let bs_update = get_event_msg!(nodes[b], MessageSendEvent::SendChannelUpdate, nodes[a].node.get_our_node_id());
868 nodes[a].node.handle_channel_update(&nodes[b].node.get_our_node_id(), &bs_update);
869 nodes[b].node.handle_channel_update(&nodes[a].node.get_our_node_id(), &as_update);
871 let mut found_a = false;
872 for chan in nodes[a].node.list_usable_channels() {
873 if chan.channel_id == as_channel_ready.channel_id {
876 assert!(!chan.is_public);
881 let mut found_b = false;
882 for chan in nodes[b].node.list_usable_channels() {
883 if chan.channel_id == as_channel_ready.channel_id {
886 assert!(!chan.is_public);
891 (as_channel_ready, tx)
894 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) {
895 nodes[a].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
896 let a_events = nodes[a].node.get_and_clear_pending_msg_events();
897 assert!(a_events.len() >= 2);
899 // ann should be re-generated by broadcast_node_announcement - check that we have it.
900 let mut found_ann_1 = false;
901 for event in a_events.iter() {
903 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
904 if msg == ann { found_ann_1 = true; }
906 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
907 _ => panic!("Unexpected event {:?}", event),
910 assert!(found_ann_1);
912 let a_node_announcement = match a_events.last().unwrap() {
913 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
916 _ => panic!("Unexpected event"),
919 nodes[b].node.broadcast_node_announcement([1, 1, 1], [1; 32], Vec::new());
920 let b_events = nodes[b].node.get_and_clear_pending_msg_events();
921 assert!(b_events.len() >= 2);
923 // ann should be re-generated by broadcast_node_announcement - check that we have it.
924 let mut found_ann_2 = false;
925 for event in b_events.iter() {
927 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
928 if msg == ann { found_ann_2 = true; }
930 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
931 _ => panic!("Unexpected event"),
934 assert!(found_ann_2);
936 let b_node_announcement = match b_events.last().unwrap() {
937 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
940 _ => panic!("Unexpected event"),
944 assert!(node.gossip_sync.handle_channel_announcement(ann).unwrap());
945 node.gossip_sync.handle_channel_update(upd_1).unwrap();
946 node.gossip_sync.handle_channel_update(upd_2).unwrap();
947 node.gossip_sync.handle_node_announcement(&a_node_announcement).unwrap();
948 node.gossip_sync.handle_node_announcement(&b_node_announcement).unwrap();
950 // Note that channel_updates are also delivered to ChannelManagers to ensure we have
951 // forwarding info for local channels even if its not accepted in the network graph.
952 node.node.handle_channel_update(&nodes[a].node.get_our_node_id(), &upd_1);
953 node.node.handle_channel_update(&nodes[b].node.get_our_node_id(), &upd_2);
958 macro_rules! check_spends {
959 ($tx: expr, $($spends_txn: expr),*) => {
962 for outp in $spends_txn.output.iter() {
963 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Input tx output didn't meet dust limit");
966 for outp in $tx.output.iter() {
967 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Spending tx output didn't meet dust limit");
969 let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
971 if out_point.txid == $spends_txn.txid() {
972 return $spends_txn.output.get(out_point.vout as usize).cloned()
977 let mut total_value_in = 0;
978 for input in $tx.input.iter() {
979 total_value_in += get_output(&input.previous_output).unwrap().value;
981 let mut total_value_out = 0;
982 for output in $tx.output.iter() {
983 total_value_out += output.value;
985 let min_fee = ($tx.weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
986 // Input amount - output amount = fee, so check that out + min_fee is smaller than input
987 assert!(total_value_out + min_fee <= total_value_in);
988 $tx.verify(get_output).unwrap();
993 macro_rules! get_closing_signed_broadcast {
994 ($node: expr, $dest_pubkey: expr) => {
996 let events = $node.get_and_clear_pending_msg_events();
997 assert!(events.len() == 1 || events.len() == 2);
998 (match events[events.len() - 1] {
999 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1000 assert_eq!(msg.contents.flags & 2, 2);
1003 _ => panic!("Unexpected event"),
1004 }, if events.len() == 2 {
1006 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1007 assert_eq!(*node_id, $dest_pubkey);
1010 _ => panic!("Unexpected event"),
1018 macro_rules! check_warn_msg {
1019 ($node: expr, $recipient_node_id: expr, $chan_id: expr) => {{
1020 let msg_events = $node.node.get_and_clear_pending_msg_events();
1021 assert_eq!(msg_events.len(), 1);
1022 match msg_events[0] {
1023 MessageSendEvent::HandleError { action: ErrorAction::SendWarningMessage { ref msg, log_level: _ }, node_id } => {
1024 assert_eq!(node_id, $recipient_node_id);
1025 assert_eq!(msg.channel_id, $chan_id);
1028 _ => panic!("Unexpected event"),
1033 /// Check that a channel's closing channel update has been broadcasted, and optionally
1034 /// check whether an error message event has occurred.
1036 macro_rules! check_closed_broadcast {
1037 ($node: expr, $with_error_msg: expr) => {{
1038 use $crate::util::events::MessageSendEvent;
1039 use $crate::ln::msgs::ErrorAction;
1041 let msg_events = $node.node.get_and_clear_pending_msg_events();
1042 assert_eq!(msg_events.len(), if $with_error_msg { 2 } else { 1 });
1043 match msg_events[0] {
1044 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1045 assert_eq!(msg.contents.flags & 2, 2);
1047 _ => panic!("Unexpected event"),
1049 if $with_error_msg {
1050 match msg_events[1] {
1051 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
1052 // TODO: Check node_id
1055 _ => panic!("Unexpected event"),
1061 /// Check that a channel's closing channel events has been issued
1063 macro_rules! check_closed_event {
1064 ($node: expr, $events: expr, $reason: expr) => {
1065 check_closed_event!($node, $events, $reason, false);
1067 ($node: expr, $events: expr, $reason: expr, $is_check_discard_funding: expr) => {{
1068 use $crate::util::events::Event;
1070 let events = $node.node.get_and_clear_pending_events();
1071 assert_eq!(events.len(), $events);
1072 let expected_reason = $reason;
1073 let mut issues_discard_funding = false;
1074 for event in events {
1076 Event::ChannelClosed { ref reason, .. } => {
1077 assert_eq!(*reason, expected_reason);
1079 Event::DiscardFunding { .. } => {
1080 issues_discard_funding = true;
1082 _ => panic!("Unexpected event"),
1085 assert_eq!($is_check_discard_funding, issues_discard_funding);
1089 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) {
1090 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) };
1091 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) };
1094 node_a.close_channel(channel_id, &node_b.get_our_node_id()).unwrap();
1095 node_b.handle_shutdown(&node_a.get_our_node_id(), &InitFeatures::known(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id()));
1097 let events_1 = node_b.get_and_clear_pending_msg_events();
1098 assert!(events_1.len() >= 1);
1099 let shutdown_b = match events_1[0] {
1100 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
1101 assert_eq!(node_id, &node_a.get_our_node_id());
1104 _ => panic!("Unexpected event"),
1107 let closing_signed_b = if !close_inbound_first {
1108 assert_eq!(events_1.len(), 1);
1111 Some(match events_1[1] {
1112 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1113 assert_eq!(node_id, &node_a.get_our_node_id());
1116 _ => panic!("Unexpected event"),
1120 node_a.handle_shutdown(&node_b.get_our_node_id(), &InitFeatures::known(), &shutdown_b);
1121 let (as_update, bs_update) = if close_inbound_first {
1122 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
1123 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1125 node_b.handle_closing_signed(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id()));
1126 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1127 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1128 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1130 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1131 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1132 assert!(none_a.is_none());
1133 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1134 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1135 (as_update, bs_update)
1137 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
1139 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
1140 node_a.handle_closing_signed(&node_b.get_our_node_id(), &get_event_msg!(struct_b, MessageSendEvent::SendClosingSigned, node_a.get_our_node_id()));
1142 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1143 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1144 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1146 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
1147 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1148 assert!(none_b.is_none());
1149 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1150 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1151 (as_update, bs_update)
1153 assert_eq!(tx_a, tx_b);
1154 check_spends!(tx_a, funding_tx);
1156 (as_update, bs_update, tx_a)
1159 pub struct SendEvent {
1160 pub node_id: PublicKey,
1161 pub msgs: Vec<msgs::UpdateAddHTLC>,
1162 pub commitment_msg: msgs::CommitmentSigned,
1165 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
1166 assert!(updates.update_fulfill_htlcs.is_empty());
1167 assert!(updates.update_fail_htlcs.is_empty());
1168 assert!(updates.update_fail_malformed_htlcs.is_empty());
1169 assert!(updates.update_fee.is_none());
1170 SendEvent { node_id: node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
1173 pub fn from_event(event: MessageSendEvent) -> SendEvent {
1175 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
1176 _ => panic!("Unexpected event type!"),
1180 pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
1181 let mut events = node.node.get_and_clear_pending_msg_events();
1182 assert_eq!(events.len(), 1);
1183 SendEvent::from_event(events.pop().unwrap())
1188 /// Performs the "commitment signed dance" - the series of message exchanges which occur after a
1189 /// commitment update.
1190 macro_rules! commitment_signed_dance {
1191 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
1193 check_added_monitors!($node_a, 0);
1194 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1195 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1196 check_added_monitors!($node_a, 1);
1197 commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
1200 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
1202 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
1203 check_added_monitors!($node_b, 0);
1204 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
1205 $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack);
1206 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
1207 check_added_monitors!($node_b, 1);
1208 $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed);
1209 let (bs_revoke_and_ack, extra_msg_option) = {
1210 let events = $node_b.node.get_and_clear_pending_msg_events();
1211 assert!(events.len() <= 2);
1213 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1214 assert_eq!(*node_id, $node_a.node.get_our_node_id());
1217 _ => panic!("Unexpected event"),
1218 }, events.get(1).map(|e| e.clone()))
1220 check_added_monitors!($node_b, 1);
1221 if $fail_backwards {
1222 assert!($node_a.node.get_and_clear_pending_events().is_empty());
1223 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1225 (extra_msg_option, bs_revoke_and_ack)
1228 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
1230 check_added_monitors!($node_a, 0);
1231 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1232 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1233 check_added_monitors!($node_a, 1);
1234 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
1235 assert!(extra_msg_option.is_none());
1239 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
1241 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
1242 $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1243 check_added_monitors!($node_a, 1);
1247 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
1249 assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
1252 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
1254 commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
1255 if $fail_backwards {
1256 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 }]);
1257 check_added_monitors!($node_a, 1);
1259 let channel_state = $node_a.node.channel_state.lock().unwrap();
1260 assert_eq!(channel_state.pending_msg_events.len(), 1);
1261 if let MessageSendEvent::UpdateHTLCs { ref node_id, .. } = channel_state.pending_msg_events[0] {
1262 assert_ne!(*node_id, $node_b.node.get_our_node_id());
1263 } else { panic!("Unexpected event"); }
1265 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1271 /// Get a payment preimage and hash.
1273 macro_rules! get_payment_preimage_hash {
1274 ($dest_node: expr) => {
1276 get_payment_preimage_hash!($dest_node, None)
1279 ($dest_node: expr, $min_value_msat: expr) => {
1281 use bitcoin::hashes::Hash as _;
1282 let mut payment_count = $dest_node.network_payment_count.borrow_mut();
1283 let payment_preimage = $crate::ln::PaymentPreimage([*payment_count; 32]);
1284 *payment_count += 1;
1285 let payment_hash = $crate::ln::PaymentHash(
1286 bitcoin::hashes::sha256::Hash::hash(&payment_preimage.0[..]).into_inner());
1287 let payment_secret = $dest_node.node.create_inbound_payment_for_hash(payment_hash, $min_value_msat, 7200).unwrap();
1288 (payment_preimage, payment_hash, payment_secret)
1294 macro_rules! get_route {
1295 ($send_node: expr, $payment_params: expr, $recv_value: expr, $cltv: expr) => {{
1296 use $crate::chain::keysinterface::KeysInterface;
1297 let scorer = $crate::util::test_utils::TestScorer::with_penalty(0);
1298 let keys_manager = $crate::util::test_utils::TestKeysInterface::new(&[0u8; 32], bitcoin::network::constants::Network::Testnet);
1299 let random_seed_bytes = keys_manager.get_secure_random_bytes();
1300 $crate::routing::router::get_route(
1301 &$send_node.node.get_our_node_id(), &$payment_params, &$send_node.network_graph.read_only(),
1302 Some(&$send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1303 $recv_value, $cltv, $send_node.logger, &scorer, &random_seed_bytes
1310 macro_rules! get_route_and_payment_hash {
1311 ($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
1312 let payment_params = $crate::routing::router::PaymentParameters::from_node_id($recv_node.node.get_our_node_id())
1313 .with_features($crate::ln::features::InvoiceFeatures::known());
1314 $crate::get_route_and_payment_hash!($send_node, $recv_node, payment_params, $recv_value, TEST_FINAL_CLTV)
1316 ($send_node: expr, $recv_node: expr, $payment_params: expr, $recv_value: expr, $cltv: expr) => {{
1317 let (payment_preimage, payment_hash, payment_secret) = $crate::get_payment_preimage_hash!($recv_node, Some($recv_value));
1318 let route = $crate::get_route!($send_node, $payment_params, $recv_value, $cltv);
1319 (route.unwrap(), payment_hash, payment_preimage, payment_secret)
1324 macro_rules! expect_pending_htlcs_forwardable_conditions {
1325 ($node: expr, $expected_failures: expr) => {{
1326 let expected_failures = $expected_failures;
1327 let events = $node.node.get_and_clear_pending_events();
1329 $crate::util::events::Event::PendingHTLCsForwardable { .. } => { },
1330 _ => panic!("Unexpected event"),
1333 let count = expected_failures.len() + 1;
1334 assert_eq!(events.len(), count);
1336 if expected_failures.len() > 0 {
1337 expect_htlc_handling_failed_destinations!(events, expected_failures)
1343 macro_rules! expect_htlc_handling_failed_destinations {
1344 ($events: expr, $expected_failures: expr) => {{
1345 for event in $events {
1347 $crate::util::events::Event::PendingHTLCsForwardable { .. } => { },
1348 $crate::util::events::Event::HTLCHandlingFailed { ref failed_next_destination, .. } => {
1349 assert!($expected_failures.contains(&failed_next_destination))
1351 _ => panic!("Unexpected destination"),
1358 /// Clears (and ignores) a PendingHTLCsForwardable event
1359 macro_rules! expect_pending_htlcs_forwardable_ignore {
1361 expect_pending_htlcs_forwardable_conditions!($node, vec![]);
1366 /// Clears (and ignores) PendingHTLCsForwardable and HTLCHandlingFailed events
1367 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore {
1368 ($node: expr, $expected_failures: expr) => {{
1369 expect_pending_htlcs_forwardable_conditions!($node, $expected_failures);
1374 /// Handles a PendingHTLCsForwardable event
1375 macro_rules! expect_pending_htlcs_forwardable {
1377 expect_pending_htlcs_forwardable_ignore!($node);
1378 $node.node.process_pending_htlc_forwards();
1380 // Ensure process_pending_htlc_forwards is idempotent.
1381 $node.node.process_pending_htlc_forwards();
1386 /// Handles a PendingHTLCsForwardable and HTLCHandlingFailed event
1387 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed {
1388 ($node: expr, $expected_failures: expr) => {{
1389 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!($node, $expected_failures);
1390 $node.node.process_pending_htlc_forwards();
1392 // Ensure process_pending_htlc_forwards is idempotent.
1393 $node.node.process_pending_htlc_forwards();
1398 macro_rules! expect_pending_htlcs_forwardable_from_events {
1399 ($node: expr, $events: expr, $ignore: expr) => {{
1400 assert_eq!($events.len(), 1);
1402 Event::PendingHTLCsForwardable { .. } => { },
1403 _ => panic!("Unexpected event"),
1406 $node.node.process_pending_htlc_forwards();
1408 // Ensure process_pending_htlc_forwards is idempotent.
1409 $node.node.process_pending_htlc_forwards();
1415 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1416 macro_rules! expect_payment_received {
1417 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr) => {
1418 expect_payment_received!($node, $expected_payment_hash, $expected_payment_secret, $expected_recv_value, None)
1420 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr, $expected_payment_preimage: expr) => {
1421 let events = $node.node.get_and_clear_pending_events();
1422 assert_eq!(events.len(), 1);
1424 $crate::util::events::Event::PaymentReceived { ref payment_hash, ref purpose, amount_msat } => {
1425 assert_eq!($expected_payment_hash, *payment_hash);
1426 assert_eq!($expected_recv_value, amount_msat);
1428 $crate::util::events::PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1429 assert_eq!(&$expected_payment_preimage, payment_preimage);
1430 assert_eq!($expected_payment_secret, *payment_secret);
1435 _ => panic!("Unexpected event"),
1441 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1442 macro_rules! expect_payment_claimed {
1443 ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
1444 let events = $node.node.get_and_clear_pending_events();
1445 assert_eq!(events.len(), 1);
1447 $crate::util::events::Event::PaymentClaimed { ref payment_hash, amount_msat, .. } => {
1448 assert_eq!($expected_payment_hash, *payment_hash);
1449 assert_eq!($expected_recv_value, amount_msat);
1451 _ => panic!("Unexpected event"),
1458 macro_rules! expect_payment_sent_without_paths {
1459 ($node: expr, $expected_payment_preimage: expr) => {
1460 expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, false);
1462 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1463 expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, false);
1468 macro_rules! expect_payment_sent {
1469 ($node: expr, $expected_payment_preimage: expr) => {
1470 $crate::expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, true);
1472 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1473 $crate::expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, true);
1475 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr, $expect_paths: expr) => { {
1476 use bitcoin::hashes::Hash as _;
1477 let events = $node.node.get_and_clear_pending_events();
1478 let expected_payment_hash = $crate::ln::PaymentHash(
1479 bitcoin::hashes::sha256::Hash::hash(&$expected_payment_preimage.0).into_inner());
1481 assert!(events.len() > 1);
1483 assert_eq!(events.len(), 1);
1485 let expected_payment_id = match events[0] {
1486 $crate::util::events::Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
1487 assert_eq!($expected_payment_preimage, *payment_preimage);
1488 assert_eq!(expected_payment_hash, *payment_hash);
1489 assert!(fee_paid_msat.is_some());
1490 if $expected_fee_msat_opt.is_some() {
1491 assert_eq!(*fee_paid_msat, $expected_fee_msat_opt);
1495 _ => panic!("Unexpected event"),
1498 for i in 1..events.len() {
1500 $crate::util::events::Event::PaymentPathSuccessful { payment_id, payment_hash, .. } => {
1501 assert_eq!(payment_id, expected_payment_id);
1502 assert_eq!(payment_hash, Some(expected_payment_hash));
1504 _ => panic!("Unexpected event"),
1513 macro_rules! expect_payment_path_successful {
1515 let events = $node.node.get_and_clear_pending_events();
1516 assert_eq!(events.len(), 1);
1518 $crate::util::events::Event::PaymentPathSuccessful { .. } => {},
1519 _ => panic!("Unexpected event"),
1524 macro_rules! expect_payment_forwarded {
1525 ($node: expr, $prev_node: expr, $next_node: expr, $expected_fee: expr, $upstream_force_closed: expr, $downstream_force_closed: expr) => {
1526 let events = $node.node.get_and_clear_pending_events();
1527 assert_eq!(events.len(), 1);
1529 Event::PaymentForwarded { fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id } => {
1530 assert_eq!(fee_earned_msat, $expected_fee);
1531 if fee_earned_msat.is_some() {
1532 // Is the event prev_channel_id in one of the channels between the two nodes?
1533 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()));
1535 // We check for force closures since a force closed channel is removed from the
1536 // node's channel list
1537 if !$downstream_force_closed {
1538 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()));
1540 assert_eq!(claim_from_onchain_tx, $upstream_force_closed);
1542 _ => panic!("Unexpected event"),
1547 pub struct PaymentFailedConditions<'a> {
1548 pub(crate) expected_htlc_error_data: Option<(u16, &'a [u8])>,
1549 pub(crate) expected_blamed_scid: Option<u64>,
1550 pub(crate) expected_blamed_chan_closed: Option<bool>,
1551 pub(crate) expected_mpp_parts_remain: bool,
1554 impl<'a> PaymentFailedConditions<'a> {
1555 pub fn new() -> Self {
1557 expected_htlc_error_data: None,
1558 expected_blamed_scid: None,
1559 expected_blamed_chan_closed: None,
1560 expected_mpp_parts_remain: false,
1563 pub fn mpp_parts_remain(mut self) -> Self {
1564 self.expected_mpp_parts_remain = true;
1567 pub fn blamed_scid(mut self, scid: u64) -> Self {
1568 self.expected_blamed_scid = Some(scid);
1571 pub fn blamed_chan_closed(mut self, closed: bool) -> Self {
1572 self.expected_blamed_chan_closed = Some(closed);
1575 pub fn expected_htlc_error_data(mut self, code: u16, data: &'a [u8]) -> Self {
1576 self.expected_htlc_error_data = Some((code, data));
1582 macro_rules! expect_payment_failed_with_update {
1583 ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr, $scid: expr, $chan_closed: expr) => {
1584 $crate::ln::functional_test_utils::expect_payment_failed_conditions(
1585 &$node, $expected_payment_hash, $rejected_by_dest,
1586 $crate::ln::functional_test_utils::PaymentFailedConditions::new()
1587 .blamed_scid($scid).blamed_chan_closed($chan_closed));
1592 macro_rules! expect_payment_failed {
1593 ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
1594 #[allow(unused_mut)]
1595 let mut conditions = $crate::ln::functional_test_utils::PaymentFailedConditions::new();
1597 conditions = conditions.expected_htlc_error_data($expected_error_code, &$expected_error_data);
1599 $crate::ln::functional_test_utils::expect_payment_failed_conditions(&$node, $expected_payment_hash, $rejected_by_dest, conditions);
1603 pub fn expect_payment_failed_conditions_event<'a, 'b, 'c, 'd, 'e>(
1604 node: &'a Node<'b, 'c, 'd>, payment_failed_event: Event, expected_payment_hash: PaymentHash,
1605 expected_rejected_by_dest: bool, conditions: PaymentFailedConditions<'e>
1607 let expected_payment_id = match payment_failed_event {
1608 Event::PaymentPathFailed { payment_hash, rejected_by_dest, path, retry, payment_id, network_update, short_channel_id,
1612 error_data, .. } => {
1613 assert_eq!(payment_hash, expected_payment_hash, "unexpected payment_hash");
1614 assert_eq!(rejected_by_dest, expected_rejected_by_dest, "unexpected rejected_by_dest value");
1615 assert!(retry.is_some(), "expected retry.is_some()");
1616 assert_eq!(retry.as_ref().unwrap().final_value_msat, path.last().unwrap().fee_msat, "Retry amount should match last hop in path");
1617 assert_eq!(retry.as_ref().unwrap().payment_params.payee_pubkey, path.last().unwrap().pubkey, "Retry payee node_id should match last hop in path");
1618 if let Some(scid) = short_channel_id {
1619 assert!(retry.as_ref().unwrap().payment_params.previously_failed_channels.contains(&scid));
1624 assert!(error_code.is_some(), "expected error_code.is_some() = true");
1625 assert!(error_data.is_some(), "expected error_data.is_some() = true");
1626 if let Some((code, data)) = conditions.expected_htlc_error_data {
1627 assert_eq!(error_code.unwrap(), code, "unexpected error code");
1628 assert_eq!(&error_data.as_ref().unwrap()[..], data, "unexpected error data");
1632 if let Some(chan_closed) = conditions.expected_blamed_chan_closed {
1633 match network_update {
1634 Some(NetworkUpdate::ChannelUpdateMessage { ref msg }) if !chan_closed => {
1635 if let Some(scid) = conditions.expected_blamed_scid {
1636 assert_eq!(msg.contents.short_channel_id, scid);
1638 const CHAN_DISABLED_FLAG: u8 = 2;
1639 assert_eq!(msg.contents.flags & CHAN_DISABLED_FLAG, 0);
1641 Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent }) if chan_closed => {
1642 if let Some(scid) = conditions.expected_blamed_scid {
1643 assert_eq!(short_channel_id, scid);
1645 assert!(is_permanent);
1647 Some(_) => panic!("Unexpected update type"),
1648 None => panic!("Expected update"),
1654 _ => panic!("Unexpected event"),
1656 if !conditions.expected_mpp_parts_remain {
1657 node.node.abandon_payment(expected_payment_id);
1658 let events = node.node.get_and_clear_pending_events();
1659 assert_eq!(events.len(), 1);
1661 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
1662 assert_eq!(*payment_hash, expected_payment_hash, "unexpected second payment_hash");
1663 assert_eq!(*payment_id, expected_payment_id);
1665 _ => panic!("Unexpected second event"),
1670 pub fn expect_payment_failed_conditions<'a, 'b, 'c, 'd, 'e>(
1671 node: &'a Node<'b, 'c, 'd>, expected_payment_hash: PaymentHash, expected_rejected_by_dest: bool,
1672 conditions: PaymentFailedConditions<'e>
1674 let mut events = node.node.get_and_clear_pending_events();
1675 assert_eq!(events.len(), 1);
1676 expect_payment_failed_conditions_event(node, events.pop().unwrap(), expected_payment_hash, expected_rejected_by_dest, conditions);
1679 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 {
1680 let payment_id = origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
1681 check_added_monitors!(origin_node, expected_paths.len());
1682 pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
1686 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_received_expected: bool, clear_recipient_events: bool, expected_preimage: Option<PaymentPreimage>) {
1687 let mut payment_event = SendEvent::from_event(ev);
1688 let mut prev_node = origin_node;
1690 for (idx, &node) in expected_path.iter().enumerate() {
1691 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
1693 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
1694 check_added_monitors!(node, 0);
1695 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
1697 expect_pending_htlcs_forwardable!(node);
1699 if idx == expected_path.len() - 1 && clear_recipient_events {
1700 let events_2 = node.node.get_and_clear_pending_events();
1701 if payment_received_expected {
1702 assert_eq!(events_2.len(), 1);
1704 Event::PaymentReceived { ref payment_hash, ref purpose, amount_msat } => {
1705 assert_eq!(our_payment_hash, *payment_hash);
1707 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1708 assert_eq!(expected_preimage, *payment_preimage);
1709 assert_eq!(our_payment_secret.unwrap(), *payment_secret);
1711 PaymentPurpose::SpontaneousPayment(payment_preimage) => {
1712 assert_eq!(expected_preimage.unwrap(), *payment_preimage);
1713 assert!(our_payment_secret.is_none());
1716 assert_eq!(amount_msat, recv_value);
1718 _ => panic!("Unexpected event"),
1721 assert!(events_2.is_empty());
1723 } else if idx != expected_path.len() - 1 {
1724 let mut events_2 = node.node.get_and_clear_pending_msg_events();
1725 assert_eq!(events_2.len(), 1);
1726 check_added_monitors!(node, 1);
1727 payment_event = SendEvent::from_event(events_2.remove(0));
1728 assert_eq!(payment_event.msgs.len(), 1);
1735 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_received_expected: bool, expected_preimage: Option<PaymentPreimage>) {
1736 do_pass_along_path(origin_node, expected_path, recv_value, our_payment_hash, our_payment_secret, ev, payment_received_expected, true, expected_preimage);
1739 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) {
1740 let mut events = origin_node.node.get_and_clear_pending_msg_events();
1741 assert_eq!(events.len(), expected_route.len());
1742 for (path_idx, (ev, expected_path)) in events.drain(..).zip(expected_route.iter()).enumerate() {
1743 // Once we've gotten through all the HTLCs, the last one should result in a
1744 // PaymentReceived (but each previous one should not!), .
1745 let expect_payment = path_idx == expected_route.len() - 1;
1746 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), Some(our_payment_secret), ev, expect_payment, None);
1750 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) {
1751 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
1752 let payment_id = send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, our_payment_secret);
1753 (our_payment_preimage, our_payment_hash, our_payment_secret, payment_id)
1756 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 {
1757 for path in expected_paths.iter() {
1758 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1760 expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
1762 let claim_event = expected_paths[0].last().unwrap().node.get_and_clear_pending_events();
1763 assert_eq!(claim_event.len(), 1);
1764 match claim_event[0] {
1765 Event::PaymentClaimed { purpose: PaymentPurpose::SpontaneousPayment(preimage), .. }|
1766 Event::PaymentClaimed { purpose: PaymentPurpose::InvoicePayment { payment_preimage: Some(preimage), ..}, .. } =>
1767 assert_eq!(preimage, our_payment_preimage),
1768 Event::PaymentClaimed { purpose: PaymentPurpose::InvoicePayment { .. }, payment_hash, .. } =>
1769 assert_eq!(&payment_hash.0, &Sha256::hash(&our_payment_preimage.0)[..]),
1773 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1775 let mut expected_total_fee_msat = 0;
1777 macro_rules! msgs_from_ev {
1780 &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 } } => {
1781 assert!(update_add_htlcs.is_empty());
1782 assert_eq!(update_fulfill_htlcs.len(), 1);
1783 assert!(update_fail_htlcs.is_empty());
1784 assert!(update_fail_malformed_htlcs.is_empty());
1785 assert!(update_fee.is_none());
1786 ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
1788 _ => panic!("Unexpected event"),
1792 let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1793 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1794 assert_eq!(events.len(), expected_paths.len());
1795 for ev in events.iter() {
1796 per_path_msgs.push(msgs_from_ev!(ev));
1799 for (expected_route, (path_msgs, next_hop)) in expected_paths.iter().zip(per_path_msgs.drain(..)) {
1800 let mut next_msgs = Some(path_msgs);
1801 let mut expected_next_node = next_hop;
1803 macro_rules! last_update_fulfill_dance {
1804 ($node: expr, $prev_node: expr) => {
1806 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1807 check_added_monitors!($node, 0);
1808 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1809 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1813 macro_rules! mid_update_fulfill_dance {
1814 ($node: expr, $prev_node: expr, $next_node: expr, $new_msgs: expr) => {
1816 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1818 let channel_state = $node.node.channel_state.lock().unwrap();
1819 let channel = channel_state
1820 .by_id.get(&next_msgs.as_ref().unwrap().0.channel_id).unwrap();
1821 if let Some(prev_config) = channel.prev_config() {
1822 prev_config.forwarding_fee_base_msat
1824 channel.config().forwarding_fee_base_msat
1827 expect_payment_forwarded!($node, $next_node, $prev_node, Some(fee as u64), false, false);
1828 expected_total_fee_msat += fee as u64;
1829 check_added_monitors!($node, 1);
1830 let new_next_msgs = if $new_msgs {
1831 let events = $node.node.get_and_clear_pending_msg_events();
1832 assert_eq!(events.len(), 1);
1833 let (res, nexthop) = msgs_from_ev!(&events[0]);
1834 expected_next_node = nexthop;
1837 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1840 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1841 next_msgs = new_next_msgs;
1846 let mut prev_node = expected_route.last().unwrap();
1847 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
1848 assert_eq!(expected_next_node, node.node.get_our_node_id());
1849 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
1850 if next_msgs.is_some() {
1851 // Since we are traversing in reverse, next_node is actually the previous node
1852 let next_node: &Node;
1853 if idx == expected_route.len() - 1 {
1854 next_node = origin_node;
1856 next_node = expected_route[expected_route.len() - 1 - idx - 1];
1858 mid_update_fulfill_dance!(node, prev_node, next_node, update_next_msgs);
1860 assert!(!update_next_msgs);
1861 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
1863 if !skip_last && idx == expected_route.len() - 1 {
1864 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1871 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
1875 // Ensure that claim_funds is idempotent.
1876 expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
1877 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
1878 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
1880 expected_total_fee_msat
1882 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) {
1883 let expected_total_fee_msat = do_claim_payment_along_route(origin_node, expected_paths, skip_last, our_payment_preimage);
1885 expect_payment_sent!(origin_node, our_payment_preimage, Some(expected_total_fee_msat));
1889 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage) {
1890 claim_payment_along_route(origin_node, &[expected_route], false, our_payment_preimage);
1893 pub const TEST_FINAL_CLTV: u32 = 70;
1895 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) {
1896 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id())
1897 .with_features(InvoiceFeatures::known());
1898 let route = get_route!(origin_node, payment_params, recv_value, TEST_FINAL_CLTV).unwrap();
1899 assert_eq!(route.paths.len(), 1);
1900 assert_eq!(route.paths[0].len(), expected_route.len());
1901 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1902 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1905 let res = send_along_route(origin_node, route, expected_route, recv_value);
1906 (res.0, res.1, res.2)
1909 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
1910 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id())
1911 .with_features(InvoiceFeatures::known());
1912 let network_graph = origin_node.network_graph.read_only();
1913 let scorer = test_utils::TestScorer::with_penalty(0);
1914 let seed = [0u8; 32];
1915 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
1916 let random_seed_bytes = keys_manager.get_secure_random_bytes();
1917 let route = get_route(
1918 &origin_node.node.get_our_node_id(), &payment_params, &network_graph,
1919 None, recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer, &random_seed_bytes).unwrap();
1920 assert_eq!(route.paths.len(), 1);
1921 assert_eq!(route.paths[0].len(), expected_route.len());
1922 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1923 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1926 let (_, our_payment_hash, our_payment_preimage) = get_payment_preimage_hash!(expected_route.last().unwrap());
1927 unwrap_send_err!(origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_preimage)), true, APIError::ChannelUnavailable { ref err },
1928 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
1931 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
1932 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
1933 claim_payment(&origin, expected_route, our_payment_preimage);
1936 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) {
1937 for path in expected_paths.iter() {
1938 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1940 expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
1941 let expected_destinations: Vec<HTLCDestination> = repeat(HTLCDestination::FailedPayment { payment_hash: our_payment_hash }).take(expected_paths.len()).collect();
1942 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(expected_paths[0].last().unwrap(), expected_destinations);
1944 pass_failed_payment_back(origin_node, expected_paths, skip_last, our_payment_hash);
1947 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) {
1948 let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
1949 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1951 let mut per_path_msgs: Vec<((msgs::UpdateFailHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1952 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1953 assert_eq!(events.len(), expected_paths.len());
1954 for ev in events.iter() {
1955 let (update_fail, commitment_signed, node_id) = match ev {
1956 &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 } } => {
1957 assert!(update_add_htlcs.is_empty());
1958 assert!(update_fulfill_htlcs.is_empty());
1959 assert_eq!(update_fail_htlcs.len(), 1);
1960 assert!(update_fail_malformed_htlcs.is_empty());
1961 assert!(update_fee.is_none());
1962 (update_fail_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
1964 _ => panic!("Unexpected event"),
1966 per_path_msgs.push(((update_fail, commitment_signed), node_id));
1968 per_path_msgs.sort_unstable_by(|(_, node_id_a), (_, node_id_b)| node_id_a.cmp(node_id_b));
1969 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()));
1971 for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
1972 let mut next_msgs = Some(path_msgs);
1973 let mut expected_next_node = next_hop;
1974 let mut prev_node = expected_route.last().unwrap();
1976 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
1977 assert_eq!(expected_next_node, node.node.get_our_node_id());
1978 let update_next_node = !skip_last || idx != expected_route.len() - 1;
1979 if next_msgs.is_some() {
1980 node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1981 commitment_signed_dance!(node, prev_node, next_msgs.as_ref().unwrap().1, update_next_node);
1982 if !update_next_node {
1983 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 }]);
1986 let events = node.node.get_and_clear_pending_msg_events();
1987 if update_next_node {
1988 assert_eq!(events.len(), 1);
1990 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 } } => {
1991 assert!(update_add_htlcs.is_empty());
1992 assert!(update_fulfill_htlcs.is_empty());
1993 assert_eq!(update_fail_htlcs.len(), 1);
1994 assert!(update_fail_malformed_htlcs.is_empty());
1995 assert!(update_fee.is_none());
1996 expected_next_node = node_id.clone();
1997 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
1999 _ => panic!("Unexpected event"),
2002 assert!(events.is_empty());
2004 if !skip_last && idx == expected_route.len() - 1 {
2005 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2012 let prev_node = expected_route.first().unwrap();
2013 origin_node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2014 check_added_monitors!(origin_node, 0);
2015 assert!(origin_node.node.get_and_clear_pending_msg_events().is_empty());
2016 commitment_signed_dance!(origin_node, prev_node, next_msgs.as_ref().unwrap().1, false);
2017 let events = origin_node.node.get_and_clear_pending_events();
2018 assert_eq!(events.len(), 1);
2019 let expected_payment_id = match events[0] {
2020 Event::PaymentPathFailed { payment_hash, rejected_by_dest, all_paths_failed, ref path, ref payment_id, .. } => {
2021 assert_eq!(payment_hash, our_payment_hash);
2022 assert!(rejected_by_dest);
2023 assert_eq!(all_paths_failed, i == expected_paths.len() - 1);
2024 for (idx, hop) in expected_route.iter().enumerate() {
2025 assert_eq!(hop.node.get_our_node_id(), path[idx].pubkey);
2029 _ => panic!("Unexpected event"),
2031 if i == expected_paths.len() - 1 {
2032 origin_node.node.abandon_payment(expected_payment_id);
2033 let events = origin_node.node.get_and_clear_pending_events();
2034 assert_eq!(events.len(), 1);
2036 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
2037 assert_eq!(*payment_hash, our_payment_hash, "unexpected second payment_hash");
2038 assert_eq!(*payment_id, expected_payment_id);
2040 _ => panic!("Unexpected second event"),
2046 // Ensure that fail_htlc_backwards is idempotent.
2047 expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2048 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_events().is_empty());
2049 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2050 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2053 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash) {
2054 fail_payment_along_route(origin_node, &[&expected_path[..]], false, our_payment_hash);
2057 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
2058 let mut chan_mon_cfgs = Vec::new();
2059 for i in 0..node_count {
2060 let tx_broadcaster = test_utils::TestBroadcaster {
2061 txn_broadcasted: Mutex::new(Vec::new()),
2062 blocks: Arc::new(Mutex::new(vec![(genesis_block(Network::Testnet), 0)])),
2064 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
2065 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
2066 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
2067 let persister = test_utils::TestPersister::new();
2068 let seed = [i as u8; 32];
2069 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2071 chan_mon_cfgs.push(TestChanMonCfg{ tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager });
2077 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
2078 let mut nodes = Vec::new();
2080 for i in 0..node_count {
2081 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);
2082 let seed = [i as u8; 32];
2083 nodes.push(NodeCfg {
2084 chain_source: &chanmon_cfgs[i].chain_source,
2085 logger: &chanmon_cfgs[i].logger,
2086 tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster,
2087 fee_estimator: &chanmon_cfgs[i].fee_estimator,
2089 keys_manager: &chanmon_cfgs[i].keys_manager,
2091 features: InitFeatures::known(),
2092 network_graph: NetworkGraph::new(chanmon_cfgs[i].chain_source.genesis_hash, &chanmon_cfgs[i].logger),
2099 pub fn test_default_channel_config() -> UserConfig {
2100 let mut default_config = UserConfig::default();
2101 // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
2102 // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
2103 default_config.channel_config.cltv_expiry_delta = MIN_CLTV_EXPIRY_DELTA;
2104 default_config.channel_handshake_config.announced_channel = true;
2105 default_config.channel_handshake_limits.force_announced_channel_preference = false;
2106 // When most of our tests were written, the default HTLC minimum was fixed at 1000.
2107 // It now defaults to 1, so we simply set it to the expected value here.
2108 default_config.channel_handshake_config.our_htlc_minimum_msat = 1000;
2109 // When most of our tests were written, we didn't have the notion of a `max_dust_htlc_exposure_msat`,
2110 // It now defaults to 5_000_000 msat; to avoid interfering with tests we bump it to 50_000_000 msat.
2111 default_config.channel_config.max_dust_htlc_exposure_msat = 50_000_000;
2115 pub fn create_node_chanmgrs<'a, 'b>(node_count: usize, cfgs: &'a Vec<NodeCfg<'b>>, node_config: &[Option<UserConfig>]) -> Vec<ChannelManager<EnforcingSigner, &'a TestChainMonitor<'b>, &'b test_utils::TestBroadcaster, &'a test_utils::TestKeysInterface, &'b test_utils::TestFeeEstimator, &'b test_utils::TestLogger>> {
2116 let mut chanmgrs = Vec::new();
2117 for i in 0..node_count {
2118 let network = Network::Testnet;
2119 let params = ChainParameters {
2121 best_block: BestBlock::from_genesis(network),
2123 let node = ChannelManager::new(cfgs[i].fee_estimator, &cfgs[i].chain_monitor, cfgs[i].tx_broadcaster, cfgs[i].logger, cfgs[i].keys_manager,
2124 if node_config[i].is_some() { node_config[i].clone().unwrap() } else { test_default_channel_config() }, params);
2125 chanmgrs.push(node);
2131 pub fn create_network<'a, 'b: 'a, 'c: 'b>(node_count: usize, cfgs: &'b Vec<NodeCfg<'c>>, chan_mgrs: &'a Vec<ChannelManager<EnforcingSigner, &'b TestChainMonitor<'c>, &'c test_utils::TestBroadcaster, &'b test_utils::TestKeysInterface, &'c test_utils::TestFeeEstimator, &'c test_utils::TestLogger>>) -> Vec<Node<'a, 'b, 'c>> {
2132 let mut nodes = Vec::new();
2133 let chan_count = Rc::new(RefCell::new(0));
2134 let payment_count = Rc::new(RefCell::new(0));
2135 let connect_style = Rc::new(RefCell::new(ConnectStyle::random_style()));
2137 for i in 0..node_count {
2138 let gossip_sync = P2PGossipSync::new(&cfgs[i].network_graph, None, cfgs[i].logger);
2140 chain_source: cfgs[i].chain_source, tx_broadcaster: cfgs[i].tx_broadcaster,
2141 chain_monitor: &cfgs[i].chain_monitor, keys_manager: &cfgs[i].keys_manager,
2142 node: &chan_mgrs[i], network_graph: &cfgs[i].network_graph, gossip_sync,
2143 node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
2144 network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
2145 blocks: Arc::clone(&cfgs[i].tx_broadcaster.blocks),
2146 connect_style: Rc::clone(&connect_style),
2150 for i in 0..node_count {
2151 for j in (i+1)..node_count {
2152 nodes[i].node.peer_connected(&nodes[j].node.get_our_node_id(), &msgs::Init { features: cfgs[j].features.clone(), remote_network_address: None });
2153 nodes[j].node.peer_connected(&nodes[i].node.get_our_node_id(), &msgs::Init { features: cfgs[i].features.clone(), remote_network_address: None });
2160 // Note that the following only works for CLTV values up to 128
2161 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
2162 pub const OFFERED_HTLC_SCRIPT_WEIGHT: usize = 133;
2164 #[derive(PartialEq)]
2165 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
2166 /// Tests that the given node has broadcast transactions for the given Channel
2168 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
2169 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
2170 /// broadcast and the revoked outputs were claimed.
2172 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
2173 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
2175 /// All broadcast transactions must be accounted for in one of the above three types of we'll
2177 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> {
2178 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2179 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
2181 let mut res = Vec::with_capacity(2);
2182 node_txn.retain(|tx| {
2183 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
2184 check_spends!(tx, chan.3);
2185 if commitment_tx.is_none() {
2186 res.push(tx.clone());
2191 if let Some(explicit_tx) = commitment_tx {
2192 res.push(explicit_tx.clone());
2195 assert_eq!(res.len(), 1);
2197 if has_htlc_tx != HTLCType::NONE {
2198 node_txn.retain(|tx| {
2199 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
2200 check_spends!(tx, res[0]);
2201 if has_htlc_tx == HTLCType::TIMEOUT {
2202 assert!(tx.lock_time.0 != 0);
2204 assert!(tx.lock_time.0 == 0);
2206 res.push(tx.clone());
2210 assert!(res.len() == 2 || res.len() == 3);
2212 assert_eq!(res[1], res[2]);
2216 assert!(node_txn.is_empty());
2220 /// Tests that the given node has broadcast a claim transaction against the provided revoked
2221 /// HTLC transaction.
2222 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
2223 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2224 // We may issue multiple claiming transaction on revoked outputs due to block rescan
2225 // for revoked htlc outputs
2226 if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
2227 node_txn.retain(|tx| {
2228 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
2229 check_spends!(tx, revoked_tx);
2233 node_txn.retain(|tx| {
2234 check_spends!(tx, commitment_revoked_tx);
2237 assert!(node_txn.is_empty());
2240 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
2241 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2243 assert!(node_txn.len() >= 1);
2244 assert_eq!(node_txn[0].input.len(), 1);
2245 let mut found_prev = false;
2247 for tx in prev_txn {
2248 if node_txn[0].input[0].previous_output.txid == tx.txid() {
2249 check_spends!(node_txn[0], tx);
2250 let mut iter = node_txn[0].input[0].witness.iter();
2251 iter.next().expect("expected 3 witness items");
2252 iter.next().expect("expected 3 witness items");
2253 assert!(iter.next().expect("expected 3 witness items").len() > 106); // must spend an htlc output
2254 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
2260 assert!(found_prev);
2262 let mut res = Vec::new();
2263 mem::swap(&mut *node_txn, &mut res);
2267 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) {
2268 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
2269 assert_eq!(events_1.len(), 2);
2270 let as_update = match events_1[0] {
2271 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2274 _ => panic!("Unexpected event"),
2277 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2278 assert_eq!(node_id, nodes[b].node.get_our_node_id());
2279 assert_eq!(msg.data, expected_error);
2280 if needs_err_handle {
2281 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
2284 _ => panic!("Unexpected event"),
2287 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
2288 assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
2289 let bs_update = match events_2[0] {
2290 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2293 _ => panic!("Unexpected event"),
2295 if !needs_err_handle {
2297 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2298 assert_eq!(node_id, nodes[a].node.get_our_node_id());
2299 assert_eq!(msg.data, expected_error);
2301 _ => panic!("Unexpected event"),
2306 node.gossip_sync.handle_channel_update(&as_update).unwrap();
2307 node.gossip_sync.handle_channel_update(&bs_update).unwrap();
2311 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize) {
2312 handle_announce_close_broadcast_events(nodes, a, b, false, "Channel closed because commitment or closing transaction was confirmed on chain.");
2316 macro_rules! get_channel_value_stat {
2317 ($node: expr, $channel_id: expr) => {{
2318 let chan_lock = $node.node.channel_state.lock().unwrap();
2319 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
2320 chan.get_value_stat()
2324 macro_rules! get_chan_reestablish_msgs {
2325 ($src_node: expr, $dst_node: expr) => {
2327 let mut res = Vec::with_capacity(1);
2328 for msg in $src_node.node.get_and_clear_pending_msg_events() {
2329 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
2330 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2331 res.push(msg.clone());
2333 panic!("Unexpected event")
2341 macro_rules! handle_chan_reestablish_msgs {
2342 ($src_node: expr, $dst_node: expr) => {
2344 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
2346 let channel_ready = if let Some(&MessageSendEvent::SendChannelReady { ref node_id, ref msg }) = msg_events.get(0) {
2348 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2354 if let Some(&MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ }) = msg_events.get(idx) {
2356 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2359 let mut revoke_and_ack = None;
2360 let mut commitment_update = None;
2361 let order = if let Some(ev) = msg_events.get(idx) {
2363 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2364 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2365 revoke_and_ack = Some(msg.clone());
2367 RAACommitmentOrder::RevokeAndACKFirst
2369 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2370 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2371 commitment_update = Some(updates.clone());
2373 RAACommitmentOrder::CommitmentFirst
2375 _ => RAACommitmentOrder::CommitmentFirst,
2378 RAACommitmentOrder::CommitmentFirst
2381 if let Some(ev) = msg_events.get(idx) {
2383 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2384 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2385 assert!(revoke_and_ack.is_none());
2386 revoke_and_ack = Some(msg.clone());
2389 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2390 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2391 assert!(commitment_update.is_none());
2392 commitment_update = Some(updates.clone());
2399 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, ref msg }) = msg_events.get(idx) {
2400 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2402 assert_eq!(msg.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
2405 assert_eq!(msg_events.len(), idx);
2407 (channel_ready, revoke_and_ack, commitment_update, order)
2412 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
2413 /// for claims/fails they are separated out.
2414 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)) {
2415 node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty(), remote_network_address: None });
2416 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
2417 node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty(), remote_network_address: None });
2418 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
2420 if send_channel_ready.0 {
2421 // If a expects a channel_ready, it better not think it has received a revoke_and_ack
2423 for reestablish in reestablish_1.iter() {
2424 assert_eq!(reestablish.next_remote_commitment_number, 0);
2427 if send_channel_ready.1 {
2428 // If b expects a channel_ready, it better not think it has received a revoke_and_ack
2430 for reestablish in reestablish_2.iter() {
2431 assert_eq!(reestablish.next_remote_commitment_number, 0);
2434 if send_channel_ready.0 || send_channel_ready.1 {
2435 // If we expect any channel_ready's, both sides better have set
2436 // next_holder_commitment_number to 1
2437 for reestablish in reestablish_1.iter() {
2438 assert_eq!(reestablish.next_local_commitment_number, 1);
2440 for reestablish in reestablish_2.iter() {
2441 assert_eq!(reestablish.next_local_commitment_number, 1);
2445 let mut resp_1 = Vec::new();
2446 for msg in reestablish_1 {
2447 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
2448 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
2450 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
2451 check_added_monitors!(node_b, 1);
2453 check_added_monitors!(node_b, 0);
2456 let mut resp_2 = Vec::new();
2457 for msg in reestablish_2 {
2458 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
2459 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
2461 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
2462 check_added_monitors!(node_a, 1);
2464 check_added_monitors!(node_a, 0);
2467 // We don't yet support both needing updates, as that would require a different commitment dance:
2468 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_htlc_fails.0 == 0 &&
2469 pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
2470 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_htlc_fails.1 == 0 &&
2471 pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
2473 for chan_msgs in resp_1.drain(..) {
2474 if send_channel_ready.0 {
2475 node_a.node.handle_channel_ready(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
2476 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
2477 if !announcement_event.is_empty() {
2478 assert_eq!(announcement_event.len(), 1);
2479 if let MessageSendEvent::SendChannelUpdate { .. } = announcement_event[0] {
2480 //TODO: Test announcement_sigs re-sending
2481 } else { panic!("Unexpected event! {:?}", announcement_event[0]); }
2484 assert!(chan_msgs.0.is_none());
2487 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2488 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
2489 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2490 check_added_monitors!(node_a, 1);
2492 assert!(chan_msgs.1.is_none());
2494 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 {
2495 let commitment_update = chan_msgs.2.unwrap();
2496 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2497 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
2499 assert!(commitment_update.update_add_htlcs.is_empty());
2501 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
2502 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.0 + pending_cell_htlc_fails.0);
2503 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2504 for update_add in commitment_update.update_add_htlcs {
2505 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
2507 for update_fulfill in commitment_update.update_fulfill_htlcs {
2508 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
2510 for update_fail in commitment_update.update_fail_htlcs {
2511 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
2514 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2515 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
2517 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
2518 check_added_monitors!(node_a, 1);
2519 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
2520 // No commitment_signed so get_event_msg's assert(len == 1) passes
2521 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
2522 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2523 check_added_monitors!(node_b, 1);
2526 assert!(chan_msgs.2.is_none());
2530 for chan_msgs in resp_2.drain(..) {
2531 if send_channel_ready.1 {
2532 node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
2533 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
2534 if !announcement_event.is_empty() {
2535 assert_eq!(announcement_event.len(), 1);
2536 match announcement_event[0] {
2537 MessageSendEvent::SendChannelUpdate { .. } => {},
2538 MessageSendEvent::SendAnnouncementSignatures { .. } => {},
2539 _ => panic!("Unexpected event {:?}!", announcement_event[0]),
2543 assert!(chan_msgs.0.is_none());
2546 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2547 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
2548 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2549 check_added_monitors!(node_b, 1);
2551 assert!(chan_msgs.1.is_none());
2553 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 {
2554 let commitment_update = chan_msgs.2.unwrap();
2555 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2556 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
2558 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.1 + pending_cell_htlc_claims.1);
2559 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.1 + pending_cell_htlc_fails.1);
2560 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2561 for update_add in commitment_update.update_add_htlcs {
2562 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
2564 for update_fulfill in commitment_update.update_fulfill_htlcs {
2565 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
2567 for update_fail in commitment_update.update_fail_htlcs {
2568 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
2571 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2572 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
2574 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
2575 check_added_monitors!(node_b, 1);
2576 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
2577 // No commitment_signed so get_event_msg's assert(len == 1) passes
2578 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
2579 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2580 check_added_monitors!(node_a, 1);
2583 assert!(chan_msgs.2.is_none());