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::EnforcingSigner;
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,
99 pub keys_manager: test_utils::TestKeysInterface,
102 pub struct NodeCfg<'a> {
103 pub chain_source: &'a test_utils::TestChainSource,
104 pub tx_broadcaster: &'a test_utils::TestBroadcaster,
105 pub fee_estimator: &'a test_utils::TestFeeEstimator,
106 pub chain_monitor: test_utils::TestChainMonitor<'a>,
107 pub keys_manager: &'a test_utils::TestKeysInterface,
108 pub logger: &'a test_utils::TestLogger,
109 pub node_seed: [u8; 32],
112 pub struct Node<'a, 'b: 'a, 'c: 'b> {
113 pub chain_source: &'c test_utils::TestChainSource,
114 pub tx_broadcaster: &'c test_utils::TestBroadcaster,
115 pub chain_monitor: &'b test_utils::TestChainMonitor<'c>,
116 pub keys_manager: &'b test_utils::TestKeysInterface,
117 pub node: &'a ChannelManager<EnforcingSigner, &'b TestChainMonitor<'c>, &'c test_utils::TestBroadcaster, &'b test_utils::TestKeysInterface, &'c test_utils::TestFeeEstimator, &'c test_utils::TestLogger>,
118 pub net_graph_msg_handler: NetGraphMsgHandler<&'c test_utils::TestChainSource, &'c test_utils::TestLogger>,
119 pub node_seed: [u8; 32],
120 pub network_payment_count: Rc<RefCell<u8>>,
121 pub network_chan_count: Rc<RefCell<u32>>,
122 pub logger: &'c test_utils::TestLogger,
125 impl<'a, 'b, 'c> Drop for Node<'a, 'b, 'c> {
127 if !::std::thread::panicking() {
128 // Check that we processed all pending events
129 assert!(self.node.get_and_clear_pending_msg_events().is_empty());
130 assert!(self.node.get_and_clear_pending_events().is_empty());
131 assert!(self.chain_monitor.added_monitors.lock().unwrap().is_empty());
133 // Check that if we serialize the Router, we can deserialize it again.
135 let mut w = test_utils::TestVecWriter(Vec::new());
136 let network_graph_ser = self.net_graph_msg_handler.network_graph.read().unwrap();
137 network_graph_ser.write(&mut w).unwrap();
138 let network_graph_deser = <NetworkGraph>::read(&mut ::std::io::Cursor::new(&w.0)).unwrap();
139 assert!(network_graph_deser == *self.net_graph_msg_handler.network_graph.read().unwrap());
140 let net_graph_msg_handler = NetGraphMsgHandler::from_net_graph(
141 Some(self.chain_source), self.logger, network_graph_deser
143 let mut chan_progress = 0;
145 let orig_announcements = self.net_graph_msg_handler.get_next_channel_announcements(chan_progress, 255);
146 let deserialized_announcements = net_graph_msg_handler.get_next_channel_announcements(chan_progress, 255);
147 assert!(orig_announcements == deserialized_announcements);
148 chan_progress = match orig_announcements.last() {
149 Some(announcement) => announcement.0.contents.short_channel_id + 1,
153 let mut node_progress = None;
155 let orig_announcements = self.net_graph_msg_handler.get_next_node_announcements(node_progress.as_ref(), 255);
156 let deserialized_announcements = net_graph_msg_handler.get_next_node_announcements(node_progress.as_ref(), 255);
157 assert!(orig_announcements == deserialized_announcements);
158 node_progress = match orig_announcements.last() {
159 Some(announcement) => Some(announcement.contents.node_id),
165 // Check that if we serialize and then deserialize all our channel monitors we get the
166 // same set of outputs to watch for on chain as we have now. Note that if we write
167 // tests that fully close channels and remove the monitors at some point this may break.
168 let feeest = test_utils::TestFeeEstimator { sat_per_kw: 253 };
169 let mut deserialized_monitors = Vec::new();
171 let old_monitors = self.chain_monitor.chain_monitor.monitors.lock().unwrap();
172 for (_, old_monitor) in old_monitors.iter() {
173 let mut w = test_utils::TestVecWriter(Vec::new());
174 old_monitor.write(&mut w).unwrap();
175 let (_, deserialized_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
176 &mut ::std::io::Cursor::new(&w.0), self.keys_manager).unwrap();
177 deserialized_monitors.push(deserialized_monitor);
181 // Before using all the new monitors to check the watch outpoints, use the full set of
182 // them to ensure we can write and reload our ChannelManager.
184 let mut channel_monitors = HashMap::new();
185 for monitor in deserialized_monitors.iter_mut() {
186 channel_monitors.insert(monitor.get_funding_txo().0, monitor);
189 let mut w = test_utils::TestVecWriter(Vec::new());
190 self.node.write(&mut w).unwrap();
191 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut ::std::io::Cursor::new(w.0), ChannelManagerReadArgs {
192 default_config: UserConfig::default(),
193 keys_manager: self.keys_manager,
194 fee_estimator: &test_utils::TestFeeEstimator { sat_per_kw: 253 },
195 chain_monitor: self.chain_monitor,
196 tx_broadcaster: &test_utils::TestBroadcaster {
197 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone())
199 logger: &test_utils::TestLogger::new(),
204 let persister = test_utils::TestPersister::new();
205 let broadcaster = test_utils::TestBroadcaster {
206 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone())
208 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
209 let chain_monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &broadcaster, &self.logger, &feeest, &persister, &self.keys_manager);
210 for deserialized_monitor in deserialized_monitors.drain(..) {
211 if let Err(_) = chain_monitor.watch_channel(deserialized_monitor.get_funding_txo().0, deserialized_monitor) {
215 assert_eq!(*chain_source.watched_txn.lock().unwrap(), *self.chain_source.watched_txn.lock().unwrap());
216 assert_eq!(*chain_source.watched_outputs.lock().unwrap(), *self.chain_source.watched_outputs.lock().unwrap());
221 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) {
222 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001, a_flags, b_flags)
225 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) {
226 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);
227 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &funding_locked);
228 (announcement, as_update, bs_update, channel_id, tx)
231 macro_rules! get_revoke_commit_msgs {
232 ($node: expr, $node_id: expr) => {
234 let events = $node.node.get_and_clear_pending_msg_events();
235 assert_eq!(events.len(), 2);
237 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
238 assert_eq!(*node_id, $node_id);
241 _ => panic!("Unexpected event"),
243 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
244 assert_eq!(*node_id, $node_id);
245 assert!(updates.update_add_htlcs.is_empty());
246 assert!(updates.update_fulfill_htlcs.is_empty());
247 assert!(updates.update_fail_htlcs.is_empty());
248 assert!(updates.update_fail_malformed_htlcs.is_empty());
249 assert!(updates.update_fee.is_none());
250 updates.commitment_signed.clone()
252 _ => panic!("Unexpected event"),
258 /// Get an specific event message from the pending events queue.
260 macro_rules! get_event_msg {
261 ($node: expr, $event_type: path, $node_id: expr) => {
263 let events = $node.node.get_and_clear_pending_msg_events();
264 assert_eq!(events.len(), 1);
266 $event_type { ref node_id, ref msg } => {
267 assert_eq!(*node_id, $node_id);
270 _ => panic!("Unexpected event"),
277 macro_rules! get_htlc_update_msgs {
278 ($node: expr, $node_id: expr) => {
280 let events = $node.node.get_and_clear_pending_msg_events();
281 assert_eq!(events.len(), 1);
283 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
284 assert_eq!(*node_id, $node_id);
287 _ => panic!("Unexpected event"),
294 macro_rules! get_feerate {
295 ($node: expr, $channel_id: expr) => {
297 let chan_lock = $node.node.channel_state.lock().unwrap();
298 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
305 macro_rules! get_local_commitment_txn {
306 ($node: expr, $channel_id: expr) => {
308 let mut monitors = $node.chain_monitor.chain_monitor.monitors.lock().unwrap();
309 let mut commitment_txn = None;
310 for (funding_txo, monitor) in monitors.iter_mut() {
311 if funding_txo.to_channel_id() == $channel_id {
312 commitment_txn = Some(monitor.unsafe_get_latest_holder_commitment_txn(&$node.logger));
316 commitment_txn.unwrap()
321 /// Check the error from attempting a payment.
323 macro_rules! unwrap_send_err {
324 ($res: expr, $all_failed: expr, $type: pat, $check: expr) => {
326 &Err(PaymentSendFailure::AllFailedRetrySafe(ref fails)) if $all_failed => {
327 assert_eq!(fails.len(), 1);
333 &Err(PaymentSendFailure::PartialFailure(ref fails)) if !$all_failed => {
334 assert_eq!(fails.len(), 1);
336 Err($type) => { $check },
345 /// Check whether N channel monitor(s) have been added.
347 macro_rules! check_added_monitors {
348 ($node: expr, $count: expr) => {
350 let mut added_monitors = $node.chain_monitor.added_monitors.lock().unwrap();
351 assert_eq!(added_monitors.len(), $count);
352 added_monitors.clear();
357 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) {
358 let chan_id = *node.network_chan_count.borrow();
360 let events = node.node.get_and_clear_pending_events();
361 assert_eq!(events.len(), 1);
363 Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
364 assert_eq!(*channel_value_satoshis, expected_chan_value);
365 assert_eq!(user_channel_id, expected_user_chan_id);
367 let tx = Transaction { version: chan_id as i32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
368 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
370 let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
371 (*temporary_channel_id, tx, funding_outpoint)
373 _ => panic!("Unexpected event"),
377 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 {
378 node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
379 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()));
380 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()));
382 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, channel_value, 42);
384 node_a.node.funding_transaction_generated(&temporary_channel_id, funding_output);
385 check_added_monitors!(node_a, 0);
387 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()));
389 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
390 assert_eq!(added_monitors.len(), 1);
391 assert_eq!(added_monitors[0].0, funding_output);
392 added_monitors.clear();
395 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()));
397 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
398 assert_eq!(added_monitors.len(), 1);
399 assert_eq!(added_monitors[0].0, funding_output);
400 added_monitors.clear();
403 let events_4 = node_a.node.get_and_clear_pending_events();
404 assert_eq!(events_4.len(), 1);
406 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
407 assert_eq!(user_channel_id, 42);
408 assert_eq!(*funding_txo, funding_output);
410 _ => panic!("Unexpected event"),
416 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) {
417 confirm_transaction(node_conf, tx);
418 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()));
421 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]) {
423 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
424 assert_eq!(events_6.len(), 2);
425 ((match events_6[0] {
426 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
427 channel_id = msg.channel_id.clone();
428 assert_eq!(*node_id, node_recv.node.get_our_node_id());
431 _ => panic!("Unexpected event"),
432 }, match events_6[1] {
433 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
434 assert_eq!(*node_id, node_recv.node.get_our_node_id());
437 _ => panic!("Unexpected event"),
441 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]) {
442 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx);
443 confirm_transaction(node_a, tx);
444 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
447 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) {
448 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat, a_flags, b_flags);
449 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
453 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) {
454 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
455 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
456 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
458 let events_7 = node_b.node.get_and_clear_pending_msg_events();
459 assert_eq!(events_7.len(), 1);
460 let (announcement, bs_update) = match events_7[0] {
461 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
464 _ => panic!("Unexpected event"),
467 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
468 let events_8 = node_a.node.get_and_clear_pending_msg_events();
469 assert_eq!(events_8.len(), 1);
470 let as_update = match events_8[0] {
471 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
472 assert!(*announcement == *msg);
473 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
474 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
477 _ => panic!("Unexpected event"),
480 *node_a.network_chan_count.borrow_mut() += 1;
482 ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
485 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) {
486 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001, a_flags, b_flags)
489 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) {
490 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat, a_flags, b_flags);
491 update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
492 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
495 pub fn update_nodes_with_chan_announce<'a, 'b, 'c, 'd>(nodes: &'a Vec<Node<'b, 'c, 'd>>, a: usize, b: usize, ann: &msgs::ChannelAnnouncement, upd_1: &msgs::ChannelUpdate, upd_2: &msgs::ChannelUpdate) {
496 nodes[a].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
497 let a_events = nodes[a].node.get_and_clear_pending_msg_events();
498 assert_eq!(a_events.len(), 1);
499 let a_node_announcement = match a_events[0] {
500 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
503 _ => panic!("Unexpected event"),
506 nodes[b].node.broadcast_node_announcement([1, 1, 1], [1; 32], Vec::new());
507 let b_events = nodes[b].node.get_and_clear_pending_msg_events();
508 assert_eq!(b_events.len(), 1);
509 let b_node_announcement = match b_events[0] {
510 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
513 _ => panic!("Unexpected event"),
517 assert!(node.net_graph_msg_handler.handle_channel_announcement(ann).unwrap());
518 node.net_graph_msg_handler.handle_channel_update(upd_1).unwrap();
519 node.net_graph_msg_handler.handle_channel_update(upd_2).unwrap();
520 node.net_graph_msg_handler.handle_node_announcement(&a_node_announcement).unwrap();
521 node.net_graph_msg_handler.handle_node_announcement(&b_node_announcement).unwrap();
525 macro_rules! check_spends {
526 ($tx: expr, $($spends_txn: expr),*) => {
528 let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
530 if out_point.txid == $spends_txn.txid() {
531 return $spends_txn.output.get(out_point.vout as usize).cloned()
536 let mut total_value_in = 0;
537 for input in $tx.input.iter() {
538 total_value_in += get_output(&input.previous_output).unwrap().value;
540 let mut total_value_out = 0;
541 for output in $tx.output.iter() {
542 total_value_out += output.value;
544 let min_fee = ($tx.get_weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
545 // Input amount - output amount = fee, so check that out + min_fee is smaller than input
546 assert!(total_value_out + min_fee <= total_value_in);
547 $tx.verify(get_output).unwrap();
552 macro_rules! get_closing_signed_broadcast {
553 ($node: expr, $dest_pubkey: expr) => {
555 let events = $node.get_and_clear_pending_msg_events();
556 assert!(events.len() == 1 || events.len() == 2);
557 (match events[events.len() - 1] {
558 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
559 assert_eq!(msg.contents.flags & 2, 2);
562 _ => panic!("Unexpected event"),
563 }, if events.len() == 2 {
565 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
566 assert_eq!(*node_id, $dest_pubkey);
569 _ => panic!("Unexpected event"),
576 /// Check that a channel's closing channel update has been broadcasted, and optionally
577 /// check whether an error message event has occurred.
579 macro_rules! check_closed_broadcast {
580 ($node: expr, $with_error_msg: expr) => {{
581 let events = $node.node.get_and_clear_pending_msg_events();
582 assert_eq!(events.len(), if $with_error_msg { 2 } else { 1 });
584 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
585 assert_eq!(msg.contents.flags & 2, 2);
587 _ => panic!("Unexpected event"),
591 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
592 // TODO: Check node_id
595 _ => panic!("Unexpected event"),
601 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) {
602 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) };
603 let (node_b, broadcaster_b) = if close_inbound_first { (&outbound_node.node, &outbound_node.tx_broadcaster) } else { (&inbound_node.node, &inbound_node.tx_broadcaster) };
606 node_a.close_channel(channel_id).unwrap();
607 node_b.handle_shutdown(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id()));
609 let events_1 = node_b.get_and_clear_pending_msg_events();
610 assert!(events_1.len() >= 1);
611 let shutdown_b = match events_1[0] {
612 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
613 assert_eq!(node_id, &node_a.get_our_node_id());
616 _ => panic!("Unexpected event"),
619 let closing_signed_b = if !close_inbound_first {
620 assert_eq!(events_1.len(), 1);
623 Some(match events_1[1] {
624 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
625 assert_eq!(node_id, &node_a.get_our_node_id());
628 _ => panic!("Unexpected event"),
632 node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b);
633 let (as_update, bs_update) = if close_inbound_first {
634 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
635 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
636 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
637 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
638 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
640 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
641 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
642 assert!(none_b.is_none());
643 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
644 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
645 (as_update, bs_update)
647 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
649 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
650 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
651 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
652 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
654 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
655 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
656 assert!(none_a.is_none());
657 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
658 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
659 (as_update, bs_update)
661 assert_eq!(tx_a, tx_b);
662 check_spends!(tx_a, funding_tx);
664 (as_update, bs_update, tx_a)
667 pub struct SendEvent {
668 pub node_id: PublicKey,
669 pub msgs: Vec<msgs::UpdateAddHTLC>,
670 pub commitment_msg: msgs::CommitmentSigned,
673 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
674 assert!(updates.update_fulfill_htlcs.is_empty());
675 assert!(updates.update_fail_htlcs.is_empty());
676 assert!(updates.update_fail_malformed_htlcs.is_empty());
677 assert!(updates.update_fee.is_none());
678 SendEvent { node_id: node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
681 pub fn from_event(event: MessageSendEvent) -> SendEvent {
683 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
684 _ => panic!("Unexpected event type!"),
688 pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
689 let mut events = node.node.get_and_clear_pending_msg_events();
690 assert_eq!(events.len(), 1);
691 SendEvent::from_event(events.pop().unwrap())
695 macro_rules! commitment_signed_dance {
696 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
698 check_added_monitors!($node_a, 0);
699 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
700 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
701 check_added_monitors!($node_a, 1);
702 commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
705 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
707 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
708 check_added_monitors!($node_b, 0);
709 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
710 $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack);
711 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
712 check_added_monitors!($node_b, 1);
713 $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed);
714 let (bs_revoke_and_ack, extra_msg_option) = {
715 let events = $node_b.node.get_and_clear_pending_msg_events();
716 assert!(events.len() <= 2);
718 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
719 assert_eq!(*node_id, $node_a.node.get_our_node_id());
722 _ => panic!("Unexpected event"),
723 }, events.get(1).map(|e| e.clone()))
725 check_added_monitors!($node_b, 1);
727 assert!($node_a.node.get_and_clear_pending_events().is_empty());
728 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
730 (extra_msg_option, bs_revoke_and_ack)
733 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
735 check_added_monitors!($node_a, 0);
736 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
737 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
738 check_added_monitors!($node_a, 1);
739 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
740 assert!(extra_msg_option.is_none());
744 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
746 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
747 $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack);
748 check_added_monitors!($node_a, 1);
752 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
754 assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
757 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
759 commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
761 expect_pending_htlcs_forwardable!($node_a);
762 check_added_monitors!($node_a, 1);
764 let channel_state = $node_a.node.channel_state.lock().unwrap();
765 assert_eq!(channel_state.pending_msg_events.len(), 1);
766 if let MessageSendEvent::UpdateHTLCs { ref node_id, .. } = channel_state.pending_msg_events[0] {
767 assert_ne!(*node_id, $node_b.node.get_our_node_id());
768 } else { panic!("Unexpected event"); }
770 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
776 /// Get a payment preimage and hash.
778 macro_rules! get_payment_preimage_hash {
781 let payment_preimage = PaymentPreimage([*$node.network_payment_count.borrow(); 32]);
782 *$node.network_payment_count.borrow_mut() += 1;
783 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
784 (payment_preimage, payment_hash)
789 macro_rules! expect_pending_htlcs_forwardable_ignore {
791 let events = $node.node.get_and_clear_pending_events();
792 assert_eq!(events.len(), 1);
794 Event::PendingHTLCsForwardable { .. } => { },
795 _ => panic!("Unexpected event"),
800 macro_rules! expect_pending_htlcs_forwardable {
802 expect_pending_htlcs_forwardable_ignore!($node);
803 $node.node.process_pending_htlc_forwards();
808 macro_rules! expect_payment_received {
809 ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
810 let events = $node.node.get_and_clear_pending_events();
811 assert_eq!(events.len(), 1);
813 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
814 assert_eq!($expected_payment_hash, *payment_hash);
815 assert_eq!(None, *payment_secret);
816 assert_eq!($expected_recv_value, amt);
818 _ => panic!("Unexpected event"),
823 macro_rules! expect_payment_sent {
824 ($node: expr, $expected_payment_preimage: expr) => {
825 let events = $node.node.get_and_clear_pending_events();
826 assert_eq!(events.len(), 1);
828 Event::PaymentSent { ref payment_preimage } => {
829 assert_eq!($expected_payment_preimage, *payment_preimage);
831 _ => panic!("Unexpected event"),
837 macro_rules! expect_payment_failed {
838 ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
839 let events = $node.node.get_and_clear_pending_events();
840 assert_eq!(events.len(), 1);
842 Event::PaymentFailed { ref payment_hash, rejected_by_dest, ref error_code, ref error_data } => {
843 assert_eq!(*payment_hash, $expected_payment_hash);
844 assert_eq!(rejected_by_dest, $rejected_by_dest);
845 assert!(error_code.is_some());
846 assert!(error_data.is_some());
848 assert_eq!(error_code.unwrap(), $expected_error_code);
849 assert_eq!(&error_data.as_ref().unwrap()[..], $expected_error_data);
852 _ => panic!("Unexpected event"),
857 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>) {
858 origin_node.node.send_payment(&route, our_payment_hash, &our_payment_secret).unwrap();
859 check_added_monitors!(origin_node, expected_paths.len());
860 pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
863 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) {
864 let mut payment_event = SendEvent::from_event(ev);
865 let mut prev_node = origin_node;
867 for (idx, &node) in expected_path.iter().enumerate() {
868 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
870 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
871 check_added_monitors!(node, 0);
872 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
874 expect_pending_htlcs_forwardable!(node);
876 if idx == expected_path.len() - 1 {
877 let events_2 = node.node.get_and_clear_pending_events();
878 if payment_received_expected {
879 assert_eq!(events_2.len(), 1);
881 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
882 assert_eq!(our_payment_hash, *payment_hash);
883 assert_eq!(our_payment_secret, *payment_secret);
884 assert_eq!(amt, recv_value);
886 _ => panic!("Unexpected event"),
889 assert!(events_2.is_empty());
892 let mut events_2 = node.node.get_and_clear_pending_msg_events();
893 assert_eq!(events_2.len(), 1);
894 check_added_monitors!(node, 1);
895 payment_event = SendEvent::from_event(events_2.remove(0));
896 assert_eq!(payment_event.msgs.len(), 1);
903 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>) {
904 let mut events = origin_node.node.get_and_clear_pending_msg_events();
905 assert_eq!(events.len(), expected_route.len());
906 for (path_idx, (ev, expected_path)) in events.drain(..).zip(expected_route.iter()).enumerate() {
907 // Once we've gotten through all the HTLCs, the last one should result in a
908 // PaymentReceived (but each previous one should not!), .
909 let expect_payment = path_idx == expected_route.len() - 1;
910 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), our_payment_secret, ev, expect_payment);
914 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) {
915 send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, None);
918 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) {
919 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(origin_node);
920 send_along_route_with_hash(origin_node, route, expected_route, recv_value, our_payment_hash);
921 (our_payment_preimage, our_payment_hash)
924 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) {
925 for path in expected_paths.iter() {
926 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
928 assert!(expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage, &our_payment_secret, expected_amount));
929 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
931 macro_rules! msgs_from_ev {
934 &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 } } => {
935 assert!(update_add_htlcs.is_empty());
936 assert_eq!(update_fulfill_htlcs.len(), 1);
937 assert!(update_fail_htlcs.is_empty());
938 assert!(update_fail_malformed_htlcs.is_empty());
939 assert!(update_fee.is_none());
940 ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
942 _ => panic!("Unexpected event"),
946 let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
947 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
948 assert_eq!(events.len(), expected_paths.len());
949 for ev in events.iter() {
950 per_path_msgs.push(msgs_from_ev!(ev));
953 for (expected_route, (path_msgs, next_hop)) in expected_paths.iter().zip(per_path_msgs.drain(..)) {
954 let mut next_msgs = Some(path_msgs);
955 let mut expected_next_node = next_hop;
957 macro_rules! last_update_fulfill_dance {
958 ($node: expr, $prev_node: expr) => {
960 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
961 check_added_monitors!($node, 0);
962 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
963 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
967 macro_rules! mid_update_fulfill_dance {
968 ($node: expr, $prev_node: expr, $new_msgs: expr) => {
970 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
971 check_added_monitors!($node, 1);
972 let new_next_msgs = if $new_msgs {
973 let events = $node.node.get_and_clear_pending_msg_events();
974 assert_eq!(events.len(), 1);
975 let (res, nexthop) = msgs_from_ev!(&events[0]);
976 expected_next_node = nexthop;
979 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
982 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
983 next_msgs = new_next_msgs;
988 let mut prev_node = expected_route.last().unwrap();
989 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
990 assert_eq!(expected_next_node, node.node.get_our_node_id());
991 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
992 if next_msgs.is_some() {
993 mid_update_fulfill_dance!(node, prev_node, update_next_msgs);
995 assert!(!update_next_msgs);
996 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
998 if !skip_last && idx == expected_route.len() - 1 {
999 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1006 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
1007 expect_payment_sent!(origin_node, our_payment_preimage);
1012 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) {
1013 claim_payment_along_route_with_secret(origin_node, &[expected_route], skip_last, our_payment_preimage, None, expected_amount);
1016 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) {
1017 claim_payment_along_route(origin_node, expected_route, false, our_payment_preimage, expected_amount);
1020 pub const TEST_FINAL_CLTV: u32 = 32;
1022 pub fn route_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) -> (PaymentPreimage, PaymentHash) {
1023 let net_graph_msg_handler = &origin_node.net_graph_msg_handler;
1024 let logger = test_utils::TestLogger::new();
1025 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();
1026 assert_eq!(route.paths.len(), 1);
1027 assert_eq!(route.paths[0].len(), expected_route.len());
1028 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1029 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1032 send_along_route(origin_node, route, expected_route, recv_value)
1035 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
1036 let logger = test_utils::TestLogger::new();
1037 let net_graph_msg_handler = &origin_node.net_graph_msg_handler;
1038 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();
1039 assert_eq!(route.paths.len(), 1);
1040 assert_eq!(route.paths[0].len(), expected_route.len());
1041 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1042 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1045 let (_, our_payment_hash) = get_payment_preimage_hash!(origin_node);
1046 unwrap_send_err!(origin_node.node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
1047 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
1050 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64, expected_value: u64) {
1051 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
1052 claim_payment(&origin, expected_route, our_payment_preimage, expected_value);
1055 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) {
1056 assert!(expected_route.last().unwrap().node.fail_htlc_backwards(&our_payment_hash, &None));
1057 expect_pending_htlcs_forwardable!(expected_route.last().unwrap());
1058 check_added_monitors!(expected_route.last().unwrap(), 1);
1060 let mut next_msgs: Option<(msgs::UpdateFailHTLC, msgs::CommitmentSigned)> = None;
1061 macro_rules! update_fail_dance {
1062 ($node: expr, $prev_node: expr, $last_node: expr) => {
1064 $node.node.handle_update_fail_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1065 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, !$last_node);
1066 if skip_last && $last_node {
1067 expect_pending_htlcs_forwardable!($node);
1073 let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
1074 let mut prev_node = expected_route.last().unwrap();
1075 for (idx, node) in expected_route.iter().rev().enumerate() {
1076 assert_eq!(expected_next_node, node.node.get_our_node_id());
1077 if next_msgs.is_some() {
1078 // We may be the "last node" for the purpose of the commitment dance if we're
1079 // skipping the last node (implying it is disconnected) and we're the
1080 // second-to-last node!
1081 update_fail_dance!(node, prev_node, skip_last && idx == expected_route.len() - 1);
1084 let events = node.node.get_and_clear_pending_msg_events();
1085 if !skip_last || idx != expected_route.len() - 1 {
1086 assert_eq!(events.len(), 1);
1088 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 } } => {
1089 assert!(update_add_htlcs.is_empty());
1090 assert!(update_fulfill_htlcs.is_empty());
1091 assert_eq!(update_fail_htlcs.len(), 1);
1092 assert!(update_fail_malformed_htlcs.is_empty());
1093 assert!(update_fee.is_none());
1094 expected_next_node = node_id.clone();
1095 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
1097 _ => panic!("Unexpected event"),
1100 assert!(events.is_empty());
1102 if !skip_last && idx == expected_route.len() - 1 {
1103 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1110 update_fail_dance!(origin_node, expected_route.first().unwrap(), true);
1112 let events = origin_node.node.get_and_clear_pending_events();
1113 assert_eq!(events.len(), 1);
1115 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
1116 assert_eq!(payment_hash, our_payment_hash);
1117 assert!(rejected_by_dest);
1119 _ => panic!("Unexpected event"),
1124 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash) {
1125 fail_payment_along_route(origin_node, expected_route, false, our_payment_hash);
1128 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
1129 let mut chan_mon_cfgs = Vec::new();
1130 for i in 0..node_count {
1131 let tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())};
1132 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
1133 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
1134 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
1135 let persister = test_utils::TestPersister::new();
1136 let seed = [i as u8; 32];
1137 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
1139 chan_mon_cfgs.push(TestChanMonCfg{ tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager });
1145 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
1146 let mut nodes = Vec::new();
1148 for i in 0..node_count {
1149 let chain_monitor = test_utils::TestChainMonitor::new(Some(&chanmon_cfgs[i].chain_source), &chanmon_cfgs[i].tx_broadcaster, &chanmon_cfgs[i].logger, &chanmon_cfgs[i].fee_estimator, &chanmon_cfgs[i].persister, &chanmon_cfgs[i].keys_manager);
1150 let seed = [i as u8; 32];
1151 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: &chanmon_cfgs[i].keys_manager, node_seed: seed });
1157 pub fn create_node_chanmgrs<'a, 'b>(node_count: usize, cfgs: &'a Vec<NodeCfg<'b>>, node_config: &[Option<UserConfig>]) -> Vec<ChannelManager<EnforcingSigner, &'a TestChainMonitor<'b>, &'b test_utils::TestBroadcaster, &'a test_utils::TestKeysInterface, &'b test_utils::TestFeeEstimator, &'b test_utils::TestLogger>> {
1158 let mut chanmgrs = Vec::new();
1159 for i in 0..node_count {
1160 let mut default_config = UserConfig::default();
1161 default_config.channel_options.announced_channel = true;
1162 default_config.peer_channel_config_limits.force_announced_channel_preference = false;
1163 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
1164 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);
1165 chanmgrs.push(node);
1171 pub fn create_network<'a, 'b: 'a, 'c: 'b>(node_count: usize, cfgs: &'b Vec<NodeCfg<'c>>, chan_mgrs: &'a Vec<ChannelManager<EnforcingSigner, &'b TestChainMonitor<'c>, &'c test_utils::TestBroadcaster, &'b test_utils::TestKeysInterface, &'c test_utils::TestFeeEstimator, &'c test_utils::TestLogger>>) -> Vec<Node<'a, 'b, 'c>> {
1172 let mut nodes = Vec::new();
1173 let chan_count = Rc::new(RefCell::new(0));
1174 let payment_count = Rc::new(RefCell::new(0));
1176 for i in 0..node_count {
1177 let net_graph_msg_handler = NetGraphMsgHandler::new(cfgs[i].chain_source.genesis_hash, None, cfgs[i].logger);
1178 nodes.push(Node{ chain_source: cfgs[i].chain_source,
1179 tx_broadcaster: cfgs[i].tx_broadcaster, chain_monitor: &cfgs[i].chain_monitor,
1180 keys_manager: &cfgs[i].keys_manager, node: &chan_mgrs[i], net_graph_msg_handler,
1181 node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
1182 network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
1189 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 138; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
1190 pub const OFFERED_HTLC_SCRIPT_WEIGHT: usize = 133;
1192 #[derive(PartialEq)]
1193 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
1194 /// Tests that the given node has broadcast transactions for the given Channel
1196 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
1197 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
1198 /// broadcast and the revoked outputs were claimed.
1200 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
1201 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
1203 /// All broadcast transactions must be accounted for in one of the above three types of we'll
1205 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> {
1206 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1207 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
1209 let mut res = Vec::with_capacity(2);
1210 node_txn.retain(|tx| {
1211 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
1212 check_spends!(tx, chan.3);
1213 if commitment_tx.is_none() {
1214 res.push(tx.clone());
1219 if let Some(explicit_tx) = commitment_tx {
1220 res.push(explicit_tx.clone());
1223 assert_eq!(res.len(), 1);
1225 if has_htlc_tx != HTLCType::NONE {
1226 node_txn.retain(|tx| {
1227 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
1228 check_spends!(tx, res[0]);
1229 if has_htlc_tx == HTLCType::TIMEOUT {
1230 assert!(tx.lock_time != 0);
1232 assert!(tx.lock_time == 0);
1234 res.push(tx.clone());
1238 assert!(res.len() == 2 || res.len() == 3);
1240 assert_eq!(res[1], res[2]);
1244 assert!(node_txn.is_empty());
1248 /// Tests that the given node has broadcast a claim transaction against the provided revoked
1249 /// HTLC transaction.
1250 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
1251 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1252 // We may issue multiple claiming transaction on revoked outputs due to block rescan
1253 // for revoked htlc outputs
1254 if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
1255 node_txn.retain(|tx| {
1256 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
1257 check_spends!(tx, revoked_tx);
1261 node_txn.retain(|tx| {
1262 check_spends!(tx, commitment_revoked_tx);
1265 assert!(node_txn.is_empty());
1268 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
1269 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1271 assert!(node_txn.len() >= 1);
1272 assert_eq!(node_txn[0].input.len(), 1);
1273 let mut found_prev = false;
1275 for tx in prev_txn {
1276 if node_txn[0].input[0].previous_output.txid == tx.txid() {
1277 check_spends!(node_txn[0], tx);
1278 assert!(node_txn[0].input[0].witness[2].len() > 106); // must spend an htlc output
1279 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
1285 assert!(found_prev);
1287 let mut res = Vec::new();
1288 mem::swap(&mut *node_txn, &mut res);
1292 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize) {
1293 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
1294 assert_eq!(events_1.len(), 1);
1295 let as_update = match events_1[0] {
1296 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1299 _ => panic!("Unexpected event"),
1302 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
1303 assert_eq!(events_2.len(), 1);
1304 let bs_update = match events_2[0] {
1305 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1308 _ => panic!("Unexpected event"),
1312 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
1313 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
1318 macro_rules! get_channel_value_stat {
1319 ($node: expr, $channel_id: expr) => {{
1320 let chan_lock = $node.node.channel_state.lock().unwrap();
1321 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
1322 chan.get_value_stat()
1326 macro_rules! get_chan_reestablish_msgs {
1327 ($src_node: expr, $dst_node: expr) => {
1329 let mut res = Vec::with_capacity(1);
1330 for msg in $src_node.node.get_and_clear_pending_msg_events() {
1331 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
1332 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1333 res.push(msg.clone());
1335 panic!("Unexpected event")
1343 macro_rules! handle_chan_reestablish_msgs {
1344 ($src_node: expr, $dst_node: expr) => {
1346 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
1348 let funding_locked = if let Some(&MessageSendEvent::SendFundingLocked { ref node_id, ref msg }) = msg_events.get(0) {
1350 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1356 let mut revoke_and_ack = None;
1357 let mut commitment_update = None;
1358 let order = if let Some(ev) = msg_events.get(idx) {
1361 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1362 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1363 revoke_and_ack = Some(msg.clone());
1364 RAACommitmentOrder::RevokeAndACKFirst
1366 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1367 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1368 commitment_update = Some(updates.clone());
1369 RAACommitmentOrder::CommitmentFirst
1371 _ => panic!("Unexpected event"),
1374 RAACommitmentOrder::CommitmentFirst
1377 if let Some(ev) = msg_events.get(idx) {
1379 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1380 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1381 assert!(revoke_and_ack.is_none());
1382 revoke_and_ack = Some(msg.clone());
1384 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1385 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1386 assert!(commitment_update.is_none());
1387 commitment_update = Some(updates.clone());
1389 _ => panic!("Unexpected event"),
1393 (funding_locked, revoke_and_ack, commitment_update, order)
1398 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
1399 /// for claims/fails they are separated out.
1400 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)) {
1401 node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1402 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
1403 node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1404 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
1406 if send_funding_locked.0 {
1407 // If a expects a funding_locked, it better not think it has received a revoke_and_ack
1409 for reestablish in reestablish_1.iter() {
1410 assert_eq!(reestablish.next_remote_commitment_number, 0);
1413 if send_funding_locked.1 {
1414 // If b expects a funding_locked, it better not think it has received a revoke_and_ack
1416 for reestablish in reestablish_2.iter() {
1417 assert_eq!(reestablish.next_remote_commitment_number, 0);
1420 if send_funding_locked.0 || send_funding_locked.1 {
1421 // If we expect any funding_locked's, both sides better have set
1422 // next_holder_commitment_number to 1
1423 for reestablish in reestablish_1.iter() {
1424 assert_eq!(reestablish.next_local_commitment_number, 1);
1426 for reestablish in reestablish_2.iter() {
1427 assert_eq!(reestablish.next_local_commitment_number, 1);
1431 let mut resp_1 = Vec::new();
1432 for msg in reestablish_1 {
1433 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
1434 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
1436 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
1437 check_added_monitors!(node_b, 1);
1439 check_added_monitors!(node_b, 0);
1442 let mut resp_2 = Vec::new();
1443 for msg in reestablish_2 {
1444 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
1445 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
1447 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
1448 check_added_monitors!(node_a, 1);
1450 check_added_monitors!(node_a, 0);
1453 // We don't yet support both needing updates, as that would require a different commitment dance:
1454 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
1455 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
1457 for chan_msgs in resp_1.drain(..) {
1458 if send_funding_locked.0 {
1459 node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
1460 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
1461 if !announcement_event.is_empty() {
1462 assert_eq!(announcement_event.len(), 1);
1463 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1464 //TODO: Test announcement_sigs re-sending
1465 } else { panic!("Unexpected event!"); }
1468 assert!(chan_msgs.0.is_none());
1471 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1472 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
1473 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1474 check_added_monitors!(node_a, 1);
1476 assert!(chan_msgs.1.is_none());
1478 if pending_htlc_adds.0 != 0 || pending_htlc_claims.0 != 0 || pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
1479 let commitment_update = chan_msgs.2.unwrap();
1480 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1481 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
1483 assert!(commitment_update.update_add_htlcs.is_empty());
1485 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
1486 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
1487 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1488 for update_add in commitment_update.update_add_htlcs {
1489 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
1491 for update_fulfill in commitment_update.update_fulfill_htlcs {
1492 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
1494 for update_fail in commitment_update.update_fail_htlcs {
1495 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
1498 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1499 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
1501 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
1502 check_added_monitors!(node_a, 1);
1503 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
1504 // No commitment_signed so get_event_msg's assert(len == 1) passes
1505 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
1506 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1507 check_added_monitors!(node_b, 1);
1510 assert!(chan_msgs.2.is_none());
1514 for chan_msgs in resp_2.drain(..) {
1515 if send_funding_locked.1 {
1516 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
1517 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
1518 if !announcement_event.is_empty() {
1519 assert_eq!(announcement_event.len(), 1);
1520 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1521 //TODO: Test announcement_sigs re-sending
1522 } else { panic!("Unexpected event!"); }
1525 assert!(chan_msgs.0.is_none());
1528 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1529 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
1530 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1531 check_added_monitors!(node_b, 1);
1533 assert!(chan_msgs.1.is_none());
1535 if pending_htlc_adds.1 != 0 || pending_htlc_claims.1 != 0 || pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
1536 let commitment_update = chan_msgs.2.unwrap();
1537 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
1538 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
1540 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
1541 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
1542 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1543 for update_add in commitment_update.update_add_htlcs {
1544 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
1546 for update_fulfill in commitment_update.update_fulfill_htlcs {
1547 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
1549 for update_fail in commitment_update.update_fail_htlcs {
1550 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
1553 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
1554 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
1556 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
1557 check_added_monitors!(node_b, 1);
1558 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
1559 // No commitment_signed so get_event_msg's assert(len == 1) passes
1560 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1561 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1562 check_added_monitors!(node_a, 1);
1565 assert!(chan_msgs.2.is_none());