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.
14 use chain::channelmonitor::ChannelMonitor;
15 use chain::transaction::OutPoint;
16 use ln::channelmanager::{ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentPreimage, PaymentHash, PaymentSecret, PaymentSendFailure};
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::TestChainMonitor;
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::{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;
48 pub fn confirm_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) {
49 let dummy_tx = Transaction { version: 0, lock_time: 0, input: Vec::new(), output: Vec::new() };
50 let dummy_tx_count = tx.version as usize;
51 let mut block = Block {
52 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
53 txdata: vec![dummy_tx; dummy_tx_count],
55 block.txdata.push(tx.clone());
56 connect_block(node, &block, 1);
57 for i in 2..CHAN_CONFIRM_DEPTH {
59 header: BlockHeader { version: 0x20000000, prev_blockhash: block.header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
62 connect_block(node, &block, i);
66 pub fn connect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, depth: u32, height: u32, parent: bool, prev_blockhash: BlockHash) -> BlockHash {
67 let mut block = Block {
68 header: BlockHeader { version: 0x2000000, prev_blockhash: if parent { prev_blockhash } else { Default::default() }, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
71 connect_block(node, &block, height + 1);
72 for i in 2..depth + 1 {
74 header: BlockHeader { version: 0x20000000, prev_blockhash: block.header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
77 connect_block(node, &block, height + i);
79 block.header.block_hash()
82 pub fn connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: &Block, height: u32) {
83 let txdata: Vec<_> = block.txdata.iter().enumerate().collect();
84 node.chain_monitor.chain_monitor.block_connected(&block.header, &txdata, height);
85 node.node.block_connected(&block.header, &txdata, height);
88 pub fn disconnect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, header: &BlockHeader, height: u32) {
89 node.chain_monitor.chain_monitor.block_disconnected(header, height);
90 node.node.block_disconnected(header);
93 pub struct TestChanMonCfg {
94 pub tx_broadcaster: test_utils::TestBroadcaster,
95 pub fee_estimator: test_utils::TestFeeEstimator,
96 pub chain_source: test_utils::TestChainSource,
97 pub persister: test_utils::TestPersister,
98 pub logger: test_utils::TestLogger,
101 pub struct NodeCfg<'a> {
102 pub chain_source: &'a test_utils::TestChainSource,
103 pub tx_broadcaster: &'a test_utils::TestBroadcaster,
104 pub fee_estimator: &'a test_utils::TestFeeEstimator,
105 pub chain_monitor: test_utils::TestChainMonitor<'a>,
106 pub keys_manager: test_utils::TestKeysInterface,
107 pub logger: &'a test_utils::TestLogger,
108 pub node_seed: [u8; 32],
111 pub struct Node<'a, 'b: 'a, 'c: 'b> {
112 pub chain_source: &'c test_utils::TestChainSource,
113 pub tx_broadcaster: &'c test_utils::TestBroadcaster,
114 pub chain_monitor: &'b test_utils::TestChainMonitor<'c>,
115 pub keys_manager: &'b test_utils::TestKeysInterface,
116 pub node: &'a ChannelManager<EnforcingChannelKeys, &'b TestChainMonitor<'c>, &'c test_utils::TestBroadcaster, &'b test_utils::TestKeysInterface, &'c test_utils::TestFeeEstimator, &'c test_utils::TestLogger>,
117 pub net_graph_msg_handler: NetGraphMsgHandler<&'c test_utils::TestChainSource, &'c test_utils::TestLogger>,
118 pub node_seed: [u8; 32],
119 pub network_payment_count: Rc<RefCell<u8>>,
120 pub network_chan_count: Rc<RefCell<u32>>,
121 pub logger: &'c test_utils::TestLogger,
124 impl<'a, 'b, 'c> Drop for Node<'a, 'b, 'c> {
126 if !::std::thread::panicking() {
127 // Check that we processed all pending events
128 assert!(self.node.get_and_clear_pending_msg_events().is_empty());
129 assert!(self.node.get_and_clear_pending_events().is_empty());
130 assert!(self.chain_monitor.added_monitors.lock().unwrap().is_empty());
132 // Check that if we serialize the Router, we can deserialize it again.
134 let mut w = test_utils::TestVecWriter(Vec::new());
135 let network_graph_ser = self.net_graph_msg_handler.network_graph.read().unwrap();
136 network_graph_ser.write(&mut w).unwrap();
137 let network_graph_deser = <NetworkGraph>::read(&mut ::std::io::Cursor::new(&w.0)).unwrap();
138 assert!(network_graph_deser == *self.net_graph_msg_handler.network_graph.read().unwrap());
139 let net_graph_msg_handler = NetGraphMsgHandler::from_net_graph(
140 Some(self.chain_source), self.logger, network_graph_deser
142 let mut chan_progress = 0;
144 let orig_announcements = self.net_graph_msg_handler.get_next_channel_announcements(chan_progress, 255);
145 let deserialized_announcements = net_graph_msg_handler.get_next_channel_announcements(chan_progress, 255);
146 assert!(orig_announcements == deserialized_announcements);
147 chan_progress = match orig_announcements.last() {
148 Some(announcement) => announcement.0.contents.short_channel_id + 1,
152 let mut node_progress = None;
154 let orig_announcements = self.net_graph_msg_handler.get_next_node_announcements(node_progress.as_ref(), 255);
155 let deserialized_announcements = net_graph_msg_handler.get_next_node_announcements(node_progress.as_ref(), 255);
156 assert!(orig_announcements == deserialized_announcements);
157 node_progress = match orig_announcements.last() {
158 Some(announcement) => Some(announcement.contents.node_id),
164 // Check that if we serialize and then deserialize all our channel monitors we get the
165 // same set of outputs to watch for on chain as we have now. Note that if we write
166 // tests that fully close channels and remove the monitors at some point this may break.
167 let feeest = test_utils::TestFeeEstimator { sat_per_kw: 253 };
168 let mut deserialized_monitors = Vec::new();
170 let old_monitors = self.chain_monitor.chain_monitor.monitors.lock().unwrap();
171 for (_, old_monitor) in old_monitors.iter() {
172 let mut w = test_utils::TestVecWriter(Vec::new());
173 old_monitor.serialize_for_disk(&mut w).unwrap();
174 let (_, deserialized_monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(
175 &mut ::std::io::Cursor::new(&w.0)).unwrap();
176 deserialized_monitors.push(deserialized_monitor);
180 // Before using all the new monitors to check the watch outpoints, use the full set of
181 // them to ensure we can write and reload our ChannelManager.
183 let mut channel_monitors = HashMap::new();
184 for monitor in deserialized_monitors.iter_mut() {
185 channel_monitors.insert(monitor.get_funding_txo().0, monitor);
188 let mut w = test_utils::TestVecWriter(Vec::new());
189 self.node.write(&mut w).unwrap();
190 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut ::std::io::Cursor::new(w.0), ChannelManagerReadArgs {
191 default_config: UserConfig::default(),
192 keys_manager: self.keys_manager,
193 fee_estimator: &test_utils::TestFeeEstimator { sat_per_kw: 253 },
194 chain_monitor: self.chain_monitor,
195 tx_broadcaster: &test_utils::TestBroadcaster {
196 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone())
198 logger: &test_utils::TestLogger::new(),
203 let persister = test_utils::TestPersister::new();
204 let broadcaster = test_utils::TestBroadcaster {
205 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone())
207 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
208 let chain_monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &broadcaster, &self.logger, &feeest, &persister);
209 for deserialized_monitor in deserialized_monitors.drain(..) {
210 if let Err(_) = chain_monitor.watch_channel(deserialized_monitor.get_funding_txo().0, deserialized_monitor) {
214 assert_eq!(*chain_source.watched_txn.lock().unwrap(), *self.chain_source.watched_txn.lock().unwrap());
215 assert_eq!(*chain_source.watched_outputs.lock().unwrap(), *self.chain_source.watched_outputs.lock().unwrap());
220 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) {
221 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001, a_flags, b_flags)
224 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) {
225 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);
226 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &funding_locked);
227 (announcement, as_update, bs_update, channel_id, tx)
230 macro_rules! get_revoke_commit_msgs {
231 ($node: expr, $node_id: expr) => {
233 let events = $node.node.get_and_clear_pending_msg_events();
234 assert_eq!(events.len(), 2);
236 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
237 assert_eq!(*node_id, $node_id);
240 _ => panic!("Unexpected event"),
242 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
243 assert_eq!(*node_id, $node_id);
244 assert!(updates.update_add_htlcs.is_empty());
245 assert!(updates.update_fulfill_htlcs.is_empty());
246 assert!(updates.update_fail_htlcs.is_empty());
247 assert!(updates.update_fail_malformed_htlcs.is_empty());
248 assert!(updates.update_fee.is_none());
249 updates.commitment_signed.clone()
251 _ => panic!("Unexpected event"),
257 /// Get an specific event message from the pending events queue.
259 macro_rules! get_event_msg {
260 ($node: expr, $event_type: path, $node_id: expr) => {
262 let events = $node.node.get_and_clear_pending_msg_events();
263 assert_eq!(events.len(), 1);
265 $event_type { ref node_id, ref msg } => {
266 assert_eq!(*node_id, $node_id);
269 _ => panic!("Unexpected event"),
276 macro_rules! get_htlc_update_msgs {
277 ($node: expr, $node_id: expr) => {
279 let events = $node.node.get_and_clear_pending_msg_events();
280 assert_eq!(events.len(), 1);
282 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
283 assert_eq!(*node_id, $node_id);
286 _ => panic!("Unexpected event"),
293 macro_rules! get_feerate {
294 ($node: expr, $channel_id: expr) => {
296 let chan_lock = $node.node.channel_state.lock().unwrap();
297 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
304 macro_rules! get_local_commitment_txn {
305 ($node: expr, $channel_id: expr) => {
307 let mut monitors = $node.chain_monitor.chain_monitor.monitors.lock().unwrap();
308 let mut commitment_txn = None;
309 for (funding_txo, monitor) in monitors.iter_mut() {
310 if funding_txo.to_channel_id() == $channel_id {
311 commitment_txn = Some(monitor.unsafe_get_latest_holder_commitment_txn(&$node.logger));
315 commitment_txn.unwrap()
320 /// Check the error from attempting a payment.
322 macro_rules! unwrap_send_err {
323 ($res: expr, $all_failed: expr, $type: pat, $check: expr) => {
325 &Err(PaymentSendFailure::AllFailedRetrySafe(ref fails)) if $all_failed => {
326 assert_eq!(fails.len(), 1);
332 &Err(PaymentSendFailure::PartialFailure(ref fails)) if !$all_failed => {
333 assert_eq!(fails.len(), 1);
335 Err($type) => { $check },
344 /// Check whether N channel monitor(s) have been added.
346 macro_rules! check_added_monitors {
347 ($node: expr, $count: expr) => {
349 let mut added_monitors = $node.chain_monitor.added_monitors.lock().unwrap();
350 assert_eq!(added_monitors.len(), $count);
351 added_monitors.clear();
356 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) {
357 let chan_id = *node.network_chan_count.borrow();
359 let events = node.node.get_and_clear_pending_events();
360 assert_eq!(events.len(), 1);
362 Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
363 assert_eq!(*channel_value_satoshis, expected_chan_value);
364 assert_eq!(user_channel_id, expected_user_chan_id);
366 let tx = Transaction { version: chan_id as i32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
367 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
369 let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
370 (*temporary_channel_id, tx, funding_outpoint)
372 _ => panic!("Unexpected event"),
376 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 {
377 node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
378 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()));
379 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()));
381 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, channel_value, 42);
383 node_a.node.funding_transaction_generated(&temporary_channel_id, funding_output);
384 check_added_monitors!(node_a, 0);
386 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()));
388 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
389 assert_eq!(added_monitors.len(), 1);
390 assert_eq!(added_monitors[0].0, funding_output);
391 added_monitors.clear();
394 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()));
396 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
397 assert_eq!(added_monitors.len(), 1);
398 assert_eq!(added_monitors[0].0, funding_output);
399 added_monitors.clear();
402 let events_4 = node_a.node.get_and_clear_pending_events();
403 assert_eq!(events_4.len(), 1);
405 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
406 assert_eq!(user_channel_id, 42);
407 assert_eq!(*funding_txo, funding_output);
409 _ => panic!("Unexpected event"),
415 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) {
416 confirm_transaction(node_conf, tx);
417 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()));
420 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]) {
422 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
423 assert_eq!(events_6.len(), 2);
424 ((match events_6[0] {
425 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
426 channel_id = msg.channel_id.clone();
427 assert_eq!(*node_id, node_recv.node.get_our_node_id());
430 _ => panic!("Unexpected event"),
431 }, match events_6[1] {
432 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
433 assert_eq!(*node_id, node_recv.node.get_our_node_id());
436 _ => panic!("Unexpected event"),
440 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]) {
441 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx);
442 confirm_transaction(node_a, tx);
443 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
446 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) {
447 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat, a_flags, b_flags);
448 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
452 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) {
453 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
454 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
455 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
457 let events_7 = node_b.node.get_and_clear_pending_msg_events();
458 assert_eq!(events_7.len(), 1);
459 let (announcement, bs_update) = match events_7[0] {
460 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
463 _ => panic!("Unexpected event"),
466 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
467 let events_8 = node_a.node.get_and_clear_pending_msg_events();
468 assert_eq!(events_8.len(), 1);
469 let as_update = match events_8[0] {
470 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
471 assert!(*announcement == *msg);
472 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
473 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
476 _ => panic!("Unexpected event"),
479 *node_a.network_chan_count.borrow_mut() += 1;
481 ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
484 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) {
485 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001, a_flags, b_flags)
488 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) {
489 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat, a_flags, b_flags);
491 nodes[a].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
492 let a_events = nodes[a].node.get_and_clear_pending_msg_events();
493 assert_eq!(a_events.len(), 1);
494 let a_node_announcement = match a_events[0] {
495 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
498 _ => panic!("Unexpected event"),
501 nodes[b].node.broadcast_node_announcement([1, 1, 1], [1; 32], Vec::new());
502 let b_events = nodes[b].node.get_and_clear_pending_msg_events();
503 assert_eq!(b_events.len(), 1);
504 let b_node_announcement = match b_events[0] {
505 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
508 _ => panic!("Unexpected event"),
512 assert!(node.net_graph_msg_handler.handle_channel_announcement(&chan_announcement.0).unwrap());
513 node.net_graph_msg_handler.handle_channel_update(&chan_announcement.1).unwrap();
514 node.net_graph_msg_handler.handle_channel_update(&chan_announcement.2).unwrap();
515 node.net_graph_msg_handler.handle_node_announcement(&a_node_announcement).unwrap();
516 node.net_graph_msg_handler.handle_node_announcement(&b_node_announcement).unwrap();
518 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
521 macro_rules! check_spends {
522 ($tx: expr, $($spends_txn: expr),*) => {
524 let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
526 if out_point.txid == $spends_txn.txid() {
527 return $spends_txn.output.get(out_point.vout as usize).cloned()
532 let mut total_value_in = 0;
533 for input in $tx.input.iter() {
534 total_value_in += get_output(&input.previous_output).unwrap().value;
536 let mut total_value_out = 0;
537 for output in $tx.output.iter() {
538 total_value_out += output.value;
540 let min_fee = ($tx.get_weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
541 // Input amount - output amount = fee, so check that out + min_fee is smaller than input
542 assert!(total_value_out + min_fee <= total_value_in);
543 $tx.verify(get_output).unwrap();
548 macro_rules! get_closing_signed_broadcast {
549 ($node: expr, $dest_pubkey: expr) => {
551 let events = $node.get_and_clear_pending_msg_events();
552 assert!(events.len() == 1 || events.len() == 2);
553 (match events[events.len() - 1] {
554 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
555 assert_eq!(msg.contents.flags & 2, 2);
558 _ => panic!("Unexpected event"),
559 }, if events.len() == 2 {
561 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
562 assert_eq!(*node_id, $dest_pubkey);
565 _ => panic!("Unexpected event"),
572 /// Check that a channel's closing channel update has been broadcasted, and optionally
573 /// check whether an error message event has occurred.
575 macro_rules! check_closed_broadcast {
576 ($node: expr, $with_error_msg: expr) => {{
577 let events = $node.node.get_and_clear_pending_msg_events();
578 assert_eq!(events.len(), if $with_error_msg { 2 } else { 1 });
580 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
581 assert_eq!(msg.contents.flags & 2, 2);
583 _ => panic!("Unexpected event"),
587 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
588 // TODO: Check node_id
591 _ => panic!("Unexpected event"),
597 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) {
598 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) };
599 let (node_b, broadcaster_b) = if close_inbound_first { (&outbound_node.node, &outbound_node.tx_broadcaster) } else { (&inbound_node.node, &inbound_node.tx_broadcaster) };
602 node_a.close_channel(channel_id).unwrap();
603 node_b.handle_shutdown(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id()));
605 let events_1 = node_b.get_and_clear_pending_msg_events();
606 assert!(events_1.len() >= 1);
607 let shutdown_b = match events_1[0] {
608 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
609 assert_eq!(node_id, &node_a.get_our_node_id());
612 _ => panic!("Unexpected event"),
615 let closing_signed_b = if !close_inbound_first {
616 assert_eq!(events_1.len(), 1);
619 Some(match events_1[1] {
620 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
621 assert_eq!(node_id, &node_a.get_our_node_id());
624 _ => panic!("Unexpected event"),
628 node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b);
629 let (as_update, bs_update) = if close_inbound_first {
630 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
631 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
632 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
633 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
634 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
636 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
637 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
638 assert!(none_b.is_none());
639 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
640 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
641 (as_update, bs_update)
643 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
645 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
646 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
647 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
648 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
650 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
651 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
652 assert!(none_a.is_none());
653 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
654 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
655 (as_update, bs_update)
657 assert_eq!(tx_a, tx_b);
658 check_spends!(tx_a, funding_tx);
660 (as_update, bs_update, tx_a)
663 pub struct SendEvent {
664 pub node_id: PublicKey,
665 pub msgs: Vec<msgs::UpdateAddHTLC>,
666 pub commitment_msg: msgs::CommitmentSigned,
669 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
670 assert!(updates.update_fulfill_htlcs.is_empty());
671 assert!(updates.update_fail_htlcs.is_empty());
672 assert!(updates.update_fail_malformed_htlcs.is_empty());
673 assert!(updates.update_fee.is_none());
674 SendEvent { node_id: node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
677 pub fn from_event(event: MessageSendEvent) -> SendEvent {
679 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
680 _ => panic!("Unexpected event type!"),
684 pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
685 let mut events = node.node.get_and_clear_pending_msg_events();
686 assert_eq!(events.len(), 1);
687 SendEvent::from_event(events.pop().unwrap())
691 macro_rules! commitment_signed_dance {
692 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
694 check_added_monitors!($node_a, 0);
695 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
696 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
697 check_added_monitors!($node_a, 1);
698 commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
701 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
703 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
704 check_added_monitors!($node_b, 0);
705 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
706 $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack);
707 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
708 check_added_monitors!($node_b, 1);
709 $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed);
710 let (bs_revoke_and_ack, extra_msg_option) = {
711 let events = $node_b.node.get_and_clear_pending_msg_events();
712 assert!(events.len() <= 2);
714 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
715 assert_eq!(*node_id, $node_a.node.get_our_node_id());
718 _ => panic!("Unexpected event"),
719 }, events.get(1).map(|e| e.clone()))
721 check_added_monitors!($node_b, 1);
723 assert!($node_a.node.get_and_clear_pending_events().is_empty());
724 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
726 (extra_msg_option, bs_revoke_and_ack)
729 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
731 check_added_monitors!($node_a, 0);
732 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
733 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
734 check_added_monitors!($node_a, 1);
735 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
736 assert!(extra_msg_option.is_none());
740 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
742 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
743 $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack);
744 check_added_monitors!($node_a, 1);
748 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
750 assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
753 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
755 commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
757 expect_pending_htlcs_forwardable!($node_a);
758 check_added_monitors!($node_a, 1);
760 let channel_state = $node_a.node.channel_state.lock().unwrap();
761 assert_eq!(channel_state.pending_msg_events.len(), 1);
762 if let MessageSendEvent::UpdateHTLCs { ref node_id, .. } = channel_state.pending_msg_events[0] {
763 assert_ne!(*node_id, $node_b.node.get_our_node_id());
764 } else { panic!("Unexpected event"); }
766 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
772 /// Get a payment preimage and hash.
774 macro_rules! get_payment_preimage_hash {
777 let payment_preimage = PaymentPreimage([*$node.network_payment_count.borrow(); 32]);
778 *$node.network_payment_count.borrow_mut() += 1;
779 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
780 (payment_preimage, payment_hash)
785 macro_rules! expect_pending_htlcs_forwardable_ignore {
787 let events = $node.node.get_and_clear_pending_events();
788 assert_eq!(events.len(), 1);
790 Event::PendingHTLCsForwardable { .. } => { },
791 _ => panic!("Unexpected event"),
796 macro_rules! expect_pending_htlcs_forwardable {
798 expect_pending_htlcs_forwardable_ignore!($node);
799 $node.node.process_pending_htlc_forwards();
804 macro_rules! expect_payment_received {
805 ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
806 let events = $node.node.get_and_clear_pending_events();
807 assert_eq!(events.len(), 1);
809 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
810 assert_eq!($expected_payment_hash, *payment_hash);
811 assert_eq!(None, *payment_secret);
812 assert_eq!($expected_recv_value, amt);
814 _ => panic!("Unexpected event"),
819 macro_rules! expect_payment_sent {
820 ($node: expr, $expected_payment_preimage: expr) => {
821 let events = $node.node.get_and_clear_pending_events();
822 assert_eq!(events.len(), 1);
824 Event::PaymentSent { ref payment_preimage } => {
825 assert_eq!($expected_payment_preimage, *payment_preimage);
827 _ => panic!("Unexpected event"),
833 macro_rules! expect_payment_failed {
834 ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
835 let events = $node.node.get_and_clear_pending_events();
836 assert_eq!(events.len(), 1);
838 Event::PaymentFailed { ref payment_hash, rejected_by_dest, ref error_code, ref error_data } => {
839 assert_eq!(*payment_hash, $expected_payment_hash);
840 assert_eq!(rejected_by_dest, $rejected_by_dest);
841 assert!(error_code.is_some());
842 assert!(error_data.is_some());
844 assert_eq!(error_code.unwrap(), $expected_error_code);
845 assert_eq!(&error_data.as_ref().unwrap()[..], $expected_error_data);
848 _ => panic!("Unexpected event"),
853 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>) {
854 origin_node.node.send_payment(&route, our_payment_hash, &our_payment_secret).unwrap();
855 check_added_monitors!(origin_node, expected_paths.len());
856 pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
859 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) {
860 let mut payment_event = SendEvent::from_event(ev);
861 let mut prev_node = origin_node;
863 for (idx, &node) in expected_path.iter().enumerate() {
864 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
866 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
867 check_added_monitors!(node, 0);
868 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
870 expect_pending_htlcs_forwardable!(node);
872 if idx == expected_path.len() - 1 {
873 let events_2 = node.node.get_and_clear_pending_events();
874 if payment_received_expected {
875 assert_eq!(events_2.len(), 1);
877 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
878 assert_eq!(our_payment_hash, *payment_hash);
879 assert_eq!(our_payment_secret, *payment_secret);
880 assert_eq!(amt, recv_value);
882 _ => panic!("Unexpected event"),
885 assert!(events_2.is_empty());
888 let mut events_2 = node.node.get_and_clear_pending_msg_events();
889 assert_eq!(events_2.len(), 1);
890 check_added_monitors!(node, 1);
891 payment_event = SendEvent::from_event(events_2.remove(0));
892 assert_eq!(payment_event.msgs.len(), 1);
899 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>) {
900 let mut events = origin_node.node.get_and_clear_pending_msg_events();
901 assert_eq!(events.len(), expected_route.len());
902 for (path_idx, (ev, expected_path)) in events.drain(..).zip(expected_route.iter()).enumerate() {
903 // Once we've gotten through all the HTLCs, the last one should result in a
904 // PaymentReceived (but each previous one should not!), .
905 let expect_payment = path_idx == expected_route.len() - 1;
906 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), our_payment_secret, ev, expect_payment);
910 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) {
911 send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, None);
914 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) {
915 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(origin_node);
916 send_along_route_with_hash(origin_node, route, expected_route, recv_value, our_payment_hash);
917 (our_payment_preimage, our_payment_hash)
920 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) {
921 for path in expected_paths.iter() {
922 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
924 assert!(expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage, &our_payment_secret, expected_amount));
925 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
927 macro_rules! msgs_from_ev {
930 &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 } } => {
931 assert!(update_add_htlcs.is_empty());
932 assert_eq!(update_fulfill_htlcs.len(), 1);
933 assert!(update_fail_htlcs.is_empty());
934 assert!(update_fail_malformed_htlcs.is_empty());
935 assert!(update_fee.is_none());
936 ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
938 _ => panic!("Unexpected event"),
942 let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
943 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
944 assert_eq!(events.len(), expected_paths.len());
945 for ev in events.iter() {
946 per_path_msgs.push(msgs_from_ev!(ev));
949 for (expected_route, (path_msgs, next_hop)) in expected_paths.iter().zip(per_path_msgs.drain(..)) {
950 let mut next_msgs = Some(path_msgs);
951 let mut expected_next_node = next_hop;
953 macro_rules! last_update_fulfill_dance {
954 ($node: expr, $prev_node: expr) => {
956 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
957 check_added_monitors!($node, 0);
958 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
959 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
963 macro_rules! mid_update_fulfill_dance {
964 ($node: expr, $prev_node: expr, $new_msgs: expr) => {
966 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
967 check_added_monitors!($node, 1);
968 let new_next_msgs = if $new_msgs {
969 let events = $node.node.get_and_clear_pending_msg_events();
970 assert_eq!(events.len(), 1);
971 let (res, nexthop) = msgs_from_ev!(&events[0]);
972 expected_next_node = nexthop;
975 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
978 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
979 next_msgs = new_next_msgs;
984 let mut prev_node = expected_route.last().unwrap();
985 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
986 assert_eq!(expected_next_node, node.node.get_our_node_id());
987 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
988 if next_msgs.is_some() {
989 mid_update_fulfill_dance!(node, prev_node, update_next_msgs);
991 assert!(!update_next_msgs);
992 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
994 if !skip_last && idx == expected_route.len() - 1 {
995 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1002 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
1003 expect_payment_sent!(origin_node, our_payment_preimage);
1008 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) {
1009 claim_payment_along_route_with_secret(origin_node, &[expected_route], skip_last, our_payment_preimage, None, expected_amount);
1012 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) {
1013 claim_payment_along_route(origin_node, expected_route, false, our_payment_preimage, expected_amount);
1016 pub const TEST_FINAL_CLTV: u32 = 32;
1018 pub fn route_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) -> (PaymentPreimage, PaymentHash) {
1019 let net_graph_msg_handler = &origin_node.net_graph_msg_handler;
1020 let logger = test_utils::TestLogger::new();
1021 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();
1022 assert_eq!(route.paths.len(), 1);
1023 assert_eq!(route.paths[0].len(), expected_route.len());
1024 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1025 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1028 send_along_route(origin_node, route, expected_route, recv_value)
1031 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
1032 let logger = test_utils::TestLogger::new();
1033 let net_graph_msg_handler = &origin_node.net_graph_msg_handler;
1034 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();
1035 assert_eq!(route.paths.len(), 1);
1036 assert_eq!(route.paths[0].len(), expected_route.len());
1037 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1038 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1041 let (_, our_payment_hash) = get_payment_preimage_hash!(origin_node);
1042 unwrap_send_err!(origin_node.node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
1043 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
1046 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64, expected_value: u64) {
1047 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
1048 claim_payment(&origin, expected_route, our_payment_preimage, expected_value);
1051 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) {
1052 assert!(expected_route.last().unwrap().node.fail_htlc_backwards(&our_payment_hash, &None));
1053 expect_pending_htlcs_forwardable!(expected_route.last().unwrap());
1054 check_added_monitors!(expected_route.last().unwrap(), 1);
1056 let mut next_msgs: Option<(msgs::UpdateFailHTLC, msgs::CommitmentSigned)> = None;
1057 macro_rules! update_fail_dance {
1058 ($node: expr, $prev_node: expr, $last_node: expr) => {
1060 $node.node.handle_update_fail_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1061 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, !$last_node);
1062 if skip_last && $last_node {
1063 expect_pending_htlcs_forwardable!($node);
1069 let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
1070 let mut prev_node = expected_route.last().unwrap();
1071 for (idx, node) in expected_route.iter().rev().enumerate() {
1072 assert_eq!(expected_next_node, node.node.get_our_node_id());
1073 if next_msgs.is_some() {
1074 // We may be the "last node" for the purpose of the commitment dance if we're
1075 // skipping the last node (implying it is disconnected) and we're the
1076 // second-to-last node!
1077 update_fail_dance!(node, prev_node, skip_last && idx == expected_route.len() - 1);
1080 let events = node.node.get_and_clear_pending_msg_events();
1081 if !skip_last || idx != expected_route.len() - 1 {
1082 assert_eq!(events.len(), 1);
1084 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 } } => {
1085 assert!(update_add_htlcs.is_empty());
1086 assert!(update_fulfill_htlcs.is_empty());
1087 assert_eq!(update_fail_htlcs.len(), 1);
1088 assert!(update_fail_malformed_htlcs.is_empty());
1089 assert!(update_fee.is_none());
1090 expected_next_node = node_id.clone();
1091 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
1093 _ => panic!("Unexpected event"),
1096 assert!(events.is_empty());
1098 if !skip_last && idx == expected_route.len() - 1 {
1099 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1106 update_fail_dance!(origin_node, expected_route.first().unwrap(), true);
1108 let events = origin_node.node.get_and_clear_pending_events();
1109 assert_eq!(events.len(), 1);
1111 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
1112 assert_eq!(payment_hash, our_payment_hash);
1113 assert!(rejected_by_dest);
1115 _ => panic!("Unexpected event"),
1120 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash) {
1121 fail_payment_along_route(origin_node, expected_route, false, our_payment_hash);
1124 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
1125 let mut chan_mon_cfgs = Vec::new();
1126 for i in 0..node_count {
1127 let tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())};
1128 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
1129 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
1130 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
1131 let persister = test_utils::TestPersister::new();
1132 chan_mon_cfgs.push(TestChanMonCfg{ tx_broadcaster, fee_estimator, chain_source, logger, persister });
1138 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
1139 let mut nodes = Vec::new();
1141 for i in 0..node_count {
1142 let seed = [i as u8; 32];
1143 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
1144 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);
1145 nodes.push(NodeCfg { chain_source: &chanmon_cfgs[i].chain_source, logger: &chanmon_cfgs[i].logger, tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster, fee_estimator: &chanmon_cfgs[i].fee_estimator, chain_monitor, keys_manager, node_seed: seed });
1151 pub fn create_node_chanmgrs<'a, 'b>(node_count: usize, cfgs: &'a Vec<NodeCfg<'b>>, node_config: &[Option<UserConfig>]) -> Vec<ChannelManager<EnforcingChannelKeys, &'a TestChainMonitor<'b>, &'b test_utils::TestBroadcaster, &'a test_utils::TestKeysInterface, &'b test_utils::TestFeeEstimator, &'b test_utils::TestLogger>> {
1152 let mut chanmgrs = Vec::new();
1153 for i in 0..node_count {
1154 let mut default_config = UserConfig::default();
1155 default_config.channel_options.announced_channel = true;
1156 default_config.peer_channel_config_limits.force_announced_channel_preference = false;
1157 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
1158 let node = ChannelManager::new(Network::Testnet, cfgs[i].fee_estimator, &cfgs[i].chain_monitor, cfgs[i].tx_broadcaster, cfgs[i].logger, &cfgs[i].keys_manager, if node_config[i].is_some() { node_config[i].clone().unwrap() } else { default_config }, 0);
1159 chanmgrs.push(node);
1165 pub fn create_network<'a, 'b: 'a, 'c: 'b>(node_count: usize, cfgs: &'b Vec<NodeCfg<'c>>, chan_mgrs: &'a Vec<ChannelManager<EnforcingChannelKeys, &'b TestChainMonitor<'c>, &'c test_utils::TestBroadcaster, &'b test_utils::TestKeysInterface, &'c test_utils::TestFeeEstimator, &'c test_utils::TestLogger>>) -> Vec<Node<'a, 'b, 'c>> {
1166 let mut nodes = Vec::new();
1167 let chan_count = Rc::new(RefCell::new(0));
1168 let payment_count = Rc::new(RefCell::new(0));
1170 for i in 0..node_count {
1171 let net_graph_msg_handler = NetGraphMsgHandler::new(None, cfgs[i].logger);
1172 nodes.push(Node{ chain_source: cfgs[i].chain_source,
1173 tx_broadcaster: cfgs[i].tx_broadcaster, chain_monitor: &cfgs[i].chain_monitor,
1174 keys_manager: &cfgs[i].keys_manager, node: &chan_mgrs[i], net_graph_msg_handler,
1175 node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
1176 network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
1183 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 138; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
1184 pub const OFFERED_HTLC_SCRIPT_WEIGHT: usize = 133;
1186 #[derive(PartialEq)]
1187 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
1188 /// Tests that the given node has broadcast transactions for the given Channel
1190 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
1191 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
1192 /// broadcast and the revoked outputs were claimed.
1194 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
1195 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
1197 /// All broadcast transactions must be accounted for in one of the above three types of we'll
1199 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> {
1200 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1201 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
1203 let mut res = Vec::with_capacity(2);
1204 node_txn.retain(|tx| {
1205 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
1206 check_spends!(tx, chan.3);
1207 if commitment_tx.is_none() {
1208 res.push(tx.clone());
1213 if let Some(explicit_tx) = commitment_tx {
1214 res.push(explicit_tx.clone());
1217 assert_eq!(res.len(), 1);
1219 if has_htlc_tx != HTLCType::NONE {
1220 node_txn.retain(|tx| {
1221 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
1222 check_spends!(tx, res[0]);
1223 if has_htlc_tx == HTLCType::TIMEOUT {
1224 assert!(tx.lock_time != 0);
1226 assert!(tx.lock_time == 0);
1228 res.push(tx.clone());
1232 assert!(res.len() == 2 || res.len() == 3);
1234 assert_eq!(res[1], res[2]);
1238 assert!(node_txn.is_empty());
1242 /// Tests that the given node has broadcast a claim transaction against the provided revoked
1243 /// HTLC transaction.
1244 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
1245 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1246 // We may issue multiple claiming transaction on revoked outputs due to block rescan
1247 // for revoked htlc outputs
1248 if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
1249 node_txn.retain(|tx| {
1250 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
1251 check_spends!(tx, revoked_tx);
1255 node_txn.retain(|tx| {
1256 check_spends!(tx, commitment_revoked_tx);
1259 assert!(node_txn.is_empty());
1262 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
1263 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1265 assert!(node_txn.len() >= 1);
1266 assert_eq!(node_txn[0].input.len(), 1);
1267 let mut found_prev = false;
1269 for tx in prev_txn {
1270 if node_txn[0].input[0].previous_output.txid == tx.txid() {
1271 check_spends!(node_txn[0], tx);
1272 assert!(node_txn[0].input[0].witness[2].len() > 106); // must spend an htlc output
1273 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
1279 assert!(found_prev);
1281 let mut res = Vec::new();
1282 mem::swap(&mut *node_txn, &mut res);
1286 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize) {
1287 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
1288 assert_eq!(events_1.len(), 1);
1289 let as_update = match events_1[0] {
1290 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1293 _ => panic!("Unexpected event"),
1296 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
1297 assert_eq!(events_2.len(), 1);
1298 let bs_update = match events_2[0] {
1299 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1302 _ => panic!("Unexpected event"),
1306 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
1307 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
1312 macro_rules! get_channel_value_stat {
1313 ($node: expr, $channel_id: expr) => {{
1314 let chan_lock = $node.node.channel_state.lock().unwrap();
1315 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
1316 chan.get_value_stat()
1320 macro_rules! get_chan_reestablish_msgs {
1321 ($src_node: expr, $dst_node: expr) => {
1323 let mut res = Vec::with_capacity(1);
1324 for msg in $src_node.node.get_and_clear_pending_msg_events() {
1325 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
1326 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1327 res.push(msg.clone());
1329 panic!("Unexpected event")
1337 macro_rules! handle_chan_reestablish_msgs {
1338 ($src_node: expr, $dst_node: expr) => {
1340 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
1342 let funding_locked = if let Some(&MessageSendEvent::SendFundingLocked { ref node_id, ref msg }) = msg_events.get(0) {
1344 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1350 let mut revoke_and_ack = None;
1351 let mut commitment_update = None;
1352 let order = if let Some(ev) = msg_events.get(idx) {
1355 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1356 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1357 revoke_and_ack = Some(msg.clone());
1358 RAACommitmentOrder::RevokeAndACKFirst
1360 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1361 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1362 commitment_update = Some(updates.clone());
1363 RAACommitmentOrder::CommitmentFirst
1365 _ => panic!("Unexpected event"),
1368 RAACommitmentOrder::CommitmentFirst
1371 if let Some(ev) = msg_events.get(idx) {
1373 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1374 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1375 assert!(revoke_and_ack.is_none());
1376 revoke_and_ack = Some(msg.clone());
1378 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1379 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1380 assert!(commitment_update.is_none());
1381 commitment_update = Some(updates.clone());
1383 _ => panic!("Unexpected event"),
1387 (funding_locked, revoke_and_ack, commitment_update, order)
1392 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
1393 /// for claims/fails they are separated out.
1394 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)) {
1395 node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1396 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
1397 node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1398 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
1400 if send_funding_locked.0 {
1401 // If a expects a funding_locked, it better not think it has received a revoke_and_ack
1403 for reestablish in reestablish_1.iter() {
1404 assert_eq!(reestablish.next_remote_commitment_number, 0);
1407 if send_funding_locked.1 {
1408 // If b expects a funding_locked, it better not think it has received a revoke_and_ack
1410 for reestablish in reestablish_2.iter() {
1411 assert_eq!(reestablish.next_remote_commitment_number, 0);
1414 if send_funding_locked.0 || send_funding_locked.1 {
1415 // If we expect any funding_locked's, both sides better have set
1416 // next_holder_commitment_number to 1
1417 for reestablish in reestablish_1.iter() {
1418 assert_eq!(reestablish.next_local_commitment_number, 1);
1420 for reestablish in reestablish_2.iter() {
1421 assert_eq!(reestablish.next_local_commitment_number, 1);
1425 let mut resp_1 = Vec::new();
1426 for msg in reestablish_1 {
1427 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
1428 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
1430 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
1431 check_added_monitors!(node_b, 1);
1433 check_added_monitors!(node_b, 0);
1436 let mut resp_2 = Vec::new();
1437 for msg in reestablish_2 {
1438 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
1439 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
1441 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
1442 check_added_monitors!(node_a, 1);
1444 check_added_monitors!(node_a, 0);
1447 // We don't yet support both needing updates, as that would require a different commitment dance:
1448 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
1449 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
1451 for chan_msgs in resp_1.drain(..) {
1452 if send_funding_locked.0 {
1453 node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
1454 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
1455 if !announcement_event.is_empty() {
1456 assert_eq!(announcement_event.len(), 1);
1457 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1458 //TODO: Test announcement_sigs re-sending
1459 } else { panic!("Unexpected event!"); }
1462 assert!(chan_msgs.0.is_none());
1465 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1466 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
1467 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1468 check_added_monitors!(node_a, 1);
1470 assert!(chan_msgs.1.is_none());
1472 if pending_htlc_adds.0 != 0 || pending_htlc_claims.0 != 0 || pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
1473 let commitment_update = chan_msgs.2.unwrap();
1474 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1475 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
1477 assert!(commitment_update.update_add_htlcs.is_empty());
1479 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
1480 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
1481 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1482 for update_add in commitment_update.update_add_htlcs {
1483 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
1485 for update_fulfill in commitment_update.update_fulfill_htlcs {
1486 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
1488 for update_fail in commitment_update.update_fail_htlcs {
1489 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
1492 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1493 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
1495 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
1496 check_added_monitors!(node_a, 1);
1497 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
1498 // No commitment_signed so get_event_msg's assert(len == 1) passes
1499 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
1500 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1501 check_added_monitors!(node_b, 1);
1504 assert!(chan_msgs.2.is_none());
1508 for chan_msgs in resp_2.drain(..) {
1509 if send_funding_locked.1 {
1510 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
1511 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
1512 if !announcement_event.is_empty() {
1513 assert_eq!(announcement_event.len(), 1);
1514 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1515 //TODO: Test announcement_sigs re-sending
1516 } else { panic!("Unexpected event!"); }
1519 assert!(chan_msgs.0.is_none());
1522 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1523 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
1524 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1525 check_added_monitors!(node_b, 1);
1527 assert!(chan_msgs.1.is_none());
1529 if pending_htlc_adds.1 != 0 || pending_htlc_claims.1 != 0 || pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
1530 let commitment_update = chan_msgs.2.unwrap();
1531 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
1532 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
1534 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
1535 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
1536 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1537 for update_add in commitment_update.update_add_htlcs {
1538 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
1540 for update_fulfill in commitment_update.update_fulfill_htlcs {
1541 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
1543 for update_fail in commitment_update.update_fail_htlcs {
1544 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
1547 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
1548 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
1550 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
1551 check_added_monitors!(node_b, 1);
1552 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
1553 // No commitment_signed so get_event_msg's assert(len == 1) passes
1554 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1555 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1556 check_added_monitors!(node_a, 1);
1559 assert!(chan_msgs.2.is_none());