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::chaininterface;
14 use chain::transaction::OutPoint;
15 use ln::channelmanager::{ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentPreimage, PaymentHash, PaymentSecret, PaymentSendFailure};
16 use ln::channelmonitor::{ChannelMonitor, ManyChannelMonitor};
17 use routing::router::{Route, get_route};
18 use routing::network_graph::{NetGraphMsgHandler, NetworkGraph};
19 use ln::features::InitFeatures;
21 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler};
22 use util::enforcing_trait_impls::EnforcingChannelKeys;
24 use util::test_utils::TestChannelMonitor;
25 use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
26 use util::errors::APIError;
27 use util::config::UserConfig;
28 use util::ser::{ReadableArgs, Writeable, Readable};
30 use bitcoin::blockdata::block::BlockHeader;
31 use bitcoin::blockdata::transaction::{Transaction, TxOut};
32 use bitcoin::network::constants::Network;
34 use bitcoin::hashes::sha256::Hash as Sha256;
35 use bitcoin::hashes::Hash;
36 use bitcoin::hash_types::BlockHash;
38 use bitcoin::secp256k1::key::PublicKey;
40 use std::cell::RefCell;
44 use std::collections::HashMap;
46 pub const CHAN_CONFIRM_DEPTH: u32 = 100;
47 pub fn confirm_transaction<'a, 'b: 'a>(notifier: &'a chaininterface::BlockNotifierRef<'b, &chaininterface::ChainWatchInterfaceUtil>, chain: &chaininterface::ChainWatchInterfaceUtil, tx: &Transaction, chan_id: i32) {
48 assert!(chain.does_match_tx(tx));
49 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
50 notifier.block_connected_checked(&header, 1, &[tx; 1], &[chan_id as usize; 1]);
51 for i in 2..CHAN_CONFIRM_DEPTH {
52 header = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
53 notifier.block_connected_checked(&header, i, &vec![], &[0; 0]);
57 pub fn connect_blocks<'a, 'b>(notifier: &'a chaininterface::BlockNotifierRef<'b, &chaininterface::ChainWatchInterfaceUtil>, depth: u32, height: u32, parent: bool, prev_blockhash: BlockHash) -> BlockHash {
58 let mut header = BlockHeader { version: 0x2000000, prev_blockhash: if parent { prev_blockhash } else { Default::default() }, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
59 notifier.block_connected_checked(&header, height + 1, &Vec::new(), &Vec::new());
60 for i in 2..depth + 1 {
61 header = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
62 notifier.block_connected_checked(&header, height + i, &Vec::new(), &Vec::new());
67 pub struct TestChanMonCfg {
68 pub tx_broadcaster: test_utils::TestBroadcaster,
69 pub fee_estimator: test_utils::TestFeeEstimator,
70 pub chain_monitor: chaininterface::ChainWatchInterfaceUtil,
71 pub logger: test_utils::TestLogger,
74 pub struct NodeCfg<'a> {
75 pub chain_monitor: &'a chaininterface::ChainWatchInterfaceUtil,
76 pub tx_broadcaster: &'a test_utils::TestBroadcaster,
77 pub fee_estimator: &'a test_utils::TestFeeEstimator,
78 pub chan_monitor: test_utils::TestChannelMonitor<'a>,
79 pub keys_manager: test_utils::TestKeysInterface,
80 pub logger: &'a test_utils::TestLogger,
81 pub node_seed: [u8; 32],
84 pub struct Node<'a, 'b: 'a, 'c: 'b> {
85 pub block_notifier: chaininterface::BlockNotifierRef<'a, &'c chaininterface::ChainWatchInterfaceUtil>,
86 pub chain_monitor: &'c chaininterface::ChainWatchInterfaceUtil,
87 pub tx_broadcaster: &'c test_utils::TestBroadcaster,
88 pub chan_monitor: &'b test_utils::TestChannelMonitor<'c>,
89 pub keys_manager: &'b test_utils::TestKeysInterface,
90 pub node: &'a ChannelManager<EnforcingChannelKeys, &'b TestChannelMonitor<'c>, &'c test_utils::TestBroadcaster, &'b test_utils::TestKeysInterface, &'c test_utils::TestFeeEstimator, &'c test_utils::TestLogger>,
91 pub net_graph_msg_handler: NetGraphMsgHandler<&'c chaininterface::ChainWatchInterfaceUtil, &'c test_utils::TestLogger>,
92 pub node_seed: [u8; 32],
93 pub network_payment_count: Rc<RefCell<u8>>,
94 pub network_chan_count: Rc<RefCell<u32>>,
95 pub logger: &'c test_utils::TestLogger,
98 impl<'a, 'b, 'c> Drop for Node<'a, 'b, 'c> {
100 if !::std::thread::panicking() {
101 // Check that we processed all pending events
102 assert!(self.node.get_and_clear_pending_msg_events().is_empty());
103 assert!(self.node.get_and_clear_pending_events().is_empty());
104 assert!(self.chan_monitor.added_monitors.lock().unwrap().is_empty());
106 // Check that if we serialize the Router, we can deserialize it again.
108 let mut w = test_utils::TestVecWriter(Vec::new());
109 let network_graph_ser = self.net_graph_msg_handler.network_graph.read().unwrap();
110 network_graph_ser.write(&mut w).unwrap();
111 let network_graph_deser = <NetworkGraph>::read(&mut ::std::io::Cursor::new(&w.0)).unwrap();
112 assert!(network_graph_deser == *self.net_graph_msg_handler.network_graph.read().unwrap());
113 let net_graph_msg_handler = NetGraphMsgHandler::from_net_graph(
114 self.chain_monitor, self.logger, network_graph_deser
116 let mut chan_progress = 0;
118 let orig_announcements = self.net_graph_msg_handler.get_next_channel_announcements(chan_progress, 255);
119 let deserialized_announcements = net_graph_msg_handler.get_next_channel_announcements(chan_progress, 255);
120 assert!(orig_announcements == deserialized_announcements);
121 chan_progress = match orig_announcements.last() {
122 Some(announcement) => announcement.0.contents.short_channel_id + 1,
126 let mut node_progress = None;
128 let orig_announcements = self.net_graph_msg_handler.get_next_node_announcements(node_progress.as_ref(), 255);
129 let deserialized_announcements = net_graph_msg_handler.get_next_node_announcements(node_progress.as_ref(), 255);
130 assert!(orig_announcements == deserialized_announcements);
131 node_progress = match orig_announcements.last() {
132 Some(announcement) => Some(announcement.contents.node_id),
138 // Check that if we serialize and then deserialize all our channel monitors we get the
139 // same set of outputs to watch for on chain as we have now. Note that if we write
140 // tests that fully close channels and remove the monitors at some point this may break.
141 let feeest = test_utils::TestFeeEstimator { sat_per_kw: 253 };
142 let mut deserialized_monitors = Vec::new();
144 let old_monitors = self.chan_monitor.simple_monitor.monitors.lock().unwrap();
145 for (_, old_monitor) in old_monitors.iter() {
146 let mut w = test_utils::TestVecWriter(Vec::new());
147 old_monitor.write_for_disk(&mut w).unwrap();
148 let (_, deserialized_monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(
149 &mut ::std::io::Cursor::new(&w.0)).unwrap();
150 deserialized_monitors.push(deserialized_monitor);
154 // Before using all the new monitors to check the watch outpoints, use the full set of
155 // them to ensure we can write and reload our ChannelManager.
157 let mut channel_monitors = HashMap::new();
158 for monitor in deserialized_monitors.iter_mut() {
159 channel_monitors.insert(monitor.get_funding_txo().0, monitor);
162 let mut w = test_utils::TestVecWriter(Vec::new());
163 self.node.write(&mut w).unwrap();
164 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut ::std::io::Cursor::new(w.0), ChannelManagerReadArgs {
165 default_config: UserConfig::default(),
166 keys_manager: self.keys_manager,
167 fee_estimator: &test_utils::TestFeeEstimator { sat_per_kw: 253 },
168 monitor: self.chan_monitor,
169 tx_broadcaster: self.tx_broadcaster.clone(),
170 logger: &test_utils::TestLogger::new(),
175 let chain_watch = chaininterface::ChainWatchInterfaceUtil::new(Network::Testnet);
176 let channel_monitor = test_utils::TestChannelMonitor::new(&chain_watch, self.tx_broadcaster.clone(), &self.logger, &feeest);
177 for deserialized_monitor in deserialized_monitors.drain(..) {
178 if let Err(_) = channel_monitor.add_monitor(deserialized_monitor.get_funding_txo().0, deserialized_monitor) {
182 if chain_watch != *self.chain_monitor {
189 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) {
190 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001, a_flags, b_flags)
193 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) {
194 let (funding_locked, channel_id, tx) = create_chan_between_nodes_with_value_a(node_a, node_b, channel_value, push_msat, a_flags, b_flags);
195 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &funding_locked);
196 (announcement, as_update, bs_update, channel_id, tx)
199 macro_rules! get_revoke_commit_msgs {
200 ($node: expr, $node_id: expr) => {
202 let events = $node.node.get_and_clear_pending_msg_events();
203 assert_eq!(events.len(), 2);
205 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
206 assert_eq!(*node_id, $node_id);
209 _ => panic!("Unexpected event"),
211 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
212 assert_eq!(*node_id, $node_id);
213 assert!(updates.update_add_htlcs.is_empty());
214 assert!(updates.update_fulfill_htlcs.is_empty());
215 assert!(updates.update_fail_htlcs.is_empty());
216 assert!(updates.update_fail_malformed_htlcs.is_empty());
217 assert!(updates.update_fee.is_none());
218 updates.commitment_signed.clone()
220 _ => panic!("Unexpected event"),
226 macro_rules! get_event_msg {
227 ($node: expr, $event_type: path, $node_id: expr) => {
229 let events = $node.node.get_and_clear_pending_msg_events();
230 assert_eq!(events.len(), 1);
232 $event_type { ref node_id, ref msg } => {
233 assert_eq!(*node_id, $node_id);
236 _ => panic!("Unexpected event"),
242 macro_rules! get_htlc_update_msgs {
243 ($node: expr, $node_id: expr) => {
245 let events = $node.node.get_and_clear_pending_msg_events();
246 assert_eq!(events.len(), 1);
248 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
249 assert_eq!(*node_id, $node_id);
252 _ => panic!("Unexpected event"),
258 macro_rules! get_feerate {
259 ($node: expr, $channel_id: expr) => {
261 let chan_lock = $node.node.channel_state.lock().unwrap();
262 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
268 macro_rules! get_local_commitment_txn {
269 ($node: expr, $channel_id: expr) => {
271 let mut monitors = $node.chan_monitor.simple_monitor.monitors.lock().unwrap();
272 let mut commitment_txn = None;
273 for (funding_txo, monitor) in monitors.iter_mut() {
274 if funding_txo.to_channel_id() == $channel_id {
275 commitment_txn = Some(monitor.unsafe_get_latest_holder_commitment_txn(&$node.logger));
279 commitment_txn.unwrap()
284 macro_rules! unwrap_send_err {
285 ($res: expr, $all_failed: expr, $type: pat, $check: expr) => {
287 &Err(PaymentSendFailure::AllFailedRetrySafe(ref fails)) if $all_failed => {
288 assert_eq!(fails.len(), 1);
294 &Err(PaymentSendFailure::PartialFailure(ref fails)) if !$all_failed => {
295 assert_eq!(fails.len(), 1);
297 Err($type) => { $check },
306 macro_rules! check_added_monitors {
307 ($node: expr, $count: expr) => {
309 let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
310 assert_eq!(added_monitors.len(), $count);
311 added_monitors.clear();
316 pub fn create_funding_transaction<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, expected_chan_value: u64, expected_user_chan_id: u64) -> ([u8; 32], Transaction, OutPoint) {
317 let chan_id = *node.network_chan_count.borrow();
319 let events = node.node.get_and_clear_pending_events();
320 assert_eq!(events.len(), 1);
322 Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
323 assert_eq!(*channel_value_satoshis, expected_chan_value);
324 assert_eq!(user_channel_id, expected_user_chan_id);
326 let tx = Transaction { version: chan_id as i32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
327 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
329 let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
330 (*temporary_channel_id, tx, funding_outpoint)
332 _ => panic!("Unexpected event"),
336 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 {
337 node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
338 node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), a_flags, &get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id()));
339 node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), b_flags, &get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id()));
341 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, channel_value, 42);
343 node_a.node.funding_transaction_generated(&temporary_channel_id, funding_output);
344 check_added_monitors!(node_a, 0);
346 node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id()));
348 let mut added_monitors = node_b.chan_monitor.added_monitors.lock().unwrap();
349 assert_eq!(added_monitors.len(), 1);
350 assert_eq!(added_monitors[0].0, funding_output);
351 added_monitors.clear();
354 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()));
356 let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
357 assert_eq!(added_monitors.len(), 1);
358 assert_eq!(added_monitors[0].0, funding_output);
359 added_monitors.clear();
362 let events_4 = node_a.node.get_and_clear_pending_events();
363 assert_eq!(events_4.len(), 1);
365 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
366 assert_eq!(user_channel_id, 42);
367 assert_eq!(*funding_txo, funding_output);
369 _ => panic!("Unexpected event"),
375 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) {
376 confirm_transaction(&node_conf.block_notifier, &node_conf.chain_monitor, &tx, tx.version);
377 node_recv.node.handle_funding_locked(&node_conf.node.get_our_node_id(), &get_event_msg!(node_conf, MessageSendEvent::SendFundingLocked, node_recv.node.get_our_node_id()));
380 pub fn create_chan_between_nodes_with_value_confirm_second<'a, 'b, 'c>(node_recv: &Node<'a, 'b, 'c>, node_conf: &Node<'a, 'b, 'c>) -> ((msgs::FundingLocked, msgs::AnnouncementSignatures), [u8; 32]) {
382 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
383 assert_eq!(events_6.len(), 2);
384 ((match events_6[0] {
385 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
386 channel_id = msg.channel_id.clone();
387 assert_eq!(*node_id, node_recv.node.get_our_node_id());
390 _ => panic!("Unexpected event"),
391 }, match events_6[1] {
392 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
393 assert_eq!(*node_id, node_recv.node.get_our_node_id());
396 _ => panic!("Unexpected event"),
400 pub fn create_chan_between_nodes_with_value_confirm<'a, 'b, 'c, 'd>(node_a: &'a Node<'b, 'c, 'd>, node_b: &'a Node<'b, 'c, 'd>, tx: &Transaction) -> ((msgs::FundingLocked, msgs::AnnouncementSignatures), [u8; 32]) {
401 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx);
402 confirm_transaction(&node_a.block_notifier, &node_a.chain_monitor, &tx, tx.version);
403 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
406 pub fn create_chan_between_nodes_with_value_a<'a, 'b, 'c, 'd>(node_a: &'a Node<'b, 'c, 'd>, node_b: &'a Node<'b, 'c, 'd>, channel_value: u64, push_msat: u64, a_flags: InitFeatures, b_flags: InitFeatures) -> ((msgs::FundingLocked, msgs::AnnouncementSignatures), [u8; 32], Transaction) {
407 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat, a_flags, b_flags);
408 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
412 pub fn create_chan_between_nodes_with_value_b<'a, 'b, 'c>(node_a: &Node<'a, 'b, 'c>, node_b: &Node<'a, 'b, 'c>, as_funding_msgs: &(msgs::FundingLocked, msgs::AnnouncementSignatures)) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate) {
413 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
414 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
415 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
417 let events_7 = node_b.node.get_and_clear_pending_msg_events();
418 assert_eq!(events_7.len(), 1);
419 let (announcement, bs_update) = match events_7[0] {
420 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
423 _ => panic!("Unexpected event"),
426 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
427 let events_8 = node_a.node.get_and_clear_pending_msg_events();
428 assert_eq!(events_8.len(), 1);
429 let as_update = match events_8[0] {
430 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
431 assert!(*announcement == *msg);
432 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
433 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
436 _ => panic!("Unexpected event"),
439 *node_a.network_chan_count.borrow_mut() += 1;
441 ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
444 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) {
445 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001, a_flags, b_flags)
448 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) {
449 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat, a_flags, b_flags);
451 nodes[a].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
452 let a_events = nodes[a].node.get_and_clear_pending_msg_events();
453 assert_eq!(a_events.len(), 1);
454 let a_node_announcement = match a_events[0] {
455 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
458 _ => panic!("Unexpected event"),
461 nodes[b].node.broadcast_node_announcement([1, 1, 1], [1; 32], Vec::new());
462 let b_events = nodes[b].node.get_and_clear_pending_msg_events();
463 assert_eq!(b_events.len(), 1);
464 let b_node_announcement = match b_events[0] {
465 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
468 _ => panic!("Unexpected event"),
472 assert!(node.net_graph_msg_handler.handle_channel_announcement(&chan_announcement.0).unwrap());
473 node.net_graph_msg_handler.handle_channel_update(&chan_announcement.1).unwrap();
474 node.net_graph_msg_handler.handle_channel_update(&chan_announcement.2).unwrap();
475 node.net_graph_msg_handler.handle_node_announcement(&a_node_announcement).unwrap();
476 node.net_graph_msg_handler.handle_node_announcement(&b_node_announcement).unwrap();
478 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
481 macro_rules! check_spends {
482 ($tx: expr, $($spends_txn: expr),*) => {
484 $tx.verify(|out_point| {
486 if out_point.txid == $spends_txn.txid() {
487 return $spends_txn.output.get(out_point.vout as usize).cloned()
496 macro_rules! get_closing_signed_broadcast {
497 ($node: expr, $dest_pubkey: expr) => {
499 let events = $node.get_and_clear_pending_msg_events();
500 assert!(events.len() == 1 || events.len() == 2);
501 (match events[events.len() - 1] {
502 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
503 assert_eq!(msg.contents.flags & 2, 2);
506 _ => panic!("Unexpected event"),
507 }, if events.len() == 2 {
509 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
510 assert_eq!(*node_id, $dest_pubkey);
513 _ => panic!("Unexpected event"),
520 macro_rules! check_closed_broadcast {
521 ($node: expr, $with_error_msg: expr) => {{
522 let events = $node.node.get_and_clear_pending_msg_events();
523 assert_eq!(events.len(), if $with_error_msg { 2 } else { 1 });
525 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
526 assert_eq!(msg.contents.flags & 2, 2);
528 _ => panic!("Unexpected event"),
532 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
533 // TODO: Check node_id
536 _ => panic!("Unexpected event"),
542 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) {
543 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) };
544 let (node_b, broadcaster_b) = if close_inbound_first { (&outbound_node.node, &outbound_node.tx_broadcaster) } else { (&inbound_node.node, &inbound_node.tx_broadcaster) };
547 node_a.close_channel(channel_id).unwrap();
548 node_b.handle_shutdown(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id()));
550 let events_1 = node_b.get_and_clear_pending_msg_events();
551 assert!(events_1.len() >= 1);
552 let shutdown_b = match events_1[0] {
553 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
554 assert_eq!(node_id, &node_a.get_our_node_id());
557 _ => panic!("Unexpected event"),
560 let closing_signed_b = if !close_inbound_first {
561 assert_eq!(events_1.len(), 1);
564 Some(match events_1[1] {
565 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
566 assert_eq!(node_id, &node_a.get_our_node_id());
569 _ => panic!("Unexpected event"),
573 node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b);
574 let (as_update, bs_update) = if close_inbound_first {
575 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
576 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
577 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
578 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
579 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
581 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
582 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
583 assert!(none_b.is_none());
584 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
585 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
586 (as_update, bs_update)
588 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
590 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
591 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
592 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
593 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
595 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
596 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
597 assert!(none_a.is_none());
598 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
599 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
600 (as_update, bs_update)
602 assert_eq!(tx_a, tx_b);
603 check_spends!(tx_a, funding_tx);
605 (as_update, bs_update, tx_a)
608 pub struct SendEvent {
609 pub node_id: PublicKey,
610 pub msgs: Vec<msgs::UpdateAddHTLC>,
611 pub commitment_msg: msgs::CommitmentSigned,
614 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
615 assert!(updates.update_fulfill_htlcs.is_empty());
616 assert!(updates.update_fail_htlcs.is_empty());
617 assert!(updates.update_fail_malformed_htlcs.is_empty());
618 assert!(updates.update_fee.is_none());
619 SendEvent { node_id: node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
622 pub fn from_event(event: MessageSendEvent) -> SendEvent {
624 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
625 _ => panic!("Unexpected event type!"),
629 pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
630 let mut events = node.node.get_and_clear_pending_msg_events();
631 assert_eq!(events.len(), 1);
632 SendEvent::from_event(events.pop().unwrap())
636 macro_rules! commitment_signed_dance {
637 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
639 check_added_monitors!($node_a, 0);
640 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
641 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
642 check_added_monitors!($node_a, 1);
643 commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
646 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
648 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
649 check_added_monitors!($node_b, 0);
650 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
651 $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack);
652 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
653 check_added_monitors!($node_b, 1);
654 $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed);
655 let (bs_revoke_and_ack, extra_msg_option) = {
656 let events = $node_b.node.get_and_clear_pending_msg_events();
657 assert!(events.len() <= 2);
659 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
660 assert_eq!(*node_id, $node_a.node.get_our_node_id());
663 _ => panic!("Unexpected event"),
664 }, events.get(1).map(|e| e.clone()))
666 check_added_monitors!($node_b, 1);
668 assert!($node_a.node.get_and_clear_pending_events().is_empty());
669 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
671 (extra_msg_option, bs_revoke_and_ack)
674 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
676 check_added_monitors!($node_a, 0);
677 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
678 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
679 check_added_monitors!($node_a, 1);
680 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
681 assert!(extra_msg_option.is_none());
685 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
687 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
688 $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack);
689 check_added_monitors!($node_a, 1);
693 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
695 assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
698 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
700 commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
702 expect_pending_htlcs_forwardable!($node_a);
703 check_added_monitors!($node_a, 1);
705 let channel_state = $node_a.node.channel_state.lock().unwrap();
706 assert_eq!(channel_state.pending_msg_events.len(), 1);
707 if let MessageSendEvent::UpdateHTLCs { ref node_id, .. } = channel_state.pending_msg_events[0] {
708 assert_ne!(*node_id, $node_b.node.get_our_node_id());
709 } else { panic!("Unexpected event"); }
711 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
717 macro_rules! get_payment_preimage_hash {
720 let payment_preimage = PaymentPreimage([*$node.network_payment_count.borrow(); 32]);
721 *$node.network_payment_count.borrow_mut() += 1;
722 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
723 (payment_preimage, payment_hash)
728 macro_rules! expect_pending_htlcs_forwardable_ignore {
730 let events = $node.node.get_and_clear_pending_events();
731 assert_eq!(events.len(), 1);
733 Event::PendingHTLCsForwardable { .. } => { },
734 _ => panic!("Unexpected event"),
739 macro_rules! expect_pending_htlcs_forwardable {
741 expect_pending_htlcs_forwardable_ignore!($node);
742 $node.node.process_pending_htlc_forwards();
746 macro_rules! expect_payment_received {
747 ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
748 let events = $node.node.get_and_clear_pending_events();
749 assert_eq!(events.len(), 1);
751 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
752 assert_eq!($expected_payment_hash, *payment_hash);
753 assert_eq!(None, *payment_secret);
754 assert_eq!($expected_recv_value, amt);
756 _ => panic!("Unexpected event"),
761 macro_rules! expect_payment_sent {
762 ($node: expr, $expected_payment_preimage: expr) => {
763 let events = $node.node.get_and_clear_pending_events();
764 assert_eq!(events.len(), 1);
766 Event::PaymentSent { ref payment_preimage } => {
767 assert_eq!($expected_payment_preimage, *payment_preimage);
769 _ => panic!("Unexpected event"),
774 macro_rules! expect_payment_failed {
775 ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
776 let events = $node.node.get_and_clear_pending_events();
777 assert_eq!(events.len(), 1);
779 Event::PaymentFailed { ref payment_hash, rejected_by_dest, ref error_code, ref error_data } => {
780 assert_eq!(*payment_hash, $expected_payment_hash);
781 assert_eq!(rejected_by_dest, $rejected_by_dest);
782 assert!(error_code.is_some());
783 assert!(error_data.is_some());
785 assert_eq!(error_code.unwrap(), $expected_error_code);
786 assert_eq!(&error_data.as_ref().unwrap()[..], $expected_error_data);
789 _ => panic!("Unexpected event"),
794 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: Option<PaymentSecret>) {
795 origin_node.node.send_payment(&route, our_payment_hash, &our_payment_secret).unwrap();
796 check_added_monitors!(origin_node, expected_paths.len());
797 pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
800 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) {
801 let mut payment_event = SendEvent::from_event(ev);
802 let mut prev_node = origin_node;
804 for (idx, &node) in expected_path.iter().enumerate() {
805 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
807 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
808 check_added_monitors!(node, 0);
809 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
811 expect_pending_htlcs_forwardable!(node);
813 if idx == expected_path.len() - 1 {
814 let events_2 = node.node.get_and_clear_pending_events();
815 if payment_received_expected {
816 assert_eq!(events_2.len(), 1);
818 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
819 assert_eq!(our_payment_hash, *payment_hash);
820 assert_eq!(our_payment_secret, *payment_secret);
821 assert_eq!(amt, recv_value);
823 _ => panic!("Unexpected event"),
826 assert!(events_2.is_empty());
829 let mut events_2 = node.node.get_and_clear_pending_msg_events();
830 assert_eq!(events_2.len(), 1);
831 check_added_monitors!(node, 1);
832 payment_event = SendEvent::from_event(events_2.remove(0));
833 assert_eq!(payment_event.msgs.len(), 1);
840 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: Option<PaymentSecret>) {
841 let mut events = origin_node.node.get_and_clear_pending_msg_events();
842 assert_eq!(events.len(), expected_route.len());
843 for (path_idx, (ev, expected_path)) in events.drain(..).zip(expected_route.iter()).enumerate() {
844 // Once we've gotten through all the HTLCs, the last one should result in a
845 // PaymentReceived (but each previous one should not!), .
846 let expect_payment = path_idx == expected_route.len() - 1;
847 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), our_payment_secret, ev, expect_payment);
851 pub fn send_along_route_with_hash<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, route: Route, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64, our_payment_hash: PaymentHash) {
852 send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, None);
855 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) {
856 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(origin_node);
857 send_along_route_with_hash(origin_node, route, expected_route, recv_value, our_payment_hash);
858 (our_payment_preimage, our_payment_hash)
861 pub fn claim_payment_along_route_with_secret<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_paths: &[&[&Node<'a, 'b, 'c>]], skip_last: bool, our_payment_preimage: PaymentPreimage, our_payment_secret: Option<PaymentSecret>, expected_amount: u64) {
862 for path in expected_paths.iter() {
863 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
865 assert!(expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage, &our_payment_secret, expected_amount));
866 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
868 macro_rules! msgs_from_ev {
871 &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 } } => {
872 assert!(update_add_htlcs.is_empty());
873 assert_eq!(update_fulfill_htlcs.len(), 1);
874 assert!(update_fail_htlcs.is_empty());
875 assert!(update_fail_malformed_htlcs.is_empty());
876 assert!(update_fee.is_none());
877 ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
879 _ => panic!("Unexpected event"),
883 let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
884 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
885 assert_eq!(events.len(), expected_paths.len());
886 for ev in events.iter() {
887 per_path_msgs.push(msgs_from_ev!(ev));
890 for (expected_route, (path_msgs, next_hop)) in expected_paths.iter().zip(per_path_msgs.drain(..)) {
891 let mut next_msgs = Some(path_msgs);
892 let mut expected_next_node = next_hop;
894 macro_rules! last_update_fulfill_dance {
895 ($node: expr, $prev_node: expr) => {
897 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
898 check_added_monitors!($node, 0);
899 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
900 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
904 macro_rules! mid_update_fulfill_dance {
905 ($node: expr, $prev_node: expr, $new_msgs: expr) => {
907 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
908 check_added_monitors!($node, 1);
909 let new_next_msgs = if $new_msgs {
910 let events = $node.node.get_and_clear_pending_msg_events();
911 assert_eq!(events.len(), 1);
912 let (res, nexthop) = msgs_from_ev!(&events[0]);
913 expected_next_node = nexthop;
916 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
919 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
920 next_msgs = new_next_msgs;
925 let mut prev_node = expected_route.last().unwrap();
926 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
927 assert_eq!(expected_next_node, node.node.get_our_node_id());
928 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
929 if next_msgs.is_some() {
930 mid_update_fulfill_dance!(node, prev_node, update_next_msgs);
932 assert!(!update_next_msgs);
933 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
935 if !skip_last && idx == expected_route.len() - 1 {
936 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
943 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
944 expect_payment_sent!(origin_node, our_payment_preimage);
949 pub fn claim_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], skip_last: bool, our_payment_preimage: PaymentPreimage, expected_amount: u64) {
950 claim_payment_along_route_with_secret(origin_node, &[expected_route], skip_last, our_payment_preimage, None, expected_amount);
953 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage, expected_amount: u64) {
954 claim_payment_along_route(origin_node, expected_route, false, our_payment_preimage, expected_amount);
957 pub const TEST_FINAL_CLTV: u32 = 32;
959 pub fn route_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) -> (PaymentPreimage, PaymentHash) {
960 let net_graph_msg_handler = &origin_node.net_graph_msg_handler;
961 let logger = test_utils::TestLogger::new();
962 let route = get_route(&origin_node.node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &expected_route.last().unwrap().node.get_our_node_id(), None, &Vec::new(), recv_value, TEST_FINAL_CLTV, &logger).unwrap();
963 assert_eq!(route.paths.len(), 1);
964 assert_eq!(route.paths[0].len(), expected_route.len());
965 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
966 assert_eq!(hop.pubkey, node.node.get_our_node_id());
969 send_along_route(origin_node, route, expected_route, recv_value)
972 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
973 let logger = test_utils::TestLogger::new();
974 let net_graph_msg_handler = &origin_node.net_graph_msg_handler;
975 let route = get_route(&origin_node.node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &expected_route.last().unwrap().node.get_our_node_id(), None, &Vec::new(), recv_value, TEST_FINAL_CLTV, &logger).unwrap();
976 assert_eq!(route.paths.len(), 1);
977 assert_eq!(route.paths[0].len(), expected_route.len());
978 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
979 assert_eq!(hop.pubkey, node.node.get_our_node_id());
982 let (_, our_payment_hash) = get_payment_preimage_hash!(origin_node);
983 unwrap_send_err!(origin_node.node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
984 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
987 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64, expected_value: u64) {
988 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
989 claim_payment(&origin, expected_route, our_payment_preimage, expected_value);
992 pub fn fail_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], skip_last: bool, our_payment_hash: PaymentHash) {
993 assert!(expected_route.last().unwrap().node.fail_htlc_backwards(&our_payment_hash, &None));
994 expect_pending_htlcs_forwardable!(expected_route.last().unwrap());
995 check_added_monitors!(expected_route.last().unwrap(), 1);
997 let mut next_msgs: Option<(msgs::UpdateFailHTLC, msgs::CommitmentSigned)> = None;
998 macro_rules! update_fail_dance {
999 ($node: expr, $prev_node: expr, $last_node: expr) => {
1001 $node.node.handle_update_fail_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1002 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, !$last_node);
1003 if skip_last && $last_node {
1004 expect_pending_htlcs_forwardable!($node);
1010 let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
1011 let mut prev_node = expected_route.last().unwrap();
1012 for (idx, node) in expected_route.iter().rev().enumerate() {
1013 assert_eq!(expected_next_node, node.node.get_our_node_id());
1014 if next_msgs.is_some() {
1015 // We may be the "last node" for the purpose of the commitment dance if we're
1016 // skipping the last node (implying it is disconnected) and we're the
1017 // second-to-last node!
1018 update_fail_dance!(node, prev_node, skip_last && idx == expected_route.len() - 1);
1021 let events = node.node.get_and_clear_pending_msg_events();
1022 if !skip_last || idx != expected_route.len() - 1 {
1023 assert_eq!(events.len(), 1);
1025 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 } } => {
1026 assert!(update_add_htlcs.is_empty());
1027 assert!(update_fulfill_htlcs.is_empty());
1028 assert_eq!(update_fail_htlcs.len(), 1);
1029 assert!(update_fail_malformed_htlcs.is_empty());
1030 assert!(update_fee.is_none());
1031 expected_next_node = node_id.clone();
1032 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
1034 _ => panic!("Unexpected event"),
1037 assert!(events.is_empty());
1039 if !skip_last && idx == expected_route.len() - 1 {
1040 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1047 update_fail_dance!(origin_node, expected_route.first().unwrap(), true);
1049 let events = origin_node.node.get_and_clear_pending_events();
1050 assert_eq!(events.len(), 1);
1052 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
1053 assert_eq!(payment_hash, our_payment_hash);
1054 assert!(rejected_by_dest);
1056 _ => panic!("Unexpected event"),
1061 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash) {
1062 fail_payment_along_route(origin_node, expected_route, false, our_payment_hash);
1065 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
1066 let mut chan_mon_cfgs = Vec::new();
1067 for i in 0..node_count {
1068 let tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())};
1069 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
1070 let chain_monitor = chaininterface::ChainWatchInterfaceUtil::new(Network::Testnet);
1071 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
1072 chan_mon_cfgs.push(TestChanMonCfg{ tx_broadcaster, fee_estimator, chain_monitor, logger });
1078 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
1079 let mut nodes = Vec::new();
1081 for i in 0..node_count {
1082 let seed = [i as u8; 32];
1083 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
1084 let chan_monitor = test_utils::TestChannelMonitor::new(&chanmon_cfgs[i].chain_monitor, &chanmon_cfgs[i].tx_broadcaster, &chanmon_cfgs[i].logger, &chanmon_cfgs[i].fee_estimator);
1085 nodes.push(NodeCfg { chain_monitor: &chanmon_cfgs[i].chain_monitor, logger: &chanmon_cfgs[i].logger, tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster, fee_estimator: &chanmon_cfgs[i].fee_estimator, chan_monitor, keys_manager, node_seed: seed });
1091 pub fn create_node_chanmgrs<'a, 'b>(node_count: usize, cfgs: &'a Vec<NodeCfg<'b>>, node_config: &[Option<UserConfig>]) -> Vec<ChannelManager<EnforcingChannelKeys, &'a TestChannelMonitor<'b>, &'b test_utils::TestBroadcaster, &'a test_utils::TestKeysInterface, &'b test_utils::TestFeeEstimator, &'b test_utils::TestLogger>> {
1092 let mut chanmgrs = Vec::new();
1093 for i in 0..node_count {
1094 let mut default_config = UserConfig::default();
1095 default_config.channel_options.announced_channel = true;
1096 default_config.peer_channel_config_limits.force_announced_channel_preference = false;
1097 default_config.own_channel_config.our_htlc_minimum_msat = 1000; // sanitization being done by the sender, to exerce receiver logic we need to lift of limit
1098 let node = ChannelManager::new(Network::Testnet, cfgs[i].fee_estimator, &cfgs[i].chan_monitor, cfgs[i].tx_broadcaster, cfgs[i].logger.clone(), &cfgs[i].keys_manager, if node_config[i].is_some() { node_config[i].clone().unwrap() } else { default_config }, 0);
1099 chanmgrs.push(node);
1105 pub fn create_network<'a, 'b: 'a, 'c: 'b>(node_count: usize, cfgs: &'b Vec<NodeCfg<'c>>, chan_mgrs: &'a Vec<ChannelManager<EnforcingChannelKeys, &'b TestChannelMonitor<'c>, &'c test_utils::TestBroadcaster, &'b test_utils::TestKeysInterface, &'c test_utils::TestFeeEstimator, &'c test_utils::TestLogger>>) -> Vec<Node<'a, 'b, 'c>> {
1106 let mut nodes = Vec::new();
1107 let chan_count = Rc::new(RefCell::new(0));
1108 let payment_count = Rc::new(RefCell::new(0));
1110 for i in 0..node_count {
1111 let block_notifier = chaininterface::BlockNotifier::new(cfgs[i].chain_monitor);
1112 block_notifier.register_listener(&cfgs[i].chan_monitor.simple_monitor as &chaininterface::ChainListener);
1113 block_notifier.register_listener(&chan_mgrs[i] as &chaininterface::ChainListener);
1114 let net_graph_msg_handler = NetGraphMsgHandler::new(cfgs[i].chain_monitor, cfgs[i].logger);
1115 nodes.push(Node{ chain_monitor: &cfgs[i].chain_monitor, block_notifier,
1116 tx_broadcaster: cfgs[i].tx_broadcaster, chan_monitor: &cfgs[i].chan_monitor,
1117 keys_manager: &cfgs[i].keys_manager, node: &chan_mgrs[i], net_graph_msg_handler,
1118 node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
1119 network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
1126 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 138; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
1127 pub const OFFERED_HTLC_SCRIPT_WEIGHT: usize = 133;
1129 #[derive(PartialEq)]
1130 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
1131 /// Tests that the given node has broadcast transactions for the given Channel
1133 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
1134 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
1135 /// broadcast and the revoked outputs were claimed.
1137 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
1138 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
1140 /// All broadcast transactions must be accounted for in one of the above three types of we'll
1142 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> {
1143 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1144 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
1146 let mut res = Vec::with_capacity(2);
1147 node_txn.retain(|tx| {
1148 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
1149 check_spends!(tx, chan.3);
1150 if commitment_tx.is_none() {
1151 res.push(tx.clone());
1156 if let Some(explicit_tx) = commitment_tx {
1157 res.push(explicit_tx.clone());
1160 assert_eq!(res.len(), 1);
1162 if has_htlc_tx != HTLCType::NONE {
1163 node_txn.retain(|tx| {
1164 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
1165 check_spends!(tx, res[0]);
1166 if has_htlc_tx == HTLCType::TIMEOUT {
1167 assert!(tx.lock_time != 0);
1169 assert!(tx.lock_time == 0);
1171 res.push(tx.clone());
1175 assert!(res.len() == 2 || res.len() == 3);
1177 assert_eq!(res[1], res[2]);
1181 assert!(node_txn.is_empty());
1185 /// Tests that the given node has broadcast a claim transaction against the provided revoked
1186 /// HTLC transaction.
1187 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
1188 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1189 // We may issue multiple claiming transaction on revoked outputs due to block rescan
1190 // for revoked htlc outputs
1191 if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
1192 node_txn.retain(|tx| {
1193 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
1194 check_spends!(tx, revoked_tx);
1198 node_txn.retain(|tx| {
1199 check_spends!(tx, commitment_revoked_tx);
1202 assert!(node_txn.is_empty());
1205 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
1206 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1208 assert!(node_txn.len() >= 1);
1209 assert_eq!(node_txn[0].input.len(), 1);
1210 let mut found_prev = false;
1212 for tx in prev_txn {
1213 if node_txn[0].input[0].previous_output.txid == tx.txid() {
1214 check_spends!(node_txn[0], tx);
1215 assert!(node_txn[0].input[0].witness[2].len() > 106); // must spend an htlc output
1216 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
1222 assert!(found_prev);
1224 let mut res = Vec::new();
1225 mem::swap(&mut *node_txn, &mut res);
1229 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize) {
1230 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
1231 assert_eq!(events_1.len(), 1);
1232 let as_update = match events_1[0] {
1233 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1236 _ => panic!("Unexpected event"),
1239 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
1240 assert_eq!(events_2.len(), 1);
1241 let bs_update = match events_2[0] {
1242 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1245 _ => panic!("Unexpected event"),
1249 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
1250 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
1254 macro_rules! get_channel_value_stat {
1255 ($node: expr, $channel_id: expr) => {{
1256 let chan_lock = $node.node.channel_state.lock().unwrap();
1257 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
1258 chan.get_value_stat()
1262 macro_rules! get_chan_reestablish_msgs {
1263 ($src_node: expr, $dst_node: expr) => {
1265 let mut res = Vec::with_capacity(1);
1266 for msg in $src_node.node.get_and_clear_pending_msg_events() {
1267 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
1268 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1269 res.push(msg.clone());
1271 panic!("Unexpected event")
1279 macro_rules! handle_chan_reestablish_msgs {
1280 ($src_node: expr, $dst_node: expr) => {
1282 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
1284 let funding_locked = if let Some(&MessageSendEvent::SendFundingLocked { ref node_id, ref msg }) = msg_events.get(0) {
1286 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1292 let mut revoke_and_ack = None;
1293 let mut commitment_update = None;
1294 let order = if let Some(ev) = msg_events.get(idx) {
1297 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1298 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1299 revoke_and_ack = Some(msg.clone());
1300 RAACommitmentOrder::RevokeAndACKFirst
1302 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1303 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1304 commitment_update = Some(updates.clone());
1305 RAACommitmentOrder::CommitmentFirst
1307 _ => panic!("Unexpected event"),
1310 RAACommitmentOrder::CommitmentFirst
1313 if let Some(ev) = msg_events.get(idx) {
1315 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1316 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1317 assert!(revoke_and_ack.is_none());
1318 revoke_and_ack = Some(msg.clone());
1320 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1321 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1322 assert!(commitment_update.is_none());
1323 commitment_update = Some(updates.clone());
1325 _ => panic!("Unexpected event"),
1329 (funding_locked, revoke_and_ack, commitment_update, order)
1334 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
1335 /// for claims/fails they are separated out.
1336 pub fn reconnect_nodes<'a, 'b, 'c>(node_a: &Node<'a, 'b, 'c>, node_b: &Node<'a, 'b, 'c>, send_funding_locked: (bool, bool), pending_htlc_adds: (i64, i64), pending_htlc_claims: (usize, usize), pending_cell_htlc_claims: (usize, usize), pending_cell_htlc_fails: (usize, usize), pending_raa: (bool, bool)) {
1337 node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1338 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
1339 node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1340 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
1342 if send_funding_locked.0 {
1343 // If a expects a funding_locked, it better not think it has received a revoke_and_ack
1345 for reestablish in reestablish_1.iter() {
1346 assert_eq!(reestablish.next_remote_commitment_number, 0);
1349 if send_funding_locked.1 {
1350 // If b expects a funding_locked, it better not think it has received a revoke_and_ack
1352 for reestablish in reestablish_2.iter() {
1353 assert_eq!(reestablish.next_remote_commitment_number, 0);
1356 if send_funding_locked.0 || send_funding_locked.1 {
1357 // If we expect any funding_locked's, both sides better have set
1358 // next_holder_commitment_number to 1
1359 for reestablish in reestablish_1.iter() {
1360 assert_eq!(reestablish.next_local_commitment_number, 1);
1362 for reestablish in reestablish_2.iter() {
1363 assert_eq!(reestablish.next_local_commitment_number, 1);
1367 let mut resp_1 = Vec::new();
1368 for msg in reestablish_1 {
1369 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
1370 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
1372 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
1373 check_added_monitors!(node_b, 1);
1375 check_added_monitors!(node_b, 0);
1378 let mut resp_2 = Vec::new();
1379 for msg in reestablish_2 {
1380 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
1381 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
1383 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
1384 check_added_monitors!(node_a, 1);
1386 check_added_monitors!(node_a, 0);
1389 // We don't yet support both needing updates, as that would require a different commitment dance:
1390 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
1391 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
1393 for chan_msgs in resp_1.drain(..) {
1394 if send_funding_locked.0 {
1395 node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
1396 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
1397 if !announcement_event.is_empty() {
1398 assert_eq!(announcement_event.len(), 1);
1399 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1400 //TODO: Test announcement_sigs re-sending
1401 } else { panic!("Unexpected event!"); }
1404 assert!(chan_msgs.0.is_none());
1407 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1408 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
1409 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1410 check_added_monitors!(node_a, 1);
1412 assert!(chan_msgs.1.is_none());
1414 if pending_htlc_adds.0 != 0 || pending_htlc_claims.0 != 0 || pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
1415 let commitment_update = chan_msgs.2.unwrap();
1416 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1417 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
1419 assert!(commitment_update.update_add_htlcs.is_empty());
1421 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
1422 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
1423 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1424 for update_add in commitment_update.update_add_htlcs {
1425 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
1427 for update_fulfill in commitment_update.update_fulfill_htlcs {
1428 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
1430 for update_fail in commitment_update.update_fail_htlcs {
1431 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
1434 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1435 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
1437 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
1438 check_added_monitors!(node_a, 1);
1439 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
1440 // No commitment_signed so get_event_msg's assert(len == 1) passes
1441 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
1442 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1443 check_added_monitors!(node_b, 1);
1446 assert!(chan_msgs.2.is_none());
1450 for chan_msgs in resp_2.drain(..) {
1451 if send_funding_locked.1 {
1452 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
1453 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
1454 if !announcement_event.is_empty() {
1455 assert_eq!(announcement_event.len(), 1);
1456 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1457 //TODO: Test announcement_sigs re-sending
1458 } else { panic!("Unexpected event!"); }
1461 assert!(chan_msgs.0.is_none());
1464 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1465 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
1466 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1467 check_added_monitors!(node_b, 1);
1469 assert!(chan_msgs.1.is_none());
1471 if pending_htlc_adds.1 != 0 || pending_htlc_claims.1 != 0 || pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
1472 let commitment_update = chan_msgs.2.unwrap();
1473 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
1474 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
1476 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
1477 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
1478 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1479 for update_add in commitment_update.update_add_htlcs {
1480 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
1482 for update_fulfill in commitment_update.update_fulfill_htlcs {
1483 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
1485 for update_fail in commitment_update.update_fail_htlcs {
1486 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
1489 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
1490 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
1492 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
1493 check_added_monitors!(node_b, 1);
1494 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
1495 // No commitment_signed so get_event_msg's assert(len == 1) passes
1496 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1497 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1498 check_added_monitors!(node_a, 1);
1501 assert!(chan_msgs.2.is_none());