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 let msg_events = self.node.get_and_clear_pending_msg_events();
308 if !msg_events.is_empty() {
309 panic!("Had excess message events on node {}: {:?}", self.logger.id, msg_events);
311 let events = self.node.get_and_clear_pending_events();
312 if !events.is_empty() {
313 panic!("Had excess events on node {}: {:?}", self.logger.id, events);
315 let added_monitors = self.chain_monitor.added_monitors.lock().unwrap().split_off(0);
316 if !added_monitors.is_empty() {
317 panic!("Had {} excess added monitors on node {}", added_monitors.len(), self.logger.id);
320 // Check that if we serialize the Router, we can deserialize it again.
322 let mut w = test_utils::TestVecWriter(Vec::new());
323 self.network_graph.write(&mut w).unwrap();
324 let network_graph_deser = <NetworkGraph<_>>::read(&mut io::Cursor::new(&w.0), self.logger).unwrap();
325 assert!(network_graph_deser == *self.network_graph);
326 let gossip_sync = P2PGossipSync::new(
327 &network_graph_deser, Some(self.chain_source), self.logger
329 let mut chan_progress = 0;
331 let orig_announcements = self.gossip_sync.get_next_channel_announcement(chan_progress);
332 let deserialized_announcements = gossip_sync.get_next_channel_announcement(chan_progress);
333 assert!(orig_announcements == deserialized_announcements);
334 chan_progress = match orig_announcements {
335 Some(announcement) => announcement.0.contents.short_channel_id + 1,
339 let mut node_progress = None;
341 let orig_announcements = self.gossip_sync.get_next_node_announcement(node_progress.as_ref());
342 let deserialized_announcements = gossip_sync.get_next_node_announcement(node_progress.as_ref());
343 assert!(orig_announcements == deserialized_announcements);
344 node_progress = match orig_announcements {
345 Some(announcement) => Some(announcement.contents.node_id),
351 // Check that if we serialize and then deserialize all our channel monitors we get the
352 // same set of outputs to watch for on chain as we have now. Note that if we write
353 // tests that fully close channels and remove the monitors at some point this may break.
354 let feeest = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
355 let mut deserialized_monitors = Vec::new();
357 for outpoint in self.chain_monitor.chain_monitor.list_monitors() {
358 let mut w = test_utils::TestVecWriter(Vec::new());
359 self.chain_monitor.chain_monitor.get_monitor(outpoint).unwrap().write(&mut w).unwrap();
360 let (_, deserialized_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
361 &mut io::Cursor::new(&w.0), self.keys_manager).unwrap();
362 deserialized_monitors.push(deserialized_monitor);
366 let broadcaster = test_utils::TestBroadcaster {
367 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone()),
368 blocks: Arc::new(Mutex::new(self.tx_broadcaster.blocks.lock().unwrap().clone())),
371 // Before using all the new monitors to check the watch outpoints, use the full set of
372 // them to ensure we can write and reload our ChannelManager.
374 let mut channel_monitors = HashMap::new();
375 for monitor in deserialized_monitors.iter_mut() {
376 channel_monitors.insert(monitor.get_funding_txo().0, monitor);
379 let mut w = test_utils::TestVecWriter(Vec::new());
380 self.node.write(&mut w).unwrap();
381 <(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 {
382 default_config: *self.node.get_current_default_configuration(),
383 keys_manager: self.keys_manager,
384 fee_estimator: &test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) },
385 chain_monitor: self.chain_monitor,
386 tx_broadcaster: &broadcaster,
387 logger: &self.logger,
392 let persister = test_utils::TestPersister::new();
393 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
394 let chain_monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &broadcaster, &self.logger, &feeest, &persister, &self.keys_manager);
395 for deserialized_monitor in deserialized_monitors.drain(..) {
396 if let Err(_) = chain_monitor.watch_channel(deserialized_monitor.get_funding_txo().0, deserialized_monitor) {
400 assert_eq!(*chain_source.watched_txn.lock().unwrap(), *self.chain_source.watched_txn.lock().unwrap());
401 assert_eq!(*chain_source.watched_outputs.lock().unwrap(), *self.chain_source.watched_outputs.lock().unwrap());
406 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) {
407 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001, a_flags, b_flags)
410 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) {
411 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);
412 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &channel_ready);
413 (announcement, as_update, bs_update, channel_id, tx)
417 /// Gets an RAA and CS which were sent in response to a commitment update
418 macro_rules! get_revoke_commit_msgs {
419 ($node: expr, $node_id: expr) => {
421 use $crate::util::events::MessageSendEvent;
422 let events = $node.node.get_and_clear_pending_msg_events();
423 assert_eq!(events.len(), 2);
425 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
426 assert_eq!(*node_id, $node_id);
429 _ => panic!("Unexpected event"),
431 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
432 assert_eq!(*node_id, $node_id);
433 assert!(updates.update_add_htlcs.is_empty());
434 assert!(updates.update_fulfill_htlcs.is_empty());
435 assert!(updates.update_fail_htlcs.is_empty());
436 assert!(updates.update_fail_malformed_htlcs.is_empty());
437 assert!(updates.update_fee.is_none());
438 updates.commitment_signed.clone()
440 _ => panic!("Unexpected event"),
446 /// Get an specific event message from the pending events queue.
448 macro_rules! get_event_msg {
449 ($node: expr, $event_type: path, $node_id: expr) => {
451 let events = $node.node.get_and_clear_pending_msg_events();
452 assert_eq!(events.len(), 1);
454 $event_type { ref node_id, ref msg } => {
455 assert_eq!(*node_id, $node_id);
458 _ => panic!("Unexpected event"),
464 /// Get an error message from the pending events queue.
466 macro_rules! get_err_msg {
467 ($node: expr, $node_id: expr) => {
469 let events = $node.node.get_and_clear_pending_msg_events();
470 assert_eq!(events.len(), 1);
472 $crate::util::events::MessageSendEvent::HandleError {
473 action: $crate::ln::msgs::ErrorAction::SendErrorMessage { ref msg }, ref node_id
475 assert_eq!(*node_id, $node_id);
478 _ => panic!("Unexpected event"),
484 /// Get a specific event from the pending events queue.
486 macro_rules! get_event {
487 ($node: expr, $event_type: path) => {
489 let mut events = $node.node.get_and_clear_pending_events();
490 assert_eq!(events.len(), 1);
491 let ev = events.pop().unwrap();
493 $event_type { .. } => {
496 _ => panic!("Unexpected event"),
503 /// Gets an UpdateHTLCs MessageSendEvent
504 macro_rules! get_htlc_update_msgs {
505 ($node: expr, $node_id: expr) => {
507 let events = $node.node.get_and_clear_pending_msg_events();
508 assert_eq!(events.len(), 1);
510 $crate::util::events::MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
511 assert_eq!(*node_id, $node_id);
514 _ => panic!("Unexpected event"),
521 macro_rules! get_channel_ref {
522 ($node: expr, $lock: ident, $channel_id: expr) => {
524 $lock = $node.node.channel_state.lock().unwrap();
525 $lock.by_id.get_mut(&$channel_id).unwrap()
531 macro_rules! get_feerate {
532 ($node: expr, $channel_id: expr) => {
535 let chan = get_channel_ref!($node, lock, $channel_id);
542 macro_rules! get_opt_anchors {
543 ($node: expr, $channel_id: expr) => {
546 let chan = get_channel_ref!($node, lock, $channel_id);
552 /// Returns a channel monitor given a channel id, making some naive assumptions
554 macro_rules! get_monitor {
555 ($node: expr, $channel_id: expr) => {
557 use bitcoin::hashes::Hash;
558 let mut monitor = None;
559 // Assume funding vout is either 0 or 1 blindly
561 if let Ok(mon) = $node.chain_monitor.chain_monitor.get_monitor(
562 $crate::chain::transaction::OutPoint {
563 txid: bitcoin::Txid::from_slice(&$channel_id[..]).unwrap(), index
575 /// Returns any local commitment transactions for the channel.
577 macro_rules! get_local_commitment_txn {
578 ($node: expr, $channel_id: expr) => {
580 $crate::get_monitor!($node, $channel_id).unsafe_get_latest_holder_commitment_txn(&$node.logger)
585 /// Check the error from attempting a payment.
587 macro_rules! unwrap_send_err {
588 ($res: expr, $all_failed: expr, $type: pat, $check: expr) => {
590 &Err(PaymentSendFailure::AllFailedRetrySafe(ref fails)) if $all_failed => {
591 assert_eq!(fails.len(), 1);
597 &Err(PaymentSendFailure::PartialFailure { ref results, .. }) if !$all_failed => {
598 assert_eq!(results.len(), 1);
600 Err($type) => { $check },
609 /// Check whether N channel monitor(s) have been added.
611 macro_rules! check_added_monitors {
612 ($node: expr, $count: expr) => {
614 let mut added_monitors = $node.chain_monitor.added_monitors.lock().unwrap();
615 assert_eq!(added_monitors.len(), $count);
616 added_monitors.clear();
621 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) {
622 let chan_id = *node.network_chan_count.borrow();
624 let events = node.node.get_and_clear_pending_events();
625 assert_eq!(events.len(), 1);
627 Event::FundingGenerationReady { ref temporary_channel_id, ref counterparty_node_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
628 assert_eq!(counterparty_node_id, expected_counterparty_node_id);
629 assert_eq!(*channel_value_satoshis, expected_chan_value);
630 assert_eq!(user_channel_id, expected_user_chan_id);
632 let tx = Transaction { version: chan_id as i32, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: vec![TxOut {
633 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
635 let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
636 (*temporary_channel_id, tx, funding_outpoint)
638 _ => panic!("Unexpected event"),
641 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 {
642 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, &node_b.node.get_our_node_id(), channel_value, 42);
643 assert_eq!(temporary_channel_id, expected_temporary_channel_id);
645 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_ok());
646 check_added_monitors!(node_a, 0);
648 let funding_created_msg = get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id());
649 assert_eq!(funding_created_msg.temporary_channel_id, expected_temporary_channel_id);
650 node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &funding_created_msg);
652 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
653 assert_eq!(added_monitors.len(), 1);
654 assert_eq!(added_monitors[0].0, funding_output);
655 added_monitors.clear();
658 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()));
660 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
661 assert_eq!(added_monitors.len(), 1);
662 assert_eq!(added_monitors[0].0, funding_output);
663 added_monitors.clear();
666 let events_4 = node_a.node.get_and_clear_pending_events();
667 assert_eq!(events_4.len(), 0);
669 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
670 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
671 node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
673 // Ensure that funding_transaction_generated is idempotent.
674 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_err());
675 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
676 check_added_monitors!(node_a, 0);
681 // Receiver must have been initialized with manually_accept_inbound_channels set to true.
682 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]) {
683 let initiator_channels = initiator.node.list_usable_channels().len();
684 let receiver_channels = receiver.node.list_usable_channels().len();
686 initiator.node.create_channel(receiver.node.get_our_node_id(), 100_000, 10_001, 42, initiator_config).unwrap();
687 let open_channel = get_event_msg!(initiator, MessageSendEvent::SendOpenChannel, receiver.node.get_our_node_id());
689 receiver.node.handle_open_channel(&initiator.node.get_our_node_id(), InitFeatures::known(), &open_channel);
690 let events = receiver.node.get_and_clear_pending_events();
691 assert_eq!(events.len(), 1);
693 Event::OpenChannelRequest { temporary_channel_id, .. } => {
694 receiver.node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &initiator.node.get_our_node_id(), 0).unwrap();
696 _ => panic!("Unexpected event"),
699 let accept_channel = get_event_msg!(receiver, MessageSendEvent::SendAcceptChannel, initiator.node.get_our_node_id());
700 assert_eq!(accept_channel.minimum_depth, 0);
701 initiator.node.handle_accept_channel(&receiver.node.get_our_node_id(), InitFeatures::known(), &accept_channel);
703 let (temporary_channel_id, tx, _) = create_funding_transaction(&initiator, &receiver.node.get_our_node_id(), 100_000, 42);
704 initiator.node.funding_transaction_generated(&temporary_channel_id, &receiver.node.get_our_node_id(), tx.clone()).unwrap();
705 let funding_created = get_event_msg!(initiator, MessageSendEvent::SendFundingCreated, receiver.node.get_our_node_id());
707 receiver.node.handle_funding_created(&initiator.node.get_our_node_id(), &funding_created);
708 check_added_monitors!(receiver, 1);
709 let bs_signed_locked = receiver.node.get_and_clear_pending_msg_events();
710 assert_eq!(bs_signed_locked.len(), 2);
711 let as_channel_ready;
712 match &bs_signed_locked[0] {
713 MessageSendEvent::SendFundingSigned { node_id, msg } => {
714 assert_eq!(*node_id, initiator.node.get_our_node_id());
715 initiator.node.handle_funding_signed(&receiver.node.get_our_node_id(), &msg);
716 check_added_monitors!(initiator, 1);
718 assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
719 assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0)[0], tx);
721 as_channel_ready = get_event_msg!(initiator, MessageSendEvent::SendChannelReady, receiver.node.get_our_node_id());
723 _ => panic!("Unexpected event"),
725 match &bs_signed_locked[1] {
726 MessageSendEvent::SendChannelReady { node_id, msg } => {
727 assert_eq!(*node_id, initiator.node.get_our_node_id());
728 initiator.node.handle_channel_ready(&receiver.node.get_our_node_id(), &msg);
730 _ => panic!("Unexpected event"),
733 receiver.node.handle_channel_ready(&initiator.node.get_our_node_id(), &as_channel_ready);
735 let as_channel_update = get_event_msg!(initiator, MessageSendEvent::SendChannelUpdate, receiver.node.get_our_node_id());
736 let bs_channel_update = get_event_msg!(receiver, MessageSendEvent::SendChannelUpdate, initiator.node.get_our_node_id());
738 initiator.node.handle_channel_update(&receiver.node.get_our_node_id(), &bs_channel_update);
739 receiver.node.handle_channel_update(&initiator.node.get_our_node_id(), &as_channel_update);
741 assert_eq!(initiator.node.list_usable_channels().len(), initiator_channels + 1);
742 assert_eq!(receiver.node.list_usable_channels().len(), receiver_channels + 1);
744 (tx, as_channel_ready.channel_id)
747 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 {
748 let create_chan_id = node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
749 let open_channel_msg = get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id());
750 assert_eq!(open_channel_msg.temporary_channel_id, create_chan_id);
751 node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), a_flags, &open_channel_msg);
752 let accept_channel_msg = get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id());
753 assert_eq!(accept_channel_msg.temporary_channel_id, create_chan_id);
754 node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), b_flags, &accept_channel_msg);
756 sign_funding_transaction(node_a, node_b, channel_value, create_chan_id)
759 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) {
760 confirm_transaction_at(node_conf, tx, conf_height);
761 connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
762 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()));
765 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]) {
767 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
768 assert_eq!(events_6.len(), 3);
769 let announcement_sigs_idx = if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[1] {
770 assert_eq!(*node_id, node_recv.node.get_our_node_id());
772 } else if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[2] {
773 assert_eq!(*node_id, node_recv.node.get_our_node_id());
775 } else { panic!("Unexpected event: {:?}", events_6[1]); };
776 ((match events_6[0] {
777 MessageSendEvent::SendChannelReady { ref node_id, ref msg } => {
778 channel_id = msg.channel_id.clone();
779 assert_eq!(*node_id, node_recv.node.get_our_node_id());
782 _ => panic!("Unexpected event"),
783 }, match events_6[announcement_sigs_idx] {
784 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
785 assert_eq!(*node_id, node_recv.node.get_our_node_id());
788 _ => panic!("Unexpected event"),
792 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]) {
793 let conf_height = core::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
794 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
795 confirm_transaction_at(node_a, tx, conf_height);
796 connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
797 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
800 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) {
801 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat, a_flags, b_flags);
802 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
806 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) {
807 node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
808 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
809 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
811 let events_7 = node_b.node.get_and_clear_pending_msg_events();
812 assert_eq!(events_7.len(), 1);
813 let (announcement, bs_update) = match events_7[0] {
814 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
817 _ => panic!("Unexpected event"),
820 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
821 let events_8 = node_a.node.get_and_clear_pending_msg_events();
822 assert_eq!(events_8.len(), 1);
823 let as_update = match events_8[0] {
824 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
825 assert!(*announcement == *msg);
826 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
827 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
830 _ => panic!("Unexpected event"),
833 *node_a.network_chan_count.borrow_mut() += 1;
835 ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
838 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) {
839 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001, a_flags, b_flags)
842 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) {
843 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat, a_flags, b_flags);
844 update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
845 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
848 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) {
849 let mut no_announce_cfg = test_default_channel_config();
850 no_announce_cfg.channel_handshake_config.announced_channel = false;
851 nodes[a].node.create_channel(nodes[b].node.get_our_node_id(), channel_value, push_msat, 42, Some(no_announce_cfg)).unwrap();
852 let open_channel = get_event_msg!(nodes[a], MessageSendEvent::SendOpenChannel, nodes[b].node.get_our_node_id());
853 nodes[b].node.handle_open_channel(&nodes[a].node.get_our_node_id(), a_flags, &open_channel);
854 let accept_channel = get_event_msg!(nodes[b], MessageSendEvent::SendAcceptChannel, nodes[a].node.get_our_node_id());
855 nodes[a].node.handle_accept_channel(&nodes[b].node.get_our_node_id(), b_flags, &accept_channel);
857 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[a], &nodes[b].node.get_our_node_id(), channel_value, 42);
858 nodes[a].node.funding_transaction_generated(&temporary_channel_id, &nodes[b].node.get_our_node_id(), tx.clone()).unwrap();
859 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()));
860 check_added_monitors!(nodes[b], 1);
862 let cs_funding_signed = get_event_msg!(nodes[b], MessageSendEvent::SendFundingSigned, nodes[a].node.get_our_node_id());
863 nodes[a].node.handle_funding_signed(&nodes[b].node.get_our_node_id(), &cs_funding_signed);
864 check_added_monitors!(nodes[a], 1);
866 let conf_height = core::cmp::max(nodes[a].best_block_info().1 + 1, nodes[b].best_block_info().1 + 1);
867 confirm_transaction_at(&nodes[a], &tx, conf_height);
868 connect_blocks(&nodes[a], CHAN_CONFIRM_DEPTH - 1);
869 confirm_transaction_at(&nodes[b], &tx, conf_height);
870 connect_blocks(&nodes[b], CHAN_CONFIRM_DEPTH - 1);
871 let as_channel_ready = get_event_msg!(nodes[a], MessageSendEvent::SendChannelReady, nodes[b].node.get_our_node_id());
872 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()));
873 let as_update = get_event_msg!(nodes[a], MessageSendEvent::SendChannelUpdate, nodes[b].node.get_our_node_id());
874 nodes[b].node.handle_channel_ready(&nodes[a].node.get_our_node_id(), &as_channel_ready);
875 let bs_update = get_event_msg!(nodes[b], MessageSendEvent::SendChannelUpdate, nodes[a].node.get_our_node_id());
877 nodes[a].node.handle_channel_update(&nodes[b].node.get_our_node_id(), &bs_update);
878 nodes[b].node.handle_channel_update(&nodes[a].node.get_our_node_id(), &as_update);
880 let mut found_a = false;
881 for chan in nodes[a].node.list_usable_channels() {
882 if chan.channel_id == as_channel_ready.channel_id {
885 assert!(!chan.is_public);
890 let mut found_b = false;
891 for chan in nodes[b].node.list_usable_channels() {
892 if chan.channel_id == as_channel_ready.channel_id {
895 assert!(!chan.is_public);
900 (as_channel_ready, tx)
903 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) {
904 nodes[a].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
905 let a_events = nodes[a].node.get_and_clear_pending_msg_events();
906 assert!(a_events.len() >= 2);
908 // ann should be re-generated by broadcast_node_announcement - check that we have it.
909 let mut found_ann_1 = false;
910 for event in a_events.iter() {
912 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
913 if msg == ann { found_ann_1 = true; }
915 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
916 _ => panic!("Unexpected event {:?}", event),
919 assert!(found_ann_1);
921 let a_node_announcement = match a_events.last().unwrap() {
922 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
925 _ => panic!("Unexpected event"),
928 nodes[b].node.broadcast_node_announcement([1, 1, 1], [1; 32], Vec::new());
929 let b_events = nodes[b].node.get_and_clear_pending_msg_events();
930 assert!(b_events.len() >= 2);
932 // ann should be re-generated by broadcast_node_announcement - check that we have it.
933 let mut found_ann_2 = false;
934 for event in b_events.iter() {
936 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
937 if msg == ann { found_ann_2 = true; }
939 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
940 _ => panic!("Unexpected event"),
943 assert!(found_ann_2);
945 let b_node_announcement = match b_events.last().unwrap() {
946 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
949 _ => panic!("Unexpected event"),
953 assert!(node.gossip_sync.handle_channel_announcement(ann).unwrap());
954 node.gossip_sync.handle_channel_update(upd_1).unwrap();
955 node.gossip_sync.handle_channel_update(upd_2).unwrap();
956 node.gossip_sync.handle_node_announcement(&a_node_announcement).unwrap();
957 node.gossip_sync.handle_node_announcement(&b_node_announcement).unwrap();
959 // Note that channel_updates are also delivered to ChannelManagers to ensure we have
960 // forwarding info for local channels even if its not accepted in the network graph.
961 node.node.handle_channel_update(&nodes[a].node.get_our_node_id(), &upd_1);
962 node.node.handle_channel_update(&nodes[b].node.get_our_node_id(), &upd_2);
967 macro_rules! check_spends {
968 ($tx: expr, $($spends_txn: expr),*) => {
971 for outp in $spends_txn.output.iter() {
972 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Input tx output didn't meet dust limit");
975 for outp in $tx.output.iter() {
976 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Spending tx output didn't meet dust limit");
978 let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
980 if out_point.txid == $spends_txn.txid() {
981 return $spends_txn.output.get(out_point.vout as usize).cloned()
986 let mut total_value_in = 0;
987 for input in $tx.input.iter() {
988 total_value_in += get_output(&input.previous_output).unwrap().value;
990 let mut total_value_out = 0;
991 for output in $tx.output.iter() {
992 total_value_out += output.value;
994 let min_fee = ($tx.weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
995 // Input amount - output amount = fee, so check that out + min_fee is smaller than input
996 assert!(total_value_out + min_fee <= total_value_in);
997 $tx.verify(get_output).unwrap();
1002 macro_rules! get_closing_signed_broadcast {
1003 ($node: expr, $dest_pubkey: expr) => {
1005 let events = $node.get_and_clear_pending_msg_events();
1006 assert!(events.len() == 1 || events.len() == 2);
1007 (match events[events.len() - 1] {
1008 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1009 assert_eq!(msg.contents.flags & 2, 2);
1012 _ => panic!("Unexpected event"),
1013 }, if events.len() == 2 {
1015 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1016 assert_eq!(*node_id, $dest_pubkey);
1019 _ => panic!("Unexpected event"),
1027 macro_rules! check_warn_msg {
1028 ($node: expr, $recipient_node_id: expr, $chan_id: expr) => {{
1029 let msg_events = $node.node.get_and_clear_pending_msg_events();
1030 assert_eq!(msg_events.len(), 1);
1031 match msg_events[0] {
1032 MessageSendEvent::HandleError { action: ErrorAction::SendWarningMessage { ref msg, log_level: _ }, node_id } => {
1033 assert_eq!(node_id, $recipient_node_id);
1034 assert_eq!(msg.channel_id, $chan_id);
1037 _ => panic!("Unexpected event"),
1042 /// Check that a channel's closing channel update has been broadcasted, and optionally
1043 /// check whether an error message event has occurred.
1045 macro_rules! check_closed_broadcast {
1046 ($node: expr, $with_error_msg: expr) => {{
1047 use $crate::util::events::MessageSendEvent;
1048 use $crate::ln::msgs::ErrorAction;
1050 let msg_events = $node.node.get_and_clear_pending_msg_events();
1051 assert_eq!(msg_events.len(), if $with_error_msg { 2 } else { 1 });
1052 match msg_events[0] {
1053 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1054 assert_eq!(msg.contents.flags & 2, 2);
1056 _ => panic!("Unexpected event"),
1058 if $with_error_msg {
1059 match msg_events[1] {
1060 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
1061 // TODO: Check node_id
1064 _ => panic!("Unexpected event"),
1070 /// Check that a channel's closing channel events has been issued
1072 macro_rules! check_closed_event {
1073 ($node: expr, $events: expr, $reason: expr) => {
1074 check_closed_event!($node, $events, $reason, false);
1076 ($node: expr, $events: expr, $reason: expr, $is_check_discard_funding: expr) => {{
1077 use $crate::util::events::Event;
1079 let events = $node.node.get_and_clear_pending_events();
1080 assert_eq!(events.len(), $events);
1081 let expected_reason = $reason;
1082 let mut issues_discard_funding = false;
1083 for event in events {
1085 Event::ChannelClosed { ref reason, .. } => {
1086 assert_eq!(*reason, expected_reason);
1088 Event::DiscardFunding { .. } => {
1089 issues_discard_funding = true;
1091 _ => panic!("Unexpected event"),
1094 assert_eq!($is_check_discard_funding, issues_discard_funding);
1098 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) {
1099 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) };
1100 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) };
1103 node_a.close_channel(channel_id, &node_b.get_our_node_id()).unwrap();
1104 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()));
1106 let events_1 = node_b.get_and_clear_pending_msg_events();
1107 assert!(events_1.len() >= 1);
1108 let shutdown_b = match events_1[0] {
1109 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
1110 assert_eq!(node_id, &node_a.get_our_node_id());
1113 _ => panic!("Unexpected event"),
1116 let closing_signed_b = if !close_inbound_first {
1117 assert_eq!(events_1.len(), 1);
1120 Some(match events_1[1] {
1121 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1122 assert_eq!(node_id, &node_a.get_our_node_id());
1125 _ => panic!("Unexpected event"),
1129 node_a.handle_shutdown(&node_b.get_our_node_id(), &InitFeatures::known(), &shutdown_b);
1130 let (as_update, bs_update) = if close_inbound_first {
1131 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
1132 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1134 node_b.handle_closing_signed(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id()));
1135 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1136 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1137 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1139 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1140 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1141 assert!(none_a.is_none());
1142 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1143 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1144 (as_update, bs_update)
1146 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
1148 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
1149 node_a.handle_closing_signed(&node_b.get_our_node_id(), &get_event_msg!(struct_b, MessageSendEvent::SendClosingSigned, node_a.get_our_node_id()));
1151 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1152 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1153 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1155 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
1156 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1157 assert!(none_b.is_none());
1158 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1159 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1160 (as_update, bs_update)
1162 assert_eq!(tx_a, tx_b);
1163 check_spends!(tx_a, funding_tx);
1165 (as_update, bs_update, tx_a)
1168 pub struct SendEvent {
1169 pub node_id: PublicKey,
1170 pub msgs: Vec<msgs::UpdateAddHTLC>,
1171 pub commitment_msg: msgs::CommitmentSigned,
1174 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
1175 assert!(updates.update_fulfill_htlcs.is_empty());
1176 assert!(updates.update_fail_htlcs.is_empty());
1177 assert!(updates.update_fail_malformed_htlcs.is_empty());
1178 assert!(updates.update_fee.is_none());
1179 SendEvent { node_id: node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
1182 pub fn from_event(event: MessageSendEvent) -> SendEvent {
1184 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
1185 _ => panic!("Unexpected event type!"),
1189 pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
1190 let mut events = node.node.get_and_clear_pending_msg_events();
1191 assert_eq!(events.len(), 1);
1192 SendEvent::from_event(events.pop().unwrap())
1197 /// Performs the "commitment signed dance" - the series of message exchanges which occur after a
1198 /// commitment update.
1199 macro_rules! commitment_signed_dance {
1200 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
1202 check_added_monitors!($node_a, 0);
1203 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1204 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1205 check_added_monitors!($node_a, 1);
1206 commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
1209 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
1211 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
1212 check_added_monitors!($node_b, 0);
1213 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
1214 $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack);
1215 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
1216 check_added_monitors!($node_b, 1);
1217 $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed);
1218 let (bs_revoke_and_ack, extra_msg_option) = {
1219 let events = $node_b.node.get_and_clear_pending_msg_events();
1220 assert!(events.len() <= 2);
1222 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1223 assert_eq!(*node_id, $node_a.node.get_our_node_id());
1226 _ => panic!("Unexpected event"),
1227 }, events.get(1).map(|e| e.clone()))
1229 check_added_monitors!($node_b, 1);
1230 if $fail_backwards {
1231 assert!($node_a.node.get_and_clear_pending_events().is_empty());
1232 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1234 (extra_msg_option, bs_revoke_and_ack)
1237 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
1239 check_added_monitors!($node_a, 0);
1240 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1241 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1242 check_added_monitors!($node_a, 1);
1243 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
1244 assert!(extra_msg_option.is_none());
1248 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
1250 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
1251 $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1252 check_added_monitors!($node_a, 1);
1256 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
1258 assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
1261 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
1263 commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
1264 if $fail_backwards {
1265 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 }]);
1266 check_added_monitors!($node_a, 1);
1268 let channel_state = $node_a.node.channel_state.lock().unwrap();
1269 assert_eq!(channel_state.pending_msg_events.len(), 1);
1270 if let MessageSendEvent::UpdateHTLCs { ref node_id, .. } = channel_state.pending_msg_events[0] {
1271 assert_ne!(*node_id, $node_b.node.get_our_node_id());
1272 } else { panic!("Unexpected event"); }
1274 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1280 /// Get a payment preimage and hash.
1282 macro_rules! get_payment_preimage_hash {
1283 ($dest_node: expr) => {
1285 get_payment_preimage_hash!($dest_node, None)
1288 ($dest_node: expr, $min_value_msat: expr) => {
1290 use bitcoin::hashes::Hash as _;
1291 let mut payment_count = $dest_node.network_payment_count.borrow_mut();
1292 let payment_preimage = $crate::ln::PaymentPreimage([*payment_count; 32]);
1293 *payment_count += 1;
1294 let payment_hash = $crate::ln::PaymentHash(
1295 bitcoin::hashes::sha256::Hash::hash(&payment_preimage.0[..]).into_inner());
1296 let payment_secret = $dest_node.node.create_inbound_payment_for_hash(payment_hash, $min_value_msat, 7200).unwrap();
1297 (payment_preimage, payment_hash, payment_secret)
1303 macro_rules! get_route {
1304 ($send_node: expr, $payment_params: expr, $recv_value: expr, $cltv: expr) => {{
1305 use $crate::chain::keysinterface::KeysInterface;
1306 let scorer = $crate::util::test_utils::TestScorer::with_penalty(0);
1307 let keys_manager = $crate::util::test_utils::TestKeysInterface::new(&[0u8; 32], bitcoin::network::constants::Network::Testnet);
1308 let random_seed_bytes = keys_manager.get_secure_random_bytes();
1309 $crate::routing::router::get_route(
1310 &$send_node.node.get_our_node_id(), &$payment_params, &$send_node.network_graph.read_only(),
1311 Some(&$send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1312 $recv_value, $cltv, $send_node.logger, &scorer, &random_seed_bytes
1319 macro_rules! get_route_and_payment_hash {
1320 ($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
1321 let payment_params = $crate::routing::router::PaymentParameters::from_node_id($recv_node.node.get_our_node_id())
1322 .with_features($crate::ln::features::InvoiceFeatures::known());
1323 $crate::get_route_and_payment_hash!($send_node, $recv_node, payment_params, $recv_value, TEST_FINAL_CLTV)
1325 ($send_node: expr, $recv_node: expr, $payment_params: expr, $recv_value: expr, $cltv: expr) => {{
1326 let (payment_preimage, payment_hash, payment_secret) = $crate::get_payment_preimage_hash!($recv_node, Some($recv_value));
1327 let route = $crate::get_route!($send_node, $payment_params, $recv_value, $cltv);
1328 (route.unwrap(), payment_hash, payment_preimage, payment_secret)
1333 macro_rules! expect_pending_htlcs_forwardable_conditions {
1334 ($node: expr, $expected_failures: expr) => {{
1335 let expected_failures = $expected_failures;
1336 let events = $node.node.get_and_clear_pending_events();
1338 $crate::util::events::Event::PendingHTLCsForwardable { .. } => { },
1339 _ => panic!("Unexpected event"),
1342 let count = expected_failures.len() + 1;
1343 assert_eq!(events.len(), count);
1345 if expected_failures.len() > 0 {
1346 expect_htlc_handling_failed_destinations!(events, expected_failures)
1352 macro_rules! expect_htlc_handling_failed_destinations {
1353 ($events: expr, $expected_failures: expr) => {{
1354 for event in $events {
1356 $crate::util::events::Event::PendingHTLCsForwardable { .. } => { },
1357 $crate::util::events::Event::HTLCHandlingFailed { ref failed_next_destination, .. } => {
1358 assert!($expected_failures.contains(&failed_next_destination))
1360 _ => panic!("Unexpected destination"),
1367 /// Clears (and ignores) a PendingHTLCsForwardable event
1368 macro_rules! expect_pending_htlcs_forwardable_ignore {
1370 expect_pending_htlcs_forwardable_conditions!($node, vec![]);
1375 /// Clears (and ignores) PendingHTLCsForwardable and HTLCHandlingFailed events
1376 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore {
1377 ($node: expr, $expected_failures: expr) => {{
1378 expect_pending_htlcs_forwardable_conditions!($node, $expected_failures);
1383 /// Handles a PendingHTLCsForwardable event
1384 macro_rules! expect_pending_htlcs_forwardable {
1386 expect_pending_htlcs_forwardable_ignore!($node);
1387 $node.node.process_pending_htlc_forwards();
1389 // Ensure process_pending_htlc_forwards is idempotent.
1390 $node.node.process_pending_htlc_forwards();
1395 /// Handles a PendingHTLCsForwardable and HTLCHandlingFailed event
1396 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed {
1397 ($node: expr, $expected_failures: expr) => {{
1398 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!($node, $expected_failures);
1399 $node.node.process_pending_htlc_forwards();
1401 // Ensure process_pending_htlc_forwards is idempotent.
1402 $node.node.process_pending_htlc_forwards();
1407 macro_rules! expect_pending_htlcs_forwardable_from_events {
1408 ($node: expr, $events: expr, $ignore: expr) => {{
1409 assert_eq!($events.len(), 1);
1411 Event::PendingHTLCsForwardable { .. } => { },
1412 _ => panic!("Unexpected event"),
1415 $node.node.process_pending_htlc_forwards();
1417 // Ensure process_pending_htlc_forwards is idempotent.
1418 $node.node.process_pending_htlc_forwards();
1424 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1425 macro_rules! expect_payment_received {
1426 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr) => {
1427 expect_payment_received!($node, $expected_payment_hash, $expected_payment_secret, $expected_recv_value, None)
1429 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr, $expected_payment_preimage: expr) => {
1430 let events = $node.node.get_and_clear_pending_events();
1431 assert_eq!(events.len(), 1);
1433 $crate::util::events::Event::PaymentReceived { ref payment_hash, ref purpose, amount_msat } => {
1434 assert_eq!($expected_payment_hash, *payment_hash);
1435 assert_eq!($expected_recv_value, amount_msat);
1437 $crate::util::events::PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1438 assert_eq!(&$expected_payment_preimage, payment_preimage);
1439 assert_eq!($expected_payment_secret, *payment_secret);
1444 _ => panic!("Unexpected event"),
1450 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1451 macro_rules! expect_payment_claimed {
1452 ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
1453 let events = $node.node.get_and_clear_pending_events();
1454 assert_eq!(events.len(), 1);
1456 $crate::util::events::Event::PaymentClaimed { ref payment_hash, amount_msat, .. } => {
1457 assert_eq!($expected_payment_hash, *payment_hash);
1458 assert_eq!($expected_recv_value, amount_msat);
1460 _ => panic!("Unexpected event"),
1467 macro_rules! expect_payment_sent_without_paths {
1468 ($node: expr, $expected_payment_preimage: expr) => {
1469 expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, false);
1471 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1472 expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, false);
1477 macro_rules! expect_payment_sent {
1478 ($node: expr, $expected_payment_preimage: expr) => {
1479 $crate::expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, true);
1481 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1482 $crate::expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, true);
1484 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr, $expect_paths: expr) => { {
1485 use bitcoin::hashes::Hash as _;
1486 let events = $node.node.get_and_clear_pending_events();
1487 let expected_payment_hash = $crate::ln::PaymentHash(
1488 bitcoin::hashes::sha256::Hash::hash(&$expected_payment_preimage.0).into_inner());
1490 assert!(events.len() > 1);
1492 assert_eq!(events.len(), 1);
1494 let expected_payment_id = match events[0] {
1495 $crate::util::events::Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
1496 assert_eq!($expected_payment_preimage, *payment_preimage);
1497 assert_eq!(expected_payment_hash, *payment_hash);
1498 assert!(fee_paid_msat.is_some());
1499 if $expected_fee_msat_opt.is_some() {
1500 assert_eq!(*fee_paid_msat, $expected_fee_msat_opt);
1504 _ => panic!("Unexpected event"),
1507 for i in 1..events.len() {
1509 $crate::util::events::Event::PaymentPathSuccessful { payment_id, payment_hash, .. } => {
1510 assert_eq!(payment_id, expected_payment_id);
1511 assert_eq!(payment_hash, Some(expected_payment_hash));
1513 _ => panic!("Unexpected event"),
1522 macro_rules! expect_payment_path_successful {
1524 let events = $node.node.get_and_clear_pending_events();
1525 assert_eq!(events.len(), 1);
1527 $crate::util::events::Event::PaymentPathSuccessful { .. } => {},
1528 _ => panic!("Unexpected event"),
1533 macro_rules! expect_payment_forwarded {
1534 ($node: expr, $prev_node: expr, $next_node: expr, $expected_fee: expr, $upstream_force_closed: expr, $downstream_force_closed: expr) => {
1535 let events = $node.node.get_and_clear_pending_events();
1536 assert_eq!(events.len(), 1);
1538 Event::PaymentForwarded { fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id } => {
1539 assert_eq!(fee_earned_msat, $expected_fee);
1540 if fee_earned_msat.is_some() {
1541 // Is the event prev_channel_id in one of the channels between the two nodes?
1542 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()));
1544 // We check for force closures since a force closed channel is removed from the
1545 // node's channel list
1546 if !$downstream_force_closed {
1547 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()));
1549 assert_eq!(claim_from_onchain_tx, $upstream_force_closed);
1551 _ => panic!("Unexpected event"),
1556 pub struct PaymentFailedConditions<'a> {
1557 pub(crate) expected_htlc_error_data: Option<(u16, &'a [u8])>,
1558 pub(crate) expected_blamed_scid: Option<u64>,
1559 pub(crate) expected_blamed_chan_closed: Option<bool>,
1560 pub(crate) expected_mpp_parts_remain: bool,
1563 impl<'a> PaymentFailedConditions<'a> {
1564 pub fn new() -> Self {
1566 expected_htlc_error_data: None,
1567 expected_blamed_scid: None,
1568 expected_blamed_chan_closed: None,
1569 expected_mpp_parts_remain: false,
1572 pub fn mpp_parts_remain(mut self) -> Self {
1573 self.expected_mpp_parts_remain = true;
1576 pub fn blamed_scid(mut self, scid: u64) -> Self {
1577 self.expected_blamed_scid = Some(scid);
1580 pub fn blamed_chan_closed(mut self, closed: bool) -> Self {
1581 self.expected_blamed_chan_closed = Some(closed);
1584 pub fn expected_htlc_error_data(mut self, code: u16, data: &'a [u8]) -> Self {
1585 self.expected_htlc_error_data = Some((code, data));
1591 macro_rules! expect_payment_failed_with_update {
1592 ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr, $scid: expr, $chan_closed: expr) => {
1593 $crate::ln::functional_test_utils::expect_payment_failed_conditions(
1594 &$node, $expected_payment_hash, $payment_failed_permanently,
1595 $crate::ln::functional_test_utils::PaymentFailedConditions::new()
1596 .blamed_scid($scid).blamed_chan_closed($chan_closed));
1601 macro_rules! expect_payment_failed {
1602 ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
1603 #[allow(unused_mut)]
1604 let mut conditions = $crate::ln::functional_test_utils::PaymentFailedConditions::new();
1606 conditions = conditions.expected_htlc_error_data($expected_error_code, &$expected_error_data);
1608 $crate::ln::functional_test_utils::expect_payment_failed_conditions(&$node, $expected_payment_hash, $payment_failed_permanently, conditions);
1612 pub fn expect_payment_failed_conditions_event<'a, 'b, 'c, 'd, 'e>(
1613 node: &'a Node<'b, 'c, 'd>, payment_failed_event: Event, expected_payment_hash: PaymentHash,
1614 expected_payment_failed_permanently: bool, conditions: PaymentFailedConditions<'e>
1616 let expected_payment_id = match payment_failed_event {
1617 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, path, retry, payment_id, network_update, short_channel_id,
1621 error_data, .. } => {
1622 assert_eq!(payment_hash, expected_payment_hash, "unexpected payment_hash");
1623 assert_eq!(payment_failed_permanently, expected_payment_failed_permanently, "unexpected payment_failed_permanently value");
1624 assert!(retry.is_some(), "expected retry.is_some()");
1625 assert_eq!(retry.as_ref().unwrap().final_value_msat, path.last().unwrap().fee_msat, "Retry amount should match last hop in path");
1626 assert_eq!(retry.as_ref().unwrap().payment_params.payee_pubkey, path.last().unwrap().pubkey, "Retry payee node_id should match last hop in path");
1627 if let Some(scid) = short_channel_id {
1628 assert!(retry.as_ref().unwrap().payment_params.previously_failed_channels.contains(&scid));
1633 assert!(error_code.is_some(), "expected error_code.is_some() = true");
1634 assert!(error_data.is_some(), "expected error_data.is_some() = true");
1635 if let Some((code, data)) = conditions.expected_htlc_error_data {
1636 assert_eq!(error_code.unwrap(), code, "unexpected error code");
1637 assert_eq!(&error_data.as_ref().unwrap()[..], data, "unexpected error data");
1641 if let Some(chan_closed) = conditions.expected_blamed_chan_closed {
1642 match network_update {
1643 Some(NetworkUpdate::ChannelUpdateMessage { ref msg }) if !chan_closed => {
1644 if let Some(scid) = conditions.expected_blamed_scid {
1645 assert_eq!(msg.contents.short_channel_id, scid);
1647 const CHAN_DISABLED_FLAG: u8 = 2;
1648 assert_eq!(msg.contents.flags & CHAN_DISABLED_FLAG, 0);
1650 Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent }) if chan_closed => {
1651 if let Some(scid) = conditions.expected_blamed_scid {
1652 assert_eq!(short_channel_id, scid);
1654 assert!(is_permanent);
1656 Some(_) => panic!("Unexpected update type"),
1657 None => panic!("Expected update"),
1663 _ => panic!("Unexpected event"),
1665 if !conditions.expected_mpp_parts_remain {
1666 node.node.abandon_payment(expected_payment_id);
1667 let events = node.node.get_and_clear_pending_events();
1668 assert_eq!(events.len(), 1);
1670 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
1671 assert_eq!(*payment_hash, expected_payment_hash, "unexpected second payment_hash");
1672 assert_eq!(*payment_id, expected_payment_id);
1674 _ => panic!("Unexpected second event"),
1679 pub fn expect_payment_failed_conditions<'a, 'b, 'c, 'd, 'e>(
1680 node: &'a Node<'b, 'c, 'd>, expected_payment_hash: PaymentHash, expected_payment_failed_permanently: bool,
1681 conditions: PaymentFailedConditions<'e>
1683 let mut events = node.node.get_and_clear_pending_events();
1684 assert_eq!(events.len(), 1);
1685 expect_payment_failed_conditions_event(node, events.pop().unwrap(), expected_payment_hash, expected_payment_failed_permanently, conditions);
1688 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 {
1689 let payment_id = origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
1690 check_added_monitors!(origin_node, expected_paths.len());
1691 pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
1695 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>) {
1696 let mut payment_event = SendEvent::from_event(ev);
1697 let mut prev_node = origin_node;
1699 for (idx, &node) in expected_path.iter().enumerate() {
1700 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
1702 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
1703 check_added_monitors!(node, 0);
1704 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
1706 expect_pending_htlcs_forwardable!(node);
1708 if idx == expected_path.len() - 1 && clear_recipient_events {
1709 let events_2 = node.node.get_and_clear_pending_events();
1710 if payment_received_expected {
1711 assert_eq!(events_2.len(), 1);
1713 Event::PaymentReceived { ref payment_hash, ref purpose, amount_msat } => {
1714 assert_eq!(our_payment_hash, *payment_hash);
1716 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1717 assert_eq!(expected_preimage, *payment_preimage);
1718 assert_eq!(our_payment_secret.unwrap(), *payment_secret);
1720 PaymentPurpose::SpontaneousPayment(payment_preimage) => {
1721 assert_eq!(expected_preimage.unwrap(), *payment_preimage);
1722 assert!(our_payment_secret.is_none());
1725 assert_eq!(amount_msat, recv_value);
1727 _ => panic!("Unexpected event"),
1730 assert!(events_2.is_empty());
1732 } else if idx != expected_path.len() - 1 {
1733 let mut events_2 = node.node.get_and_clear_pending_msg_events();
1734 assert_eq!(events_2.len(), 1);
1735 check_added_monitors!(node, 1);
1736 payment_event = SendEvent::from_event(events_2.remove(0));
1737 assert_eq!(payment_event.msgs.len(), 1);
1744 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>) {
1745 do_pass_along_path(origin_node, expected_path, recv_value, our_payment_hash, our_payment_secret, ev, payment_received_expected, true, expected_preimage);
1748 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) {
1749 let mut events = origin_node.node.get_and_clear_pending_msg_events();
1750 assert_eq!(events.len(), expected_route.len());
1751 for (path_idx, (ev, expected_path)) in events.drain(..).zip(expected_route.iter()).enumerate() {
1752 // Once we've gotten through all the HTLCs, the last one should result in a
1753 // PaymentReceived (but each previous one should not!), .
1754 let expect_payment = path_idx == expected_route.len() - 1;
1755 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), Some(our_payment_secret), ev, expect_payment, None);
1759 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) {
1760 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
1761 let payment_id = send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, our_payment_secret);
1762 (our_payment_preimage, our_payment_hash, our_payment_secret, payment_id)
1765 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 {
1766 for path in expected_paths.iter() {
1767 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1769 expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
1771 let claim_event = expected_paths[0].last().unwrap().node.get_and_clear_pending_events();
1772 assert_eq!(claim_event.len(), 1);
1773 match claim_event[0] {
1774 Event::PaymentClaimed { purpose: PaymentPurpose::SpontaneousPayment(preimage), .. }|
1775 Event::PaymentClaimed { purpose: PaymentPurpose::InvoicePayment { payment_preimage: Some(preimage), ..}, .. } =>
1776 assert_eq!(preimage, our_payment_preimage),
1777 Event::PaymentClaimed { purpose: PaymentPurpose::InvoicePayment { .. }, payment_hash, .. } =>
1778 assert_eq!(&payment_hash.0, &Sha256::hash(&our_payment_preimage.0)[..]),
1782 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1784 let mut expected_total_fee_msat = 0;
1786 macro_rules! msgs_from_ev {
1789 &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 } } => {
1790 assert!(update_add_htlcs.is_empty());
1791 assert_eq!(update_fulfill_htlcs.len(), 1);
1792 assert!(update_fail_htlcs.is_empty());
1793 assert!(update_fail_malformed_htlcs.is_empty());
1794 assert!(update_fee.is_none());
1795 ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
1797 _ => panic!("Unexpected event"),
1801 let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1802 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1803 assert_eq!(events.len(), expected_paths.len());
1804 for ev in events.iter() {
1805 per_path_msgs.push(msgs_from_ev!(ev));
1808 for (expected_route, (path_msgs, next_hop)) in expected_paths.iter().zip(per_path_msgs.drain(..)) {
1809 let mut next_msgs = Some(path_msgs);
1810 let mut expected_next_node = next_hop;
1812 macro_rules! last_update_fulfill_dance {
1813 ($node: expr, $prev_node: expr) => {
1815 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1816 check_added_monitors!($node, 0);
1817 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1818 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1822 macro_rules! mid_update_fulfill_dance {
1823 ($node: expr, $prev_node: expr, $next_node: expr, $new_msgs: expr) => {
1825 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1827 let channel_state = $node.node.channel_state.lock().unwrap();
1828 let channel = channel_state
1829 .by_id.get(&next_msgs.as_ref().unwrap().0.channel_id).unwrap();
1830 if let Some(prev_config) = channel.prev_config() {
1831 prev_config.forwarding_fee_base_msat
1833 channel.config().forwarding_fee_base_msat
1836 expect_payment_forwarded!($node, $next_node, $prev_node, Some(fee as u64), false, false);
1837 expected_total_fee_msat += fee as u64;
1838 check_added_monitors!($node, 1);
1839 let new_next_msgs = if $new_msgs {
1840 let events = $node.node.get_and_clear_pending_msg_events();
1841 assert_eq!(events.len(), 1);
1842 let (res, nexthop) = msgs_from_ev!(&events[0]);
1843 expected_next_node = nexthop;
1846 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1849 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1850 next_msgs = new_next_msgs;
1855 let mut prev_node = expected_route.last().unwrap();
1856 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
1857 assert_eq!(expected_next_node, node.node.get_our_node_id());
1858 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
1859 if next_msgs.is_some() {
1860 // Since we are traversing in reverse, next_node is actually the previous node
1861 let next_node: &Node;
1862 if idx == expected_route.len() - 1 {
1863 next_node = origin_node;
1865 next_node = expected_route[expected_route.len() - 1 - idx - 1];
1867 mid_update_fulfill_dance!(node, prev_node, next_node, update_next_msgs);
1869 assert!(!update_next_msgs);
1870 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
1872 if !skip_last && idx == expected_route.len() - 1 {
1873 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1880 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
1884 // Ensure that claim_funds is idempotent.
1885 expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
1886 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
1887 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
1889 expected_total_fee_msat
1891 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) {
1892 let expected_total_fee_msat = do_claim_payment_along_route(origin_node, expected_paths, skip_last, our_payment_preimage);
1894 expect_payment_sent!(origin_node, our_payment_preimage, Some(expected_total_fee_msat));
1898 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage) {
1899 claim_payment_along_route(origin_node, &[expected_route], false, our_payment_preimage);
1902 pub const TEST_FINAL_CLTV: u32 = 70;
1904 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) {
1905 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id())
1906 .with_features(InvoiceFeatures::known());
1907 let route = get_route!(origin_node, payment_params, recv_value, TEST_FINAL_CLTV).unwrap();
1908 assert_eq!(route.paths.len(), 1);
1909 assert_eq!(route.paths[0].len(), expected_route.len());
1910 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1911 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1914 let res = send_along_route(origin_node, route, expected_route, recv_value);
1915 (res.0, res.1, res.2)
1918 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
1919 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id())
1920 .with_features(InvoiceFeatures::known());
1921 let network_graph = origin_node.network_graph.read_only();
1922 let scorer = test_utils::TestScorer::with_penalty(0);
1923 let seed = [0u8; 32];
1924 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
1925 let random_seed_bytes = keys_manager.get_secure_random_bytes();
1926 let route = get_route(
1927 &origin_node.node.get_our_node_id(), &payment_params, &network_graph,
1928 None, recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer, &random_seed_bytes).unwrap();
1929 assert_eq!(route.paths.len(), 1);
1930 assert_eq!(route.paths[0].len(), expected_route.len());
1931 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1932 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1935 let (_, our_payment_hash, our_payment_preimage) = get_payment_preimage_hash!(expected_route.last().unwrap());
1936 unwrap_send_err!(origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_preimage)), true, APIError::ChannelUnavailable { ref err },
1937 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
1940 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
1941 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
1942 claim_payment(&origin, expected_route, our_payment_preimage);
1945 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) {
1946 for path in expected_paths.iter() {
1947 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1949 expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
1950 let expected_destinations: Vec<HTLCDestination> = repeat(HTLCDestination::FailedPayment { payment_hash: our_payment_hash }).take(expected_paths.len()).collect();
1951 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(expected_paths[0].last().unwrap(), expected_destinations);
1953 pass_failed_payment_back(origin_node, expected_paths, skip_last, our_payment_hash);
1956 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) {
1957 let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
1958 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1960 let mut per_path_msgs: Vec<((msgs::UpdateFailHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1961 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1962 assert_eq!(events.len(), expected_paths.len());
1963 for ev in events.iter() {
1964 let (update_fail, commitment_signed, node_id) = match ev {
1965 &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 } } => {
1966 assert!(update_add_htlcs.is_empty());
1967 assert!(update_fulfill_htlcs.is_empty());
1968 assert_eq!(update_fail_htlcs.len(), 1);
1969 assert!(update_fail_malformed_htlcs.is_empty());
1970 assert!(update_fee.is_none());
1971 (update_fail_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
1973 _ => panic!("Unexpected event"),
1975 per_path_msgs.push(((update_fail, commitment_signed), node_id));
1977 per_path_msgs.sort_unstable_by(|(_, node_id_a), (_, node_id_b)| node_id_a.cmp(node_id_b));
1978 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()));
1980 for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
1981 let mut next_msgs = Some(path_msgs);
1982 let mut expected_next_node = next_hop;
1983 let mut prev_node = expected_route.last().unwrap();
1985 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
1986 assert_eq!(expected_next_node, node.node.get_our_node_id());
1987 let update_next_node = !skip_last || idx != expected_route.len() - 1;
1988 if next_msgs.is_some() {
1989 node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1990 commitment_signed_dance!(node, prev_node, next_msgs.as_ref().unwrap().1, update_next_node);
1991 if !update_next_node {
1992 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 }]);
1995 let events = node.node.get_and_clear_pending_msg_events();
1996 if update_next_node {
1997 assert_eq!(events.len(), 1);
1999 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 } } => {
2000 assert!(update_add_htlcs.is_empty());
2001 assert!(update_fulfill_htlcs.is_empty());
2002 assert_eq!(update_fail_htlcs.len(), 1);
2003 assert!(update_fail_malformed_htlcs.is_empty());
2004 assert!(update_fee.is_none());
2005 expected_next_node = node_id.clone();
2006 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
2008 _ => panic!("Unexpected event"),
2011 assert!(events.is_empty());
2013 if !skip_last && idx == expected_route.len() - 1 {
2014 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2021 let prev_node = expected_route.first().unwrap();
2022 origin_node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2023 check_added_monitors!(origin_node, 0);
2024 assert!(origin_node.node.get_and_clear_pending_msg_events().is_empty());
2025 commitment_signed_dance!(origin_node, prev_node, next_msgs.as_ref().unwrap().1, false);
2026 let events = origin_node.node.get_and_clear_pending_events();
2027 assert_eq!(events.len(), 1);
2028 let expected_payment_id = match events[0] {
2029 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, all_paths_failed, ref path, ref payment_id, .. } => {
2030 assert_eq!(payment_hash, our_payment_hash);
2031 assert!(payment_failed_permanently);
2032 assert_eq!(all_paths_failed, i == expected_paths.len() - 1);
2033 for (idx, hop) in expected_route.iter().enumerate() {
2034 assert_eq!(hop.node.get_our_node_id(), path[idx].pubkey);
2038 _ => panic!("Unexpected event"),
2040 if i == expected_paths.len() - 1 {
2041 origin_node.node.abandon_payment(expected_payment_id);
2042 let events = origin_node.node.get_and_clear_pending_events();
2043 assert_eq!(events.len(), 1);
2045 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
2046 assert_eq!(*payment_hash, our_payment_hash, "unexpected second payment_hash");
2047 assert_eq!(*payment_id, expected_payment_id);
2049 _ => panic!("Unexpected second event"),
2055 // Ensure that fail_htlc_backwards is idempotent.
2056 expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2057 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_events().is_empty());
2058 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2059 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2062 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash) {
2063 fail_payment_along_route(origin_node, &[&expected_path[..]], false, our_payment_hash);
2066 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
2067 let mut chan_mon_cfgs = Vec::new();
2068 for i in 0..node_count {
2069 let tx_broadcaster = test_utils::TestBroadcaster {
2070 txn_broadcasted: Mutex::new(Vec::new()),
2071 blocks: Arc::new(Mutex::new(vec![(genesis_block(Network::Testnet), 0)])),
2073 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
2074 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
2075 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
2076 let persister = test_utils::TestPersister::new();
2077 let seed = [i as u8; 32];
2078 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2080 chan_mon_cfgs.push(TestChanMonCfg{ tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager });
2086 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
2087 let mut nodes = Vec::new();
2089 for i in 0..node_count {
2090 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);
2091 let seed = [i as u8; 32];
2092 nodes.push(NodeCfg {
2093 chain_source: &chanmon_cfgs[i].chain_source,
2094 logger: &chanmon_cfgs[i].logger,
2095 tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster,
2096 fee_estimator: &chanmon_cfgs[i].fee_estimator,
2098 keys_manager: &chanmon_cfgs[i].keys_manager,
2100 features: InitFeatures::known(),
2101 network_graph: NetworkGraph::new(chanmon_cfgs[i].chain_source.genesis_hash, &chanmon_cfgs[i].logger),
2108 pub fn test_default_channel_config() -> UserConfig {
2109 let mut default_config = UserConfig::default();
2110 // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
2111 // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
2112 default_config.channel_config.cltv_expiry_delta = MIN_CLTV_EXPIRY_DELTA;
2113 default_config.channel_handshake_config.announced_channel = true;
2114 default_config.channel_handshake_limits.force_announced_channel_preference = false;
2115 // When most of our tests were written, the default HTLC minimum was fixed at 1000.
2116 // It now defaults to 1, so we simply set it to the expected value here.
2117 default_config.channel_handshake_config.our_htlc_minimum_msat = 1000;
2118 // When most of our tests were written, we didn't have the notion of a `max_dust_htlc_exposure_msat`,
2119 // It now defaults to 5_000_000 msat; to avoid interfering with tests we bump it to 50_000_000 msat.
2120 default_config.channel_config.max_dust_htlc_exposure_msat = 50_000_000;
2124 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>> {
2125 let mut chanmgrs = Vec::new();
2126 for i in 0..node_count {
2127 let network = Network::Testnet;
2128 let params = ChainParameters {
2130 best_block: BestBlock::from_genesis(network),
2132 let node = ChannelManager::new(cfgs[i].fee_estimator, &cfgs[i].chain_monitor, cfgs[i].tx_broadcaster, cfgs[i].logger, cfgs[i].keys_manager,
2133 if node_config[i].is_some() { node_config[i].clone().unwrap() } else { test_default_channel_config() }, params);
2134 chanmgrs.push(node);
2140 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>> {
2141 let mut nodes = Vec::new();
2142 let chan_count = Rc::new(RefCell::new(0));
2143 let payment_count = Rc::new(RefCell::new(0));
2144 let connect_style = Rc::new(RefCell::new(ConnectStyle::random_style()));
2146 for i in 0..node_count {
2147 let gossip_sync = P2PGossipSync::new(&cfgs[i].network_graph, None, cfgs[i].logger);
2149 chain_source: cfgs[i].chain_source, tx_broadcaster: cfgs[i].tx_broadcaster,
2150 chain_monitor: &cfgs[i].chain_monitor, keys_manager: &cfgs[i].keys_manager,
2151 node: &chan_mgrs[i], network_graph: &cfgs[i].network_graph, gossip_sync,
2152 node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
2153 network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
2154 blocks: Arc::clone(&cfgs[i].tx_broadcaster.blocks),
2155 connect_style: Rc::clone(&connect_style),
2159 for i in 0..node_count {
2160 for j in (i+1)..node_count {
2161 nodes[i].node.peer_connected(&nodes[j].node.get_our_node_id(), &msgs::Init { features: cfgs[j].features.clone(), remote_network_address: None });
2162 nodes[j].node.peer_connected(&nodes[i].node.get_our_node_id(), &msgs::Init { features: cfgs[i].features.clone(), remote_network_address: None });
2169 // Note that the following only works for CLTV values up to 128
2170 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
2171 pub const OFFERED_HTLC_SCRIPT_WEIGHT: usize = 133;
2173 #[derive(PartialEq)]
2174 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
2175 /// Tests that the given node has broadcast transactions for the given Channel
2177 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
2178 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
2179 /// broadcast and the revoked outputs were claimed.
2181 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
2182 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
2184 /// All broadcast transactions must be accounted for in one of the above three types of we'll
2186 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> {
2187 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2188 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
2190 let mut res = Vec::with_capacity(2);
2191 node_txn.retain(|tx| {
2192 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
2193 check_spends!(tx, chan.3);
2194 if commitment_tx.is_none() {
2195 res.push(tx.clone());
2200 if let Some(explicit_tx) = commitment_tx {
2201 res.push(explicit_tx.clone());
2204 assert_eq!(res.len(), 1);
2206 if has_htlc_tx != HTLCType::NONE {
2207 node_txn.retain(|tx| {
2208 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
2209 check_spends!(tx, res[0]);
2210 if has_htlc_tx == HTLCType::TIMEOUT {
2211 assert!(tx.lock_time.0 != 0);
2213 assert!(tx.lock_time.0 == 0);
2215 res.push(tx.clone());
2219 assert!(res.len() == 2 || res.len() == 3);
2221 assert_eq!(res[1], res[2]);
2225 assert!(node_txn.is_empty());
2229 /// Tests that the given node has broadcast a claim transaction against the provided revoked
2230 /// HTLC transaction.
2231 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
2232 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2233 // We may issue multiple claiming transaction on revoked outputs due to block rescan
2234 // for revoked htlc outputs
2235 if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
2236 node_txn.retain(|tx| {
2237 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
2238 check_spends!(tx, revoked_tx);
2242 node_txn.retain(|tx| {
2243 check_spends!(tx, commitment_revoked_tx);
2246 assert!(node_txn.is_empty());
2249 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
2250 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2252 assert!(node_txn.len() >= 1);
2253 assert_eq!(node_txn[0].input.len(), 1);
2254 let mut found_prev = false;
2256 for tx in prev_txn {
2257 if node_txn[0].input[0].previous_output.txid == tx.txid() {
2258 check_spends!(node_txn[0], tx);
2259 let mut iter = node_txn[0].input[0].witness.iter();
2260 iter.next().expect("expected 3 witness items");
2261 iter.next().expect("expected 3 witness items");
2262 assert!(iter.next().expect("expected 3 witness items").len() > 106); // must spend an htlc output
2263 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
2269 assert!(found_prev);
2271 let mut res = Vec::new();
2272 mem::swap(&mut *node_txn, &mut res);
2276 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) {
2277 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
2278 assert_eq!(events_1.len(), 2);
2279 let as_update = match events_1[0] {
2280 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2283 _ => panic!("Unexpected event"),
2286 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2287 assert_eq!(node_id, nodes[b].node.get_our_node_id());
2288 assert_eq!(msg.data, expected_error);
2289 if needs_err_handle {
2290 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
2293 _ => panic!("Unexpected event"),
2296 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
2297 assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
2298 let bs_update = match events_2[0] {
2299 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2302 _ => panic!("Unexpected event"),
2304 if !needs_err_handle {
2306 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2307 assert_eq!(node_id, nodes[a].node.get_our_node_id());
2308 assert_eq!(msg.data, expected_error);
2310 _ => panic!("Unexpected event"),
2315 node.gossip_sync.handle_channel_update(&as_update).unwrap();
2316 node.gossip_sync.handle_channel_update(&bs_update).unwrap();
2320 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize) {
2321 handle_announce_close_broadcast_events(nodes, a, b, false, "Channel closed because commitment or closing transaction was confirmed on chain.");
2325 macro_rules! get_channel_value_stat {
2326 ($node: expr, $channel_id: expr) => {{
2327 let chan_lock = $node.node.channel_state.lock().unwrap();
2328 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
2329 chan.get_value_stat()
2333 macro_rules! get_chan_reestablish_msgs {
2334 ($src_node: expr, $dst_node: expr) => {
2336 let mut res = Vec::with_capacity(1);
2337 for msg in $src_node.node.get_and_clear_pending_msg_events() {
2338 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
2339 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2340 res.push(msg.clone());
2342 panic!("Unexpected event")
2350 macro_rules! handle_chan_reestablish_msgs {
2351 ($src_node: expr, $dst_node: expr) => {
2353 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
2355 let channel_ready = if let Some(&MessageSendEvent::SendChannelReady { ref node_id, ref msg }) = msg_events.get(0) {
2357 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2363 if let Some(&MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ }) = msg_events.get(idx) {
2365 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2368 let mut revoke_and_ack = None;
2369 let mut commitment_update = None;
2370 let order = if let Some(ev) = msg_events.get(idx) {
2372 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2373 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2374 revoke_and_ack = Some(msg.clone());
2376 RAACommitmentOrder::RevokeAndACKFirst
2378 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2379 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2380 commitment_update = Some(updates.clone());
2382 RAACommitmentOrder::CommitmentFirst
2384 _ => RAACommitmentOrder::CommitmentFirst,
2387 RAACommitmentOrder::CommitmentFirst
2390 if let Some(ev) = msg_events.get(idx) {
2392 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2393 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2394 assert!(revoke_and_ack.is_none());
2395 revoke_and_ack = Some(msg.clone());
2398 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2399 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2400 assert!(commitment_update.is_none());
2401 commitment_update = Some(updates.clone());
2408 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, ref msg }) = msg_events.get(idx) {
2409 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2411 assert_eq!(msg.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
2414 assert_eq!(msg_events.len(), idx);
2416 (channel_ready, revoke_and_ack, commitment_update, order)
2421 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
2422 /// for claims/fails they are separated out.
2423 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)) {
2424 node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty(), remote_network_address: None });
2425 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
2426 node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty(), remote_network_address: None });
2427 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
2429 if send_channel_ready.0 {
2430 // If a expects a channel_ready, it better not think it has received a revoke_and_ack
2432 for reestablish in reestablish_1.iter() {
2433 assert_eq!(reestablish.next_remote_commitment_number, 0);
2436 if send_channel_ready.1 {
2437 // If b expects a channel_ready, it better not think it has received a revoke_and_ack
2439 for reestablish in reestablish_2.iter() {
2440 assert_eq!(reestablish.next_remote_commitment_number, 0);
2443 if send_channel_ready.0 || send_channel_ready.1 {
2444 // If we expect any channel_ready's, both sides better have set
2445 // next_holder_commitment_number to 1
2446 for reestablish in reestablish_1.iter() {
2447 assert_eq!(reestablish.next_local_commitment_number, 1);
2449 for reestablish in reestablish_2.iter() {
2450 assert_eq!(reestablish.next_local_commitment_number, 1);
2454 let mut resp_1 = Vec::new();
2455 for msg in reestablish_1 {
2456 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
2457 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
2459 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
2460 check_added_monitors!(node_b, 1);
2462 check_added_monitors!(node_b, 0);
2465 let mut resp_2 = Vec::new();
2466 for msg in reestablish_2 {
2467 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
2468 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
2470 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
2471 check_added_monitors!(node_a, 1);
2473 check_added_monitors!(node_a, 0);
2476 // We don't yet support both needing updates, as that would require a different commitment dance:
2477 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_htlc_fails.0 == 0 &&
2478 pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
2479 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_htlc_fails.1 == 0 &&
2480 pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
2482 for chan_msgs in resp_1.drain(..) {
2483 if send_channel_ready.0 {
2484 node_a.node.handle_channel_ready(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
2485 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
2486 if !announcement_event.is_empty() {
2487 assert_eq!(announcement_event.len(), 1);
2488 if let MessageSendEvent::SendChannelUpdate { .. } = announcement_event[0] {
2489 //TODO: Test announcement_sigs re-sending
2490 } else { panic!("Unexpected event! {:?}", announcement_event[0]); }
2493 assert!(chan_msgs.0.is_none());
2496 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2497 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
2498 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2499 check_added_monitors!(node_a, 1);
2501 assert!(chan_msgs.1.is_none());
2503 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 {
2504 let commitment_update = chan_msgs.2.unwrap();
2505 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2506 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
2508 assert!(commitment_update.update_add_htlcs.is_empty());
2510 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
2511 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.0 + pending_cell_htlc_fails.0);
2512 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2513 for update_add in commitment_update.update_add_htlcs {
2514 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
2516 for update_fulfill in commitment_update.update_fulfill_htlcs {
2517 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
2519 for update_fail in commitment_update.update_fail_htlcs {
2520 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
2523 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2524 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
2526 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
2527 check_added_monitors!(node_a, 1);
2528 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
2529 // No commitment_signed so get_event_msg's assert(len == 1) passes
2530 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
2531 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2532 check_added_monitors!(node_b, 1);
2535 assert!(chan_msgs.2.is_none());
2539 for chan_msgs in resp_2.drain(..) {
2540 if send_channel_ready.1 {
2541 node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
2542 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
2543 if !announcement_event.is_empty() {
2544 assert_eq!(announcement_event.len(), 1);
2545 match announcement_event[0] {
2546 MessageSendEvent::SendChannelUpdate { .. } => {},
2547 MessageSendEvent::SendAnnouncementSignatures { .. } => {},
2548 _ => panic!("Unexpected event {:?}!", announcement_event[0]),
2552 assert!(chan_msgs.0.is_none());
2555 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2556 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
2557 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2558 check_added_monitors!(node_b, 1);
2560 assert!(chan_msgs.1.is_none());
2562 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 {
2563 let commitment_update = chan_msgs.2.unwrap();
2564 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2565 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
2567 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.1 + pending_cell_htlc_claims.1);
2568 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.1 + pending_cell_htlc_fails.1);
2569 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2570 for update_add in commitment_update.update_add_htlcs {
2571 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
2573 for update_fulfill in commitment_update.update_fulfill_htlcs {
2574 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
2576 for update_fail in commitment_update.update_fail_htlcs {
2577 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
2580 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2581 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
2583 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
2584 check_added_monitors!(node_b, 1);
2585 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
2586 // No commitment_signed so get_event_msg's assert(len == 1) passes
2587 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
2588 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2589 check_added_monitors!(node_a, 1);
2592 assert!(chan_msgs.2.is_none());