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};
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};
18 use routing::network_graph::{NetGraphMsgHandler, NetworkGraph};
19 use routing::router::{Payee, Route, get_route};
20 use ln::features::{InitFeatures, InvoiceFeatures};
22 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler};
23 use util::enforcing_trait_impls::EnforcingSigner;
25 use util::test_utils::TestChainMonitor;
26 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider, PaymentPurpose};
27 use util::errors::APIError;
28 use util::config::UserConfig;
29 use util::ser::{ReadableArgs, Writeable, Readable};
31 use bitcoin::blockdata::block::{Block, BlockHeader};
32 use bitcoin::blockdata::constants::genesis_block;
33 use bitcoin::blockdata::transaction::{Transaction, TxOut};
34 use bitcoin::network::constants::Network;
36 use bitcoin::hash_types::BlockHash;
38 use bitcoin::secp256k1::key::PublicKey;
42 use core::cell::RefCell;
44 use sync::{Arc, Mutex};
47 pub const CHAN_CONFIRM_DEPTH: u32 = 10;
49 /// Mine the given transaction in the next block and then mine CHAN_CONFIRM_DEPTH - 1 blocks on
50 /// top, giving the given transaction CHAN_CONFIRM_DEPTH confirmations.
51 pub fn confirm_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) {
52 confirm_transaction_at(node, tx, node.best_block_info().1 + 1);
53 connect_blocks(node, CHAN_CONFIRM_DEPTH - 1);
55 /// Mine a signle block containing the given transaction
56 pub fn mine_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) {
57 let height = node.best_block_info().1 + 1;
58 confirm_transaction_at(node, tx, height);
60 /// Mine the given transaction at the given height, mining blocks as required to build to that
62 pub fn confirm_transaction_at<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction, conf_height: u32) {
63 let first_connect_height = node.best_block_info().1 + 1;
64 assert!(first_connect_height <= conf_height);
65 if conf_height > first_connect_height {
66 connect_blocks(node, conf_height - first_connect_height);
68 let mut block = Block {
69 header: BlockHeader { version: 0x20000000, prev_blockhash: node.best_block_hash(), merkle_root: Default::default(), time: conf_height, bits: 42, nonce: 42 },
72 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
73 block.txdata.push(Transaction { version: 0, lock_time: 0, input: Vec::new(), output: Vec::new() });
75 block.txdata.push(tx.clone());
76 connect_block(node, &block);
79 /// The possible ways we may notify a ChannelManager of a new block
80 #[derive(Clone, Copy, PartialEq)]
81 pub enum ConnectStyle {
82 /// Calls best_block_updated first, detecting transactions in the block only after receiving the
83 /// header and height information.
85 /// The same as BestBlockFirst, however when we have multiple blocks to connect, we only
86 /// make a single best_block_updated call.
87 BestBlockFirstSkippingBlocks,
88 /// Calls transactions_confirmed first, detecting transactions in the block before updating the
89 /// header and height information.
91 /// The same as TransactionsFirst, however when we have multiple blocks to connect, we only
92 /// make a single best_block_updated call.
93 TransactionsFirstSkippingBlocks,
94 /// Provides the full block via the chain::Listen interface. In the current code this is
95 /// equivalent to TransactionsFirst with some additional assertions.
99 pub fn connect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, depth: u32) -> BlockHash {
100 let skip_intermediaries = match *node.connect_style.borrow() {
101 ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks => true,
105 let height = node.best_block_info().1 + 1;
106 let mut block = Block {
107 header: BlockHeader { version: 0x2000000, prev_blockhash: node.best_block_hash(), merkle_root: Default::default(), time: height, bits: 42, nonce: 42 },
112 do_connect_block(node, &block, skip_intermediaries);
114 header: BlockHeader { version: 0x20000000, prev_blockhash: block.header.block_hash(), merkle_root: Default::default(), time: height + i, bits: 42, nonce: 42 },
118 connect_block(node, &block);
119 block.header.block_hash()
122 pub fn connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: &Block) {
123 do_connect_block(node, block, false);
126 fn do_connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: &Block, skip_intermediaries: bool) {
127 let height = node.best_block_info().1 + 1;
128 if !skip_intermediaries {
129 let txdata: Vec<_> = block.txdata.iter().enumerate().collect();
130 match *node.connect_style.borrow() {
131 ConnectStyle::BestBlockFirst|ConnectStyle::BestBlockFirstSkippingBlocks => {
132 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
133 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
134 node.node.best_block_updated(&block.header, height);
135 node.node.transactions_confirmed(&block.header, &txdata, height);
137 ConnectStyle::TransactionsFirst|ConnectStyle::TransactionsFirstSkippingBlocks => {
138 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
139 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
140 node.node.transactions_confirmed(&block.header, &txdata, height);
141 node.node.best_block_updated(&block.header, height);
143 ConnectStyle::FullBlockViaListen => {
144 node.chain_monitor.chain_monitor.block_connected(&block, height);
145 node.node.block_connected(&block, height);
149 node.node.test_process_background_events();
150 node.blocks.lock().unwrap().push((block.header, height));
153 pub fn disconnect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, count: u32) {
155 let orig_header = node.blocks.lock().unwrap().pop().unwrap();
156 assert!(orig_header.1 > 0); // Cannot disconnect genesis
157 let prev_header = node.blocks.lock().unwrap().last().unwrap().clone();
159 match *node.connect_style.borrow() {
160 ConnectStyle::FullBlockViaListen => {
161 node.chain_monitor.chain_monitor.block_disconnected(&orig_header.0, orig_header.1);
162 Listen::block_disconnected(node.node, &orig_header.0, orig_header.1);
164 ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks => {
166 node.chain_monitor.chain_monitor.best_block_updated(&prev_header.0, prev_header.1);
167 node.node.best_block_updated(&prev_header.0, prev_header.1);
171 node.chain_monitor.chain_monitor.best_block_updated(&prev_header.0, prev_header.1);
172 node.node.best_block_updated(&prev_header.0, prev_header.1);
178 pub fn disconnect_all_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
179 let count = node.blocks.lock().unwrap().len() as u32 - 1;
180 disconnect_blocks(node, count);
183 pub struct TestChanMonCfg {
184 pub tx_broadcaster: test_utils::TestBroadcaster,
185 pub fee_estimator: test_utils::TestFeeEstimator,
186 pub chain_source: test_utils::TestChainSource,
187 pub persister: test_utils::TestPersister,
188 pub logger: test_utils::TestLogger,
189 pub keys_manager: test_utils::TestKeysInterface,
190 pub network_graph: NetworkGraph,
193 pub struct NodeCfg<'a> {
194 pub chain_source: &'a test_utils::TestChainSource,
195 pub tx_broadcaster: &'a test_utils::TestBroadcaster,
196 pub fee_estimator: &'a test_utils::TestFeeEstimator,
197 pub chain_monitor: test_utils::TestChainMonitor<'a>,
198 pub keys_manager: &'a test_utils::TestKeysInterface,
199 pub logger: &'a test_utils::TestLogger,
200 pub network_graph: &'a NetworkGraph,
201 pub node_seed: [u8; 32],
202 pub features: InitFeatures,
205 pub struct Node<'a, 'b: 'a, 'c: 'b> {
206 pub chain_source: &'c test_utils::TestChainSource,
207 pub tx_broadcaster: &'c test_utils::TestBroadcaster,
208 pub chain_monitor: &'b test_utils::TestChainMonitor<'c>,
209 pub keys_manager: &'b test_utils::TestKeysInterface,
210 pub node: &'a ChannelManager<EnforcingSigner, &'b TestChainMonitor<'c>, &'c test_utils::TestBroadcaster, &'b test_utils::TestKeysInterface, &'c test_utils::TestFeeEstimator, &'c test_utils::TestLogger>,
211 pub network_graph: &'c NetworkGraph,
212 pub net_graph_msg_handler: NetGraphMsgHandler<&'c NetworkGraph, &'c test_utils::TestChainSource, &'c test_utils::TestLogger>,
213 pub node_seed: [u8; 32],
214 pub network_payment_count: Rc<RefCell<u8>>,
215 pub network_chan_count: Rc<RefCell<u32>>,
216 pub logger: &'c test_utils::TestLogger,
217 pub blocks: Arc<Mutex<Vec<(BlockHeader, u32)>>>,
218 pub connect_style: Rc<RefCell<ConnectStyle>>,
220 impl<'a, 'b, 'c> Node<'a, 'b, 'c> {
221 pub fn best_block_hash(&self) -> BlockHash {
222 self.blocks.lock().unwrap().last().unwrap().0.block_hash()
224 pub fn best_block_info(&self) -> (BlockHash, u32) {
225 self.blocks.lock().unwrap().last().map(|(a, b)| (a.block_hash(), *b)).unwrap()
227 pub fn get_block_header(&self, height: u32) -> BlockHeader {
228 self.blocks.lock().unwrap()[height as usize].0
232 impl<'a, 'b, 'c> Drop for Node<'a, 'b, 'c> {
234 if !::std::thread::panicking() {
235 // Check that we processed all pending events
236 assert!(self.node.get_and_clear_pending_msg_events().is_empty());
237 assert!(self.node.get_and_clear_pending_events().is_empty());
238 assert!(self.chain_monitor.added_monitors.lock().unwrap().is_empty());
240 // Check that if we serialize the Router, we can deserialize it again.
242 let mut w = test_utils::TestVecWriter(Vec::new());
243 self.network_graph.write(&mut w).unwrap();
244 let network_graph_deser = <NetworkGraph>::read(&mut io::Cursor::new(&w.0)).unwrap();
245 assert!(network_graph_deser == *self.network_graph);
246 let net_graph_msg_handler = NetGraphMsgHandler::new(
247 &network_graph_deser, Some(self.chain_source), self.logger
249 let mut chan_progress = 0;
251 let orig_announcements = self.net_graph_msg_handler.get_next_channel_announcements(chan_progress, 255);
252 let deserialized_announcements = net_graph_msg_handler.get_next_channel_announcements(chan_progress, 255);
253 assert!(orig_announcements == deserialized_announcements);
254 chan_progress = match orig_announcements.last() {
255 Some(announcement) => announcement.0.contents.short_channel_id + 1,
259 let mut node_progress = None;
261 let orig_announcements = self.net_graph_msg_handler.get_next_node_announcements(node_progress.as_ref(), 255);
262 let deserialized_announcements = net_graph_msg_handler.get_next_node_announcements(node_progress.as_ref(), 255);
263 assert!(orig_announcements == deserialized_announcements);
264 node_progress = match orig_announcements.last() {
265 Some(announcement) => Some(announcement.contents.node_id),
271 // Check that if we serialize and then deserialize all our channel monitors we get the
272 // same set of outputs to watch for on chain as we have now. Note that if we write
273 // tests that fully close channels and remove the monitors at some point this may break.
274 let feeest = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
275 let mut deserialized_monitors = Vec::new();
277 for outpoint in self.chain_monitor.chain_monitor.list_monitors() {
278 let mut w = test_utils::TestVecWriter(Vec::new());
279 self.chain_monitor.chain_monitor.get_monitor(outpoint).unwrap().write(&mut w).unwrap();
280 let (_, deserialized_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
281 &mut io::Cursor::new(&w.0), self.keys_manager).unwrap();
282 deserialized_monitors.push(deserialized_monitor);
286 // Before using all the new monitors to check the watch outpoints, use the full set of
287 // them to ensure we can write and reload our ChannelManager.
289 let mut channel_monitors = HashMap::new();
290 for monitor in deserialized_monitors.iter_mut() {
291 channel_monitors.insert(monitor.get_funding_txo().0, monitor);
294 let mut w = test_utils::TestVecWriter(Vec::new());
295 self.node.write(&mut w).unwrap();
296 <(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 {
297 default_config: *self.node.get_current_default_configuration(),
298 keys_manager: self.keys_manager,
299 fee_estimator: &test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) },
300 chain_monitor: self.chain_monitor,
301 tx_broadcaster: &test_utils::TestBroadcaster {
302 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone()),
303 blocks: Arc::new(Mutex::new(self.tx_broadcaster.blocks.lock().unwrap().clone())),
305 logger: &self.logger,
310 let persister = test_utils::TestPersister::new();
311 let broadcaster = test_utils::TestBroadcaster {
312 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone()),
313 blocks: Arc::new(Mutex::new(self.tx_broadcaster.blocks.lock().unwrap().clone())),
315 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
316 let chain_monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &broadcaster, &self.logger, &feeest, &persister, &self.keys_manager);
317 for deserialized_monitor in deserialized_monitors.drain(..) {
318 if let Err(_) = chain_monitor.watch_channel(deserialized_monitor.get_funding_txo().0, deserialized_monitor) {
322 assert_eq!(*chain_source.watched_txn.lock().unwrap(), *self.chain_source.watched_txn.lock().unwrap());
323 assert_eq!(*chain_source.watched_outputs.lock().unwrap(), *self.chain_source.watched_outputs.lock().unwrap());
328 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) {
329 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001, a_flags, b_flags)
332 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) {
333 let (funding_locked, channel_id, tx) = create_chan_between_nodes_with_value_a(node_a, node_b, channel_value, push_msat, a_flags, b_flags);
334 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &funding_locked);
335 (announcement, as_update, bs_update, channel_id, tx)
339 /// Gets an RAA and CS which were sent in response to a commitment update
340 macro_rules! get_revoke_commit_msgs {
341 ($node: expr, $node_id: expr) => {
343 use $crate::util::events::MessageSendEvent;
344 let events = $node.node.get_and_clear_pending_msg_events();
345 assert_eq!(events.len(), 2);
347 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
348 assert_eq!(*node_id, $node_id);
351 _ => panic!("Unexpected event"),
353 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
354 assert_eq!(*node_id, $node_id);
355 assert!(updates.update_add_htlcs.is_empty());
356 assert!(updates.update_fulfill_htlcs.is_empty());
357 assert!(updates.update_fail_htlcs.is_empty());
358 assert!(updates.update_fail_malformed_htlcs.is_empty());
359 assert!(updates.update_fee.is_none());
360 updates.commitment_signed.clone()
362 _ => panic!("Unexpected event"),
368 /// Get an specific event message from the pending events queue.
370 macro_rules! get_event_msg {
371 ($node: expr, $event_type: path, $node_id: expr) => {
373 let events = $node.node.get_and_clear_pending_msg_events();
374 assert_eq!(events.len(), 1);
376 $event_type { ref node_id, ref msg } => {
377 assert_eq!(*node_id, $node_id);
380 _ => panic!("Unexpected event"),
386 /// Get a specific event from the pending events queue.
388 macro_rules! get_event {
389 ($node: expr, $event_type: path) => {
391 let mut events = $node.node.get_and_clear_pending_events();
392 assert_eq!(events.len(), 1);
393 let ev = events.pop().unwrap();
395 $event_type { .. } => {
398 _ => panic!("Unexpected event"),
405 /// Gets an UpdateHTLCs MessageSendEvent
406 macro_rules! get_htlc_update_msgs {
407 ($node: expr, $node_id: expr) => {
409 let events = $node.node.get_and_clear_pending_msg_events();
410 assert_eq!(events.len(), 1);
412 $crate::util::events::MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
413 assert_eq!(*node_id, $node_id);
416 _ => panic!("Unexpected event"),
423 macro_rules! get_channel_ref {
424 ($node: expr, $lock: ident, $channel_id: expr) => {
426 $lock = $node.node.channel_state.lock().unwrap();
427 $lock.by_id.get_mut(&$channel_id).unwrap()
433 macro_rules! get_feerate {
434 ($node: expr, $channel_id: expr) => {
437 let chan = get_channel_ref!($node, lock, $channel_id);
443 /// Returns a channel monitor given a channel id, making some naive assumptions
445 macro_rules! get_monitor {
446 ($node: expr, $channel_id: expr) => {
448 use bitcoin::hashes::Hash;
449 let mut monitor = None;
450 // Assume funding vout is either 0 or 1 blindly
452 if let Ok(mon) = $node.chain_monitor.chain_monitor.get_monitor(
453 $crate::chain::transaction::OutPoint {
454 txid: bitcoin::Txid::from_slice(&$channel_id[..]).unwrap(), index
466 /// Returns any local commitment transactions for the channel.
468 macro_rules! get_local_commitment_txn {
469 ($node: expr, $channel_id: expr) => {
471 $crate::get_monitor!($node, $channel_id).unsafe_get_latest_holder_commitment_txn(&$node.logger)
476 /// Check the error from attempting a payment.
478 macro_rules! unwrap_send_err {
479 ($res: expr, $all_failed: expr, $type: pat, $check: expr) => {
481 &Err(PaymentSendFailure::AllFailedRetrySafe(ref fails)) if $all_failed => {
482 assert_eq!(fails.len(), 1);
488 &Err(PaymentSendFailure::PartialFailure { ref results, .. }) if !$all_failed => {
489 assert_eq!(results.len(), 1);
491 Err($type) => { $check },
500 /// Check whether N channel monitor(s) have been added.
502 macro_rules! check_added_monitors {
503 ($node: expr, $count: expr) => {
505 let mut added_monitors = $node.chain_monitor.added_monitors.lock().unwrap();
506 assert_eq!(added_monitors.len(), $count);
507 added_monitors.clear();
512 pub fn create_funding_transaction<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, expected_chan_value: u64, expected_user_chan_id: u64) -> ([u8; 32], Transaction, OutPoint) {
513 let chan_id = *node.network_chan_count.borrow();
515 let events = node.node.get_and_clear_pending_events();
516 assert_eq!(events.len(), 1);
518 Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
519 assert_eq!(*channel_value_satoshis, expected_chan_value);
520 assert_eq!(user_channel_id, expected_user_chan_id);
522 let tx = Transaction { version: chan_id as i32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
523 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
525 let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
526 (*temporary_channel_id, tx, funding_outpoint)
528 _ => panic!("Unexpected event"),
531 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 {
532 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, channel_value, 42);
533 assert_eq!(temporary_channel_id, expected_temporary_channel_id);
535 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).is_ok());
536 check_added_monitors!(node_a, 0);
538 let funding_created_msg = get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id());
539 assert_eq!(funding_created_msg.temporary_channel_id, expected_temporary_channel_id);
540 node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &funding_created_msg);
542 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
543 assert_eq!(added_monitors.len(), 1);
544 assert_eq!(added_monitors[0].0, funding_output);
545 added_monitors.clear();
548 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()));
550 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
551 assert_eq!(added_monitors.len(), 1);
552 assert_eq!(added_monitors[0].0, funding_output);
553 added_monitors.clear();
556 let events_4 = node_a.node.get_and_clear_pending_events();
557 assert_eq!(events_4.len(), 0);
559 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
560 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
561 node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
563 // Ensure that funding_transaction_generated is idempotent.
564 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).is_err());
565 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
566 check_added_monitors!(node_a, 0);
571 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 {
572 let create_chan_id = node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
573 let open_channel_msg = get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id());
574 assert_eq!(open_channel_msg.temporary_channel_id, create_chan_id);
575 node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), a_flags, &open_channel_msg);
576 let accept_channel_msg = get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id());
577 assert_eq!(accept_channel_msg.temporary_channel_id, create_chan_id);
578 node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), b_flags, &accept_channel_msg);
580 sign_funding_transaction(node_a, node_b, channel_value, create_chan_id)
583 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) {
584 confirm_transaction_at(node_conf, tx, conf_height);
585 connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
586 node_recv.node.handle_funding_locked(&node_conf.node.get_our_node_id(), &get_event_msg!(node_conf, MessageSendEvent::SendFundingLocked, node_recv.node.get_our_node_id()));
589 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::FundingLocked, msgs::AnnouncementSignatures), [u8; 32]) {
591 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
592 assert_eq!(events_6.len(), 2);
593 ((match events_6[0] {
594 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
595 channel_id = msg.channel_id.clone();
596 assert_eq!(*node_id, node_recv.node.get_our_node_id());
599 _ => panic!("Unexpected event"),
600 }, match events_6[1] {
601 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
602 assert_eq!(*node_id, node_recv.node.get_our_node_id());
605 _ => panic!("Unexpected event"),
609 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::FundingLocked, msgs::AnnouncementSignatures), [u8; 32]) {
610 let conf_height = core::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
611 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
612 confirm_transaction_at(node_a, tx, conf_height);
613 connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
614 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
617 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::FundingLocked, msgs::AnnouncementSignatures), [u8; 32], Transaction) {
618 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat, a_flags, b_flags);
619 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
623 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::FundingLocked, msgs::AnnouncementSignatures)) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate) {
624 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
625 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
626 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
628 let events_7 = node_b.node.get_and_clear_pending_msg_events();
629 assert_eq!(events_7.len(), 1);
630 let (announcement, bs_update) = match events_7[0] {
631 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
634 _ => panic!("Unexpected event"),
637 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
638 let events_8 = node_a.node.get_and_clear_pending_msg_events();
639 assert_eq!(events_8.len(), 1);
640 let as_update = match events_8[0] {
641 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
642 assert!(*announcement == *msg);
643 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
644 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
647 _ => panic!("Unexpected event"),
650 *node_a.network_chan_count.borrow_mut() += 1;
652 ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
655 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) {
656 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001, a_flags, b_flags)
659 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) {
660 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat, a_flags, b_flags);
661 update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
662 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
665 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) {
666 nodes[a].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
667 let a_events = nodes[a].node.get_and_clear_pending_msg_events();
668 assert!(a_events.len() >= 2);
670 // ann should be re-generated by broadcast_node_announcement - check that we have it.
671 let mut found_ann_1 = false;
672 for event in a_events.iter() {
674 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
675 if msg == ann { found_ann_1 = true; }
677 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
678 _ => panic!("Unexpected event {:?}", event),
681 assert!(found_ann_1);
683 let a_node_announcement = match a_events.last().unwrap() {
684 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
687 _ => panic!("Unexpected event"),
690 nodes[b].node.broadcast_node_announcement([1, 1, 1], [1; 32], Vec::new());
691 let b_events = nodes[b].node.get_and_clear_pending_msg_events();
692 assert!(b_events.len() >= 2);
694 // ann should be re-generated by broadcast_node_announcement - check that we have it.
695 let mut found_ann_2 = false;
696 for event in b_events.iter() {
698 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
699 if msg == ann { found_ann_2 = true; }
701 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
702 _ => panic!("Unexpected event"),
705 assert!(found_ann_2);
707 let b_node_announcement = match b_events.last().unwrap() {
708 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
711 _ => panic!("Unexpected event"),
715 assert!(node.net_graph_msg_handler.handle_channel_announcement(ann).unwrap());
716 node.net_graph_msg_handler.handle_channel_update(upd_1).unwrap();
717 node.net_graph_msg_handler.handle_channel_update(upd_2).unwrap();
718 node.net_graph_msg_handler.handle_node_announcement(&a_node_announcement).unwrap();
719 node.net_graph_msg_handler.handle_node_announcement(&b_node_announcement).unwrap();
724 macro_rules! check_spends {
725 ($tx: expr, $($spends_txn: expr),*) => {
728 for outp in $spends_txn.output.iter() {
729 assert!(outp.value >= outp.script_pubkey.dust_value().as_sat(), "Input tx output didn't meet dust limit");
732 for outp in $tx.output.iter() {
733 assert!(outp.value >= outp.script_pubkey.dust_value().as_sat(), "Spending tx output didn't meet dust limit");
735 let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
737 if out_point.txid == $spends_txn.txid() {
738 return $spends_txn.output.get(out_point.vout as usize).cloned()
743 let mut total_value_in = 0;
744 for input in $tx.input.iter() {
745 total_value_in += get_output(&input.previous_output).unwrap().value;
747 let mut total_value_out = 0;
748 for output in $tx.output.iter() {
749 total_value_out += output.value;
751 let min_fee = ($tx.get_weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
752 // Input amount - output amount = fee, so check that out + min_fee is smaller than input
753 assert!(total_value_out + min_fee <= total_value_in);
754 $tx.verify(get_output).unwrap();
759 macro_rules! get_closing_signed_broadcast {
760 ($node: expr, $dest_pubkey: expr) => {
762 let events = $node.get_and_clear_pending_msg_events();
763 assert!(events.len() == 1 || events.len() == 2);
764 (match events[events.len() - 1] {
765 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
766 assert_eq!(msg.contents.flags & 2, 2);
769 _ => panic!("Unexpected event"),
770 }, if events.len() == 2 {
772 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
773 assert_eq!(*node_id, $dest_pubkey);
776 _ => panic!("Unexpected event"),
784 macro_rules! check_warn_msg {
785 ($node: expr, $recipient_node_id: expr, $chan_id: expr) => {{
786 let msg_events = $node.node.get_and_clear_pending_msg_events();
787 assert_eq!(msg_events.len(), 1);
788 match msg_events[0] {
789 MessageSendEvent::HandleError { action: ErrorAction::SendWarningMessage { ref msg, log_level: _ }, node_id } => {
790 assert_eq!(node_id, $recipient_node_id);
791 assert_eq!(msg.channel_id, $chan_id);
794 _ => panic!("Unexpected event"),
799 /// Check that a channel's closing channel update has been broadcasted, and optionally
800 /// check whether an error message event has occurred.
802 macro_rules! check_closed_broadcast {
803 ($node: expr, $with_error_msg: expr) => {{
804 use $crate::util::events::MessageSendEvent;
805 use $crate::ln::msgs::ErrorAction;
807 let msg_events = $node.node.get_and_clear_pending_msg_events();
808 assert_eq!(msg_events.len(), if $with_error_msg { 2 } else { 1 });
809 match msg_events[0] {
810 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
811 assert_eq!(msg.contents.flags & 2, 2);
813 _ => panic!("Unexpected event"),
816 match msg_events[1] {
817 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
818 // TODO: Check node_id
821 _ => panic!("Unexpected event"),
827 /// Check that a channel's closing channel events has been issued
829 macro_rules! check_closed_event {
830 ($node: expr, $events: expr, $reason: expr) => {
831 check_closed_event!($node, $events, $reason, false);
833 ($node: expr, $events: expr, $reason: expr, $is_check_discard_funding: expr) => {{
834 use $crate::util::events::Event;
836 let events = $node.node.get_and_clear_pending_events();
837 assert_eq!(events.len(), $events);
838 let expected_reason = $reason;
839 let mut issues_discard_funding = false;
840 for event in events {
842 Event::ChannelClosed { ref reason, .. } => {
843 assert_eq!(*reason, expected_reason);
845 Event::DiscardFunding { .. } => {
846 issues_discard_funding = true;
848 _ => panic!("Unexpected event"),
851 assert_eq!($is_check_discard_funding, issues_discard_funding);
855 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) {
856 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) };
857 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) };
860 node_a.close_channel(channel_id).unwrap();
861 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()));
863 let events_1 = node_b.get_and_clear_pending_msg_events();
864 assert!(events_1.len() >= 1);
865 let shutdown_b = match events_1[0] {
866 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
867 assert_eq!(node_id, &node_a.get_our_node_id());
870 _ => panic!("Unexpected event"),
873 let closing_signed_b = if !close_inbound_first {
874 assert_eq!(events_1.len(), 1);
877 Some(match events_1[1] {
878 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
879 assert_eq!(node_id, &node_a.get_our_node_id());
882 _ => panic!("Unexpected event"),
886 node_a.handle_shutdown(&node_b.get_our_node_id(), &InitFeatures::known(), &shutdown_b);
887 let (as_update, bs_update) = if close_inbound_first {
888 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
889 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
891 node_b.handle_closing_signed(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id()));
892 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
893 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
894 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
896 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
897 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
898 assert!(none_a.is_none());
899 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
900 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
901 (as_update, bs_update)
903 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
905 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
906 node_a.handle_closing_signed(&node_b.get_our_node_id(), &get_event_msg!(struct_b, MessageSendEvent::SendClosingSigned, node_a.get_our_node_id()));
908 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
909 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
910 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
912 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
913 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
914 assert!(none_b.is_none());
915 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
916 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
917 (as_update, bs_update)
919 assert_eq!(tx_a, tx_b);
920 check_spends!(tx_a, funding_tx);
922 (as_update, bs_update, tx_a)
925 pub struct SendEvent {
926 pub node_id: PublicKey,
927 pub msgs: Vec<msgs::UpdateAddHTLC>,
928 pub commitment_msg: msgs::CommitmentSigned,
931 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
932 assert!(updates.update_fulfill_htlcs.is_empty());
933 assert!(updates.update_fail_htlcs.is_empty());
934 assert!(updates.update_fail_malformed_htlcs.is_empty());
935 assert!(updates.update_fee.is_none());
936 SendEvent { node_id: node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
939 pub fn from_event(event: MessageSendEvent) -> SendEvent {
941 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
942 _ => panic!("Unexpected event type!"),
946 pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
947 let mut events = node.node.get_and_clear_pending_msg_events();
948 assert_eq!(events.len(), 1);
949 SendEvent::from_event(events.pop().unwrap())
954 /// Performs the "commitment signed dance" - the series of message exchanges which occur after a
955 /// commitment update.
956 macro_rules! commitment_signed_dance {
957 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
959 check_added_monitors!($node_a, 0);
960 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
961 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
962 check_added_monitors!($node_a, 1);
963 commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
966 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
968 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
969 check_added_monitors!($node_b, 0);
970 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
971 $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack);
972 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
973 check_added_monitors!($node_b, 1);
974 $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed);
975 let (bs_revoke_and_ack, extra_msg_option) = {
976 let events = $node_b.node.get_and_clear_pending_msg_events();
977 assert!(events.len() <= 2);
979 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
980 assert_eq!(*node_id, $node_a.node.get_our_node_id());
983 _ => panic!("Unexpected event"),
984 }, events.get(1).map(|e| e.clone()))
986 check_added_monitors!($node_b, 1);
988 assert!($node_a.node.get_and_clear_pending_events().is_empty());
989 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
991 (extra_msg_option, bs_revoke_and_ack)
994 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
996 check_added_monitors!($node_a, 0);
997 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
998 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
999 check_added_monitors!($node_a, 1);
1000 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
1001 assert!(extra_msg_option.is_none());
1005 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
1007 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
1008 $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1009 check_added_monitors!($node_a, 1);
1013 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
1015 assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
1018 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
1020 commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
1021 if $fail_backwards {
1022 $crate::expect_pending_htlcs_forwardable!($node_a);
1023 check_added_monitors!($node_a, 1);
1025 let channel_state = $node_a.node.channel_state.lock().unwrap();
1026 assert_eq!(channel_state.pending_msg_events.len(), 1);
1027 if let MessageSendEvent::UpdateHTLCs { ref node_id, .. } = channel_state.pending_msg_events[0] {
1028 assert_ne!(*node_id, $node_b.node.get_our_node_id());
1029 } else { panic!("Unexpected event"); }
1031 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1037 /// Get a payment preimage and hash.
1039 macro_rules! get_payment_preimage_hash {
1040 ($dest_node: expr) => {
1042 get_payment_preimage_hash!($dest_node, None)
1045 ($dest_node: expr, $min_value_msat: expr) => {
1047 use bitcoin::hashes::Hash as _;
1048 let mut payment_count = $dest_node.network_payment_count.borrow_mut();
1049 let payment_preimage = $crate::ln::PaymentPreimage([*payment_count; 32]);
1050 *payment_count += 1;
1051 let payment_hash = $crate::ln::PaymentHash(
1052 bitcoin::hashes::sha256::Hash::hash(&payment_preimage.0[..]).into_inner());
1053 let payment_secret = $dest_node.node.create_inbound_payment_for_hash(payment_hash, $min_value_msat, 7200).unwrap();
1054 (payment_preimage, payment_hash, payment_secret)
1061 macro_rules! get_route_and_payment_hash {
1062 ($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
1063 $crate::get_route_and_payment_hash!($send_node, $recv_node, vec![], $recv_value, TEST_FINAL_CLTV)
1065 ($send_node: expr, $recv_node: expr, $last_hops: expr, $recv_value: expr, $cltv: expr) => {{
1066 let (payment_preimage, payment_hash, payment_secret) = $crate::get_payment_preimage_hash!($recv_node, Some($recv_value));
1067 let payee = $crate::routing::router::Payee::from_node_id($recv_node.node.get_our_node_id())
1068 .with_features($crate::ln::features::InvoiceFeatures::known())
1069 .with_route_hints($last_hops);
1070 let scorer = $crate::util::test_utils::TestScorer::with_fixed_penalty(0);
1071 let route = $crate::routing::router::get_route(
1072 &$send_node.node.get_our_node_id(), &payee, $send_node.network_graph,
1073 Some(&$send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1074 $recv_value, $cltv, $send_node.logger, &scorer
1076 (route, payment_hash, payment_preimage, payment_secret)
1081 /// Clears (and ignores) a PendingHTLCsForwardable event
1082 macro_rules! expect_pending_htlcs_forwardable_ignore {
1084 let events = $node.node.get_and_clear_pending_events();
1085 assert_eq!(events.len(), 1);
1087 Event::PendingHTLCsForwardable { .. } => { },
1088 _ => panic!("Unexpected event"),
1094 /// Handles a PendingHTLCsForwardable event
1095 macro_rules! expect_pending_htlcs_forwardable {
1097 $crate::expect_pending_htlcs_forwardable_ignore!($node);
1098 $node.node.process_pending_htlc_forwards();
1100 // Ensure process_pending_htlc_forwards is idempotent.
1101 $node.node.process_pending_htlc_forwards();
1106 macro_rules! expect_pending_htlcs_forwardable_from_events {
1107 ($node: expr, $events: expr, $ignore: expr) => {{
1108 assert_eq!($events.len(), 1);
1110 Event::PendingHTLCsForwardable { .. } => { },
1111 _ => panic!("Unexpected event"),
1114 $node.node.process_pending_htlc_forwards();
1116 // Ensure process_pending_htlc_forwards is idempotent.
1117 $node.node.process_pending_htlc_forwards();
1122 #[cfg(any(test, feature = "unstable"))]
1123 macro_rules! expect_payment_received {
1124 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr) => {
1125 let events = $node.node.get_and_clear_pending_events();
1126 assert_eq!(events.len(), 1);
1128 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
1129 assert_eq!($expected_payment_hash, *payment_hash);
1130 assert_eq!($expected_recv_value, amt);
1132 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1133 assert!(payment_preimage.is_none());
1134 assert_eq!($expected_payment_secret, *payment_secret);
1139 _ => panic!("Unexpected event"),
1146 macro_rules! expect_payment_sent_without_paths {
1147 ($node: expr, $expected_payment_preimage: expr) => {
1148 expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, false);
1150 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1151 expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, false);
1156 macro_rules! expect_payment_sent {
1157 ($node: expr, $expected_payment_preimage: expr) => {
1158 $crate::expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, true);
1160 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1161 $crate::expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, true);
1163 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr, $expect_paths: expr) => { {
1164 use bitcoin::hashes::Hash as _;
1165 let events = $node.node.get_and_clear_pending_events();
1166 let expected_payment_hash = $crate::ln::PaymentHash(
1167 bitcoin::hashes::sha256::Hash::hash(&$expected_payment_preimage.0).into_inner());
1169 assert!(events.len() > 1);
1171 assert_eq!(events.len(), 1);
1173 let expected_payment_id = match events[0] {
1174 $crate::util::events::Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
1175 assert_eq!($expected_payment_preimage, *payment_preimage);
1176 assert_eq!(expected_payment_hash, *payment_hash);
1177 assert!(fee_paid_msat.is_some());
1178 if $expected_fee_msat_opt.is_some() {
1179 assert_eq!(*fee_paid_msat, $expected_fee_msat_opt);
1183 _ => panic!("Unexpected event"),
1186 for i in 1..events.len() {
1188 $crate::util::events::Event::PaymentPathSuccessful { payment_id, payment_hash, .. } => {
1189 assert_eq!(payment_id, expected_payment_id);
1190 assert_eq!(payment_hash, Some(expected_payment_hash));
1192 _ => panic!("Unexpected event"),
1201 macro_rules! expect_payment_path_successful {
1203 let events = $node.node.get_and_clear_pending_events();
1204 assert_eq!(events.len(), 1);
1206 $crate::util::events::Event::PaymentPathSuccessful { .. } => {},
1207 _ => panic!("Unexpected event"),
1212 macro_rules! expect_payment_forwarded {
1213 ($node: expr, $expected_fee: expr, $upstream_force_closed: expr) => {
1214 let events = $node.node.get_and_clear_pending_events();
1215 assert_eq!(events.len(), 1);
1217 Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
1218 assert_eq!(fee_earned_msat, $expected_fee);
1219 assert_eq!(claim_from_onchain_tx, $upstream_force_closed);
1221 _ => panic!("Unexpected event"),
1226 pub struct PaymentFailedConditions<'a> {
1227 pub(crate) expected_htlc_error_data: Option<(u16, &'a [u8])>,
1228 pub(crate) expected_blamed_scid: Option<u64>,
1229 pub(crate) expected_blamed_chan_closed: Option<bool>,
1230 pub(crate) expected_mpp_parts_remain: bool,
1233 impl<'a> PaymentFailedConditions<'a> {
1234 pub fn new() -> Self {
1236 expected_htlc_error_data: None,
1237 expected_blamed_scid: None,
1238 expected_blamed_chan_closed: None,
1239 expected_mpp_parts_remain: false,
1242 pub fn mpp_parts_remain(mut self) -> Self {
1243 self.expected_mpp_parts_remain = true;
1246 pub fn blamed_scid(mut self, scid: u64) -> Self {
1247 self.expected_blamed_scid = Some(scid);
1250 pub fn blamed_chan_closed(mut self, closed: bool) -> Self {
1251 self.expected_blamed_chan_closed = Some(closed);
1254 pub fn expected_htlc_error_data(mut self, code: u16, data: &'a [u8]) -> Self {
1255 self.expected_htlc_error_data = Some((code, data));
1261 macro_rules! expect_payment_failed_with_update {
1262 ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr, $scid: expr, $chan_closed: expr) => {
1263 expect_payment_failed_conditions!($node, $expected_payment_hash, $rejected_by_dest,
1264 $crate::ln::functional_test_utils::PaymentFailedConditions::new().blamed_scid($scid).blamed_chan_closed($chan_closed));
1269 macro_rules! expect_payment_failed {
1270 ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
1271 #[allow(unused_mut)]
1272 let mut conditions = $crate::ln::functional_test_utils::PaymentFailedConditions::new();
1274 conditions = conditions.expected_htlc_error_data($expected_error_code, &$expected_error_data);
1276 expect_payment_failed_conditions!($node, $expected_payment_hash, $rejected_by_dest, conditions);
1281 macro_rules! expect_payment_failed_conditions {
1282 ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr, $conditions: expr) => {
1283 let events = $node.node.get_and_clear_pending_events();
1284 assert_eq!(events.len(), 1);
1285 let expected_payment_id = match events[0] {
1286 Event::PaymentPathFailed { ref payment_hash, rejected_by_dest, ref error_code, ref error_data, ref path, ref retry, ref payment_id, ref network_update, .. } => {
1287 assert_eq!(*payment_hash, $expected_payment_hash, "unexpected payment_hash");
1288 assert_eq!(rejected_by_dest, $rejected_by_dest, "unexpected rejected_by_dest value");
1289 assert!(retry.is_some(), "expected retry.is_some()");
1290 assert_eq!(retry.as_ref().unwrap().final_value_msat, path.last().unwrap().fee_msat, "Retry amount should match last hop in path");
1291 assert_eq!(retry.as_ref().unwrap().payee.pubkey, path.last().unwrap().pubkey, "Retry payee node_id should match last hop in path");
1293 assert!(error_code.is_some(), "expected error_code.is_some() = true");
1294 assert!(error_data.is_some(), "expected error_data.is_some() = true");
1295 if let Some((code, data)) = $conditions.expected_htlc_error_data {
1296 assert_eq!(error_code.unwrap(), code, "unexpected error code");
1297 assert_eq!(&error_data.as_ref().unwrap()[..], data, "unexpected error data");
1300 if let Some(chan_closed) = $conditions.expected_blamed_chan_closed {
1301 match network_update {
1302 &Some($crate::routing::network_graph::NetworkUpdate::ChannelUpdateMessage { ref msg }) if !chan_closed => {
1303 if let Some(scid) = $conditions.expected_blamed_scid {
1304 assert_eq!(msg.contents.short_channel_id, scid);
1306 assert_eq!(msg.contents.flags & 2, 0);
1308 &Some($crate::routing::network_graph::NetworkUpdate::ChannelClosed { short_channel_id, is_permanent }) if chan_closed => {
1309 if let Some(scid) = $conditions.expected_blamed_scid {
1310 assert_eq!(short_channel_id, scid);
1312 assert!(is_permanent);
1314 Some(_) => panic!("Unexpected update type"),
1315 None => panic!("Expected update"),
1321 _ => panic!("Unexpected event"),
1323 if !$conditions.expected_mpp_parts_remain {
1324 $node.node.abandon_payment(expected_payment_id);
1325 let events = $node.node.get_and_clear_pending_events();
1326 assert_eq!(events.len(), 1);
1328 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
1329 assert_eq!(*payment_hash, $expected_payment_hash, "unexpected second payment_hash");
1330 assert_eq!(*payment_id, expected_payment_id);
1332 _ => panic!("Unexpected second event"),
1338 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 {
1339 let payment_id = origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
1340 check_added_monitors!(origin_node, expected_paths.len());
1341 pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
1345 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>) {
1346 let mut payment_event = SendEvent::from_event(ev);
1347 let mut prev_node = origin_node;
1349 for (idx, &node) in expected_path.iter().enumerate() {
1350 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
1352 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
1353 check_added_monitors!(node, 0);
1354 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
1356 expect_pending_htlcs_forwardable!(node);
1358 if idx == expected_path.len() - 1 {
1359 let events_2 = node.node.get_and_clear_pending_events();
1360 if payment_received_expected {
1361 assert_eq!(events_2.len(), 1);
1363 Event::PaymentReceived { ref payment_hash, ref purpose, amt} => {
1364 assert_eq!(our_payment_hash, *payment_hash);
1366 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1367 assert_eq!(expected_preimage, *payment_preimage);
1368 assert_eq!(our_payment_secret.unwrap(), *payment_secret);
1370 PaymentPurpose::SpontaneousPayment(payment_preimage) => {
1371 assert_eq!(expected_preimage.unwrap(), *payment_preimage);
1372 assert!(our_payment_secret.is_none());
1375 assert_eq!(amt, recv_value);
1377 _ => panic!("Unexpected event"),
1380 assert!(events_2.is_empty());
1383 let mut events_2 = node.node.get_and_clear_pending_msg_events();
1384 assert_eq!(events_2.len(), 1);
1385 check_added_monitors!(node, 1);
1386 payment_event = SendEvent::from_event(events_2.remove(0));
1387 assert_eq!(payment_event.msgs.len(), 1);
1394 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) {
1395 let mut events = origin_node.node.get_and_clear_pending_msg_events();
1396 assert_eq!(events.len(), expected_route.len());
1397 for (path_idx, (ev, expected_path)) in events.drain(..).zip(expected_route.iter()).enumerate() {
1398 // Once we've gotten through all the HTLCs, the last one should result in a
1399 // PaymentReceived (but each previous one should not!), .
1400 let expect_payment = path_idx == expected_route.len() - 1;
1401 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), Some(our_payment_secret), ev, expect_payment, None);
1405 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) {
1406 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
1407 let payment_id = send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, our_payment_secret);
1408 (our_payment_preimage, our_payment_hash, our_payment_secret, payment_id)
1411 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 {
1412 for path in expected_paths.iter() {
1413 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1415 assert!(expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage));
1416 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1418 let mut expected_total_fee_msat = 0;
1420 macro_rules! msgs_from_ev {
1423 &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 } } => {
1424 assert!(update_add_htlcs.is_empty());
1425 assert_eq!(update_fulfill_htlcs.len(), 1);
1426 assert!(update_fail_htlcs.is_empty());
1427 assert!(update_fail_malformed_htlcs.is_empty());
1428 assert!(update_fee.is_none());
1429 ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
1431 _ => panic!("Unexpected event"),
1435 let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1436 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1437 assert_eq!(events.len(), expected_paths.len());
1438 for ev in events.iter() {
1439 per_path_msgs.push(msgs_from_ev!(ev));
1442 for (expected_route, (path_msgs, next_hop)) in expected_paths.iter().zip(per_path_msgs.drain(..)) {
1443 let mut next_msgs = Some(path_msgs);
1444 let mut expected_next_node = next_hop;
1446 macro_rules! last_update_fulfill_dance {
1447 ($node: expr, $prev_node: expr) => {
1449 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1450 check_added_monitors!($node, 0);
1451 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1452 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1456 macro_rules! mid_update_fulfill_dance {
1457 ($node: expr, $prev_node: expr, $new_msgs: expr) => {
1459 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1460 let fee = $node.node.channel_state.lock().unwrap().by_id.get(&next_msgs.as_ref().unwrap().0.channel_id).unwrap().config.forwarding_fee_base_msat;
1461 expect_payment_forwarded!($node, Some(fee as u64), false);
1462 expected_total_fee_msat += fee as u64;
1463 check_added_monitors!($node, 1);
1464 let new_next_msgs = if $new_msgs {
1465 let events = $node.node.get_and_clear_pending_msg_events();
1466 assert_eq!(events.len(), 1);
1467 let (res, nexthop) = msgs_from_ev!(&events[0]);
1468 expected_next_node = nexthop;
1471 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1474 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1475 next_msgs = new_next_msgs;
1480 let mut prev_node = expected_route.last().unwrap();
1481 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
1482 assert_eq!(expected_next_node, node.node.get_our_node_id());
1483 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
1484 if next_msgs.is_some() {
1485 mid_update_fulfill_dance!(node, prev_node, update_next_msgs);
1487 assert!(!update_next_msgs);
1488 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
1490 if !skip_last && idx == expected_route.len() - 1 {
1491 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1498 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
1502 // Ensure that claim_funds is idempotent.
1503 assert!(!expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage));
1504 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
1505 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
1507 expected_total_fee_msat
1509 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) {
1510 let expected_total_fee_msat = do_claim_payment_along_route(origin_node, expected_paths, skip_last, our_payment_preimage);
1512 expect_payment_sent!(origin_node, our_payment_preimage, Some(expected_total_fee_msat));
1516 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage) {
1517 claim_payment_along_route(origin_node, &[expected_route], false, our_payment_preimage);
1520 pub const TEST_FINAL_CLTV: u32 = 70;
1522 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) {
1523 let payee = Payee::from_node_id(expected_route.last().unwrap().node.get_our_node_id())
1524 .with_features(InvoiceFeatures::known());
1525 let scorer = test_utils::TestScorer::with_fixed_penalty(0);
1526 let route = get_route(
1527 &origin_node.node.get_our_node_id(), &payee, &origin_node.network_graph,
1528 Some(&origin_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1529 recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer).unwrap();
1530 assert_eq!(route.paths.len(), 1);
1531 assert_eq!(route.paths[0].len(), expected_route.len());
1532 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1533 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1536 let res = send_along_route(origin_node, route, expected_route, recv_value);
1537 (res.0, res.1, res.2)
1540 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
1541 let payee = Payee::from_node_id(expected_route.last().unwrap().node.get_our_node_id())
1542 .with_features(InvoiceFeatures::known());
1543 let scorer = test_utils::TestScorer::with_fixed_penalty(0);
1544 let route = get_route(&origin_node.node.get_our_node_id(), &payee, origin_node.network_graph, None, recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer).unwrap();
1545 assert_eq!(route.paths.len(), 1);
1546 assert_eq!(route.paths[0].len(), expected_route.len());
1547 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1548 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1551 let (_, our_payment_hash, our_payment_preimage) = get_payment_preimage_hash!(expected_route.last().unwrap());
1552 unwrap_send_err!(origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_preimage)), true, APIError::ChannelUnavailable { ref err },
1553 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
1556 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
1557 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
1558 claim_payment(&origin, expected_route, our_payment_preimage);
1561 pub fn fail_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_paths_slice: &[&[&Node<'a, 'b, 'c>]], skip_last: bool, our_payment_hash: PaymentHash) {
1562 let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
1563 for path in expected_paths.iter() {
1564 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1566 assert!(expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash));
1567 expect_pending_htlcs_forwardable!(expected_paths[0].last().unwrap());
1568 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1570 let mut per_path_msgs: Vec<((msgs::UpdateFailHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1571 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1572 assert_eq!(events.len(), expected_paths.len());
1573 for ev in events.iter() {
1574 let (update_fail, commitment_signed, node_id) = match ev {
1575 &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 } } => {
1576 assert!(update_add_htlcs.is_empty());
1577 assert!(update_fulfill_htlcs.is_empty());
1578 assert_eq!(update_fail_htlcs.len(), 1);
1579 assert!(update_fail_malformed_htlcs.is_empty());
1580 assert!(update_fee.is_none());
1581 (update_fail_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
1583 _ => panic!("Unexpected event"),
1585 per_path_msgs.push(((update_fail, commitment_signed), node_id));
1587 per_path_msgs.sort_unstable_by(|(_, node_id_a), (_, node_id_b)| node_id_a.cmp(node_id_b));
1588 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()));
1590 for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
1591 let mut next_msgs = Some(path_msgs);
1592 let mut expected_next_node = next_hop;
1593 let mut prev_node = expected_route.last().unwrap();
1595 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
1596 assert_eq!(expected_next_node, node.node.get_our_node_id());
1597 let update_next_node = !skip_last || idx != expected_route.len() - 1;
1598 if next_msgs.is_some() {
1599 node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1600 commitment_signed_dance!(node, prev_node, next_msgs.as_ref().unwrap().1, update_next_node);
1601 if !update_next_node {
1602 expect_pending_htlcs_forwardable!(node);
1605 let events = node.node.get_and_clear_pending_msg_events();
1606 if update_next_node {
1607 assert_eq!(events.len(), 1);
1609 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 } } => {
1610 assert!(update_add_htlcs.is_empty());
1611 assert!(update_fulfill_htlcs.is_empty());
1612 assert_eq!(update_fail_htlcs.len(), 1);
1613 assert!(update_fail_malformed_htlcs.is_empty());
1614 assert!(update_fee.is_none());
1615 expected_next_node = node_id.clone();
1616 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
1618 _ => panic!("Unexpected event"),
1621 assert!(events.is_empty());
1623 if !skip_last && idx == expected_route.len() - 1 {
1624 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1631 let prev_node = expected_route.first().unwrap();
1632 origin_node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1633 check_added_monitors!(origin_node, 0);
1634 assert!(origin_node.node.get_and_clear_pending_msg_events().is_empty());
1635 commitment_signed_dance!(origin_node, prev_node, next_msgs.as_ref().unwrap().1, false);
1636 let events = origin_node.node.get_and_clear_pending_events();
1637 assert_eq!(events.len(), 1);
1638 let expected_payment_id = match events[0] {
1639 Event::PaymentPathFailed { payment_hash, rejected_by_dest, all_paths_failed, ref path, ref payment_id, .. } => {
1640 assert_eq!(payment_hash, our_payment_hash);
1641 assert!(rejected_by_dest);
1642 assert_eq!(all_paths_failed, i == expected_paths.len() - 1);
1643 for (idx, hop) in expected_route.iter().enumerate() {
1644 assert_eq!(hop.node.get_our_node_id(), path[idx].pubkey);
1648 _ => panic!("Unexpected event"),
1650 if i == expected_paths.len() - 1 {
1651 origin_node.node.abandon_payment(expected_payment_id);
1652 let events = origin_node.node.get_and_clear_pending_events();
1653 assert_eq!(events.len(), 1);
1655 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
1656 assert_eq!(*payment_hash, our_payment_hash, "unexpected second payment_hash");
1657 assert_eq!(*payment_id, expected_payment_id);
1659 _ => panic!("Unexpected second event"),
1665 // Ensure that fail_htlc_backwards is idempotent.
1666 assert!(!expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash));
1667 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_events().is_empty());
1668 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
1669 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
1672 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash) {
1673 fail_payment_along_route(origin_node, &[&expected_path[..]], false, our_payment_hash);
1676 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
1677 let mut chan_mon_cfgs = Vec::new();
1678 for i in 0..node_count {
1679 let tx_broadcaster = test_utils::TestBroadcaster {
1680 txn_broadcasted: Mutex::new(Vec::new()),
1681 blocks: Arc::new(Mutex::new(vec![(genesis_block(Network::Testnet).header, 0)])),
1683 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
1684 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
1685 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
1686 let persister = test_utils::TestPersister::new();
1687 let seed = [i as u8; 32];
1688 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
1689 let network_graph = NetworkGraph::new(chain_source.genesis_hash);
1691 chan_mon_cfgs.push(TestChanMonCfg{ tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager, network_graph });
1697 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
1698 let mut nodes = Vec::new();
1700 for i in 0..node_count {
1701 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);
1702 let seed = [i as u8; 32];
1703 nodes.push(NodeCfg {
1704 chain_source: &chanmon_cfgs[i].chain_source,
1705 logger: &chanmon_cfgs[i].logger,
1706 tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster,
1707 fee_estimator: &chanmon_cfgs[i].fee_estimator,
1709 keys_manager: &chanmon_cfgs[i].keys_manager,
1711 features: InitFeatures::known(),
1712 network_graph: &chanmon_cfgs[i].network_graph,
1719 pub fn test_default_channel_config() -> UserConfig {
1720 let mut default_config = UserConfig::default();
1721 // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
1722 // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
1723 default_config.channel_options.cltv_expiry_delta = 6*6;
1724 default_config.channel_options.announced_channel = true;
1725 default_config.peer_channel_config_limits.force_announced_channel_preference = false;
1726 // When most of our tests were written, the default HTLC minimum was fixed at 1000.
1727 // It now defaults to 1, so we simply set it to the expected value here.
1728 default_config.own_channel_config.our_htlc_minimum_msat = 1000;
1729 // When most of our tests were written, we didn't have the notion of a `max_dust_htlc_exposure_msat`,
1730 // It now defaults to 5_000_000 msat; to avoid interfering with tests we bump it to 50_000_000 msat.
1731 default_config.channel_options.max_dust_htlc_exposure_msat = 50_000_000;
1735 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>> {
1736 let mut chanmgrs = Vec::new();
1737 for i in 0..node_count {
1738 let network = Network::Testnet;
1739 let params = ChainParameters {
1741 best_block: BestBlock::from_genesis(network),
1743 let node = ChannelManager::new(cfgs[i].fee_estimator, &cfgs[i].chain_monitor, cfgs[i].tx_broadcaster, cfgs[i].logger, cfgs[i].keys_manager,
1744 if node_config[i].is_some() { node_config[i].clone().unwrap() } else { test_default_channel_config() }, params);
1745 chanmgrs.push(node);
1751 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>> {
1752 let mut nodes = Vec::new();
1753 let chan_count = Rc::new(RefCell::new(0));
1754 let payment_count = Rc::new(RefCell::new(0));
1755 let connect_style = Rc::new(RefCell::new(ConnectStyle::FullBlockViaListen));
1757 for i in 0..node_count {
1758 let net_graph_msg_handler = NetGraphMsgHandler::new(cfgs[i].network_graph, None, cfgs[i].logger);
1760 chain_source: cfgs[i].chain_source, tx_broadcaster: cfgs[i].tx_broadcaster,
1761 chain_monitor: &cfgs[i].chain_monitor, keys_manager: &cfgs[i].keys_manager,
1762 node: &chan_mgrs[i], network_graph: &cfgs[i].network_graph, net_graph_msg_handler,
1763 node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
1764 network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
1765 blocks: Arc::clone(&cfgs[i].tx_broadcaster.blocks),
1766 connect_style: Rc::clone(&connect_style),
1770 for i in 0..node_count {
1771 for j in (i+1)..node_count {
1772 nodes[i].node.peer_connected(&nodes[j].node.get_our_node_id(), &msgs::Init { features: cfgs[j].features.clone() });
1773 nodes[j].node.peer_connected(&nodes[i].node.get_our_node_id(), &msgs::Init { features: cfgs[i].features.clone() });
1780 // Note that the following only works for CLTV values up to 128
1781 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
1782 pub const OFFERED_HTLC_SCRIPT_WEIGHT: usize = 133;
1784 #[derive(PartialEq)]
1785 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
1786 /// Tests that the given node has broadcast transactions for the given Channel
1788 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
1789 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
1790 /// broadcast and the revoked outputs were claimed.
1792 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
1793 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
1795 /// All broadcast transactions must be accounted for in one of the above three types of we'll
1797 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> {
1798 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1799 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
1801 let mut res = Vec::with_capacity(2);
1802 node_txn.retain(|tx| {
1803 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
1804 check_spends!(tx, chan.3);
1805 if commitment_tx.is_none() {
1806 res.push(tx.clone());
1811 if let Some(explicit_tx) = commitment_tx {
1812 res.push(explicit_tx.clone());
1815 assert_eq!(res.len(), 1);
1817 if has_htlc_tx != HTLCType::NONE {
1818 node_txn.retain(|tx| {
1819 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
1820 check_spends!(tx, res[0]);
1821 if has_htlc_tx == HTLCType::TIMEOUT {
1822 assert!(tx.lock_time != 0);
1824 assert!(tx.lock_time == 0);
1826 res.push(tx.clone());
1830 assert!(res.len() == 2 || res.len() == 3);
1832 assert_eq!(res[1], res[2]);
1836 assert!(node_txn.is_empty());
1840 /// Tests that the given node has broadcast a claim transaction against the provided revoked
1841 /// HTLC transaction.
1842 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
1843 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1844 // We may issue multiple claiming transaction on revoked outputs due to block rescan
1845 // for revoked htlc outputs
1846 if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
1847 node_txn.retain(|tx| {
1848 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
1849 check_spends!(tx, revoked_tx);
1853 node_txn.retain(|tx| {
1854 check_spends!(tx, commitment_revoked_tx);
1857 assert!(node_txn.is_empty());
1860 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
1861 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1863 assert!(node_txn.len() >= 1);
1864 assert_eq!(node_txn[0].input.len(), 1);
1865 let mut found_prev = false;
1867 for tx in prev_txn {
1868 if node_txn[0].input[0].previous_output.txid == tx.txid() {
1869 check_spends!(node_txn[0], tx);
1870 assert!(node_txn[0].input[0].witness[2].len() > 106); // must spend an htlc output
1871 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
1877 assert!(found_prev);
1879 let mut res = Vec::new();
1880 mem::swap(&mut *node_txn, &mut res);
1884 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) {
1885 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
1886 assert_eq!(events_1.len(), 2);
1887 let as_update = match events_1[0] {
1888 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1891 _ => panic!("Unexpected event"),
1894 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1895 assert_eq!(node_id, nodes[b].node.get_our_node_id());
1896 assert_eq!(msg.data, expected_error);
1897 if needs_err_handle {
1898 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
1901 _ => panic!("Unexpected event"),
1904 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
1905 assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
1906 let bs_update = match events_2[0] {
1907 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1910 _ => panic!("Unexpected event"),
1912 if !needs_err_handle {
1914 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1915 assert_eq!(node_id, nodes[a].node.get_our_node_id());
1916 assert_eq!(msg.data, expected_error);
1918 _ => panic!("Unexpected event"),
1923 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
1924 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
1928 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize) {
1929 handle_announce_close_broadcast_events(nodes, a, b, false, "Channel closed because commitment or closing transaction was confirmed on chain.");
1933 macro_rules! get_channel_value_stat {
1934 ($node: expr, $channel_id: expr) => {{
1935 let chan_lock = $node.node.channel_state.lock().unwrap();
1936 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
1937 chan.get_value_stat()
1941 macro_rules! get_chan_reestablish_msgs {
1942 ($src_node: expr, $dst_node: expr) => {
1944 let mut res = Vec::with_capacity(1);
1945 for msg in $src_node.node.get_and_clear_pending_msg_events() {
1946 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
1947 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1948 res.push(msg.clone());
1950 panic!("Unexpected event")
1958 macro_rules! handle_chan_reestablish_msgs {
1959 ($src_node: expr, $dst_node: expr) => {
1961 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
1963 let funding_locked = if let Some(&MessageSendEvent::SendFundingLocked { ref node_id, ref msg }) = msg_events.get(0) {
1965 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1971 if let Some(&MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ }) = msg_events.get(idx) {
1973 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1976 let mut revoke_and_ack = None;
1977 let mut commitment_update = None;
1978 let order = if let Some(ev) = msg_events.get(idx) {
1980 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1981 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1982 revoke_and_ack = Some(msg.clone());
1984 RAACommitmentOrder::RevokeAndACKFirst
1986 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1987 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1988 commitment_update = Some(updates.clone());
1990 RAACommitmentOrder::CommitmentFirst
1992 &MessageSendEvent::SendChannelUpdate { .. } => RAACommitmentOrder::CommitmentFirst,
1993 _ => panic!("Unexpected event"),
1996 RAACommitmentOrder::CommitmentFirst
1999 if let Some(ev) = msg_events.get(idx) {
2001 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2002 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2003 assert!(revoke_and_ack.is_none());
2004 revoke_and_ack = Some(msg.clone());
2007 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2008 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2009 assert!(commitment_update.is_none());
2010 commitment_update = Some(updates.clone());
2013 &MessageSendEvent::SendChannelUpdate { .. } => {},
2014 _ => panic!("Unexpected event"),
2018 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, ref msg }) = msg_events.get(idx) {
2019 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2020 assert_eq!(msg.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
2023 (funding_locked, revoke_and_ack, commitment_update, order)
2028 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
2029 /// for claims/fails they are separated out.
2030 pub fn reconnect_nodes<'a, 'b, 'c>(node_a: &Node<'a, 'b, 'c>, node_b: &Node<'a, 'b, 'c>, send_funding_locked: (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)) {
2031 node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
2032 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
2033 node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
2034 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
2036 if send_funding_locked.0 {
2037 // If a expects a funding_locked, it better not think it has received a revoke_and_ack
2039 for reestablish in reestablish_1.iter() {
2040 assert_eq!(reestablish.next_remote_commitment_number, 0);
2043 if send_funding_locked.1 {
2044 // If b expects a funding_locked, it better not think it has received a revoke_and_ack
2046 for reestablish in reestablish_2.iter() {
2047 assert_eq!(reestablish.next_remote_commitment_number, 0);
2050 if send_funding_locked.0 || send_funding_locked.1 {
2051 // If we expect any funding_locked's, both sides better have set
2052 // next_holder_commitment_number to 1
2053 for reestablish in reestablish_1.iter() {
2054 assert_eq!(reestablish.next_local_commitment_number, 1);
2056 for reestablish in reestablish_2.iter() {
2057 assert_eq!(reestablish.next_local_commitment_number, 1);
2061 let mut resp_1 = Vec::new();
2062 for msg in reestablish_1 {
2063 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
2064 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
2066 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
2067 check_added_monitors!(node_b, 1);
2069 check_added_monitors!(node_b, 0);
2072 let mut resp_2 = Vec::new();
2073 for msg in reestablish_2 {
2074 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
2075 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
2077 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
2078 check_added_monitors!(node_a, 1);
2080 check_added_monitors!(node_a, 0);
2083 // We don't yet support both needing updates, as that would require a different commitment dance:
2084 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_htlc_fails.0 == 0 &&
2085 pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
2086 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_htlc_fails.1 == 0 &&
2087 pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
2089 for chan_msgs in resp_1.drain(..) {
2090 if send_funding_locked.0 {
2091 node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
2092 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
2093 if !announcement_event.is_empty() {
2094 assert_eq!(announcement_event.len(), 1);
2095 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
2096 //TODO: Test announcement_sigs re-sending
2097 } else { panic!("Unexpected event!"); }
2100 assert!(chan_msgs.0.is_none());
2103 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2104 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
2105 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2106 check_added_monitors!(node_a, 1);
2108 assert!(chan_msgs.1.is_none());
2110 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 {
2111 let commitment_update = chan_msgs.2.unwrap();
2112 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2113 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
2115 assert!(commitment_update.update_add_htlcs.is_empty());
2117 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
2118 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.0 + pending_cell_htlc_fails.0);
2119 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2120 for update_add in commitment_update.update_add_htlcs {
2121 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
2123 for update_fulfill in commitment_update.update_fulfill_htlcs {
2124 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
2126 for update_fail in commitment_update.update_fail_htlcs {
2127 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
2130 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2131 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
2133 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
2134 check_added_monitors!(node_a, 1);
2135 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
2136 // No commitment_signed so get_event_msg's assert(len == 1) passes
2137 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
2138 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2139 check_added_monitors!(node_b, 1);
2142 assert!(chan_msgs.2.is_none());
2146 for chan_msgs in resp_2.drain(..) {
2147 if send_funding_locked.1 {
2148 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
2149 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
2150 if !announcement_event.is_empty() {
2151 assert_eq!(announcement_event.len(), 1);
2152 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
2153 //TODO: Test announcement_sigs re-sending
2154 } else { panic!("Unexpected event!"); }
2157 assert!(chan_msgs.0.is_none());
2160 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2161 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
2162 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2163 check_added_monitors!(node_b, 1);
2165 assert!(chan_msgs.1.is_none());
2167 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 {
2168 let commitment_update = chan_msgs.2.unwrap();
2169 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2170 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
2172 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.1 + pending_cell_htlc_claims.1);
2173 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.1 + pending_cell_htlc_fails.1);
2174 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2175 for update_add in commitment_update.update_add_htlcs {
2176 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
2178 for update_fulfill in commitment_update.update_fulfill_htlcs {
2179 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
2181 for update_fail in commitment_update.update_fail_htlcs {
2182 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
2185 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2186 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
2188 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
2189 check_added_monitors!(node_b, 1);
2190 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
2191 // No commitment_signed so get_event_msg's assert(len == 1) passes
2192 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
2193 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2194 check_added_monitors!(node_a, 1);
2197 assert!(chan_msgs.2.is_none());