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::{ChainParameters, 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::constants::genesis_block;
32 use bitcoin::blockdata::transaction::{Transaction, TxOut};
33 use bitcoin::network::constants::Network;
35 use bitcoin::hashes::sha256::Hash as Sha256;
36 use bitcoin::hashes::Hash;
37 use bitcoin::hash_types::BlockHash;
39 use bitcoin::secp256k1::key::PublicKey;
41 use std::cell::RefCell;
45 use std::collections::HashMap;
47 pub const CHAN_CONFIRM_DEPTH: u32 = 100;
49 pub fn confirm_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) {
50 let dummy_tx = Transaction { version: 0, lock_time: 0, input: Vec::new(), output: Vec::new() };
51 let dummy_tx_count = tx.version as usize;
52 let mut block = Block {
53 header: BlockHeader { version: 0x20000000, prev_blockhash: node.best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
54 txdata: vec![dummy_tx; dummy_tx_count],
56 block.txdata.push(tx.clone());
57 connect_block(node, &block, 1);
58 for i in 2..CHAN_CONFIRM_DEPTH {
60 header: BlockHeader { version: 0x20000000, prev_blockhash: block.header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
63 connect_block(node, &block, i);
67 pub fn connect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, depth: u32, height: u32, parent: bool, prev_blockhash: BlockHash) -> BlockHash {
68 let mut block = Block {
69 header: BlockHeader { version: 0x2000000, prev_blockhash: if parent { prev_blockhash } else { Default::default() }, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
72 connect_block(node, &block, height + 1);
73 for i in 2..depth + 1 {
75 header: BlockHeader { version: 0x20000000, prev_blockhash: block.header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
78 connect_block(node, &block, height + i);
80 block.header.block_hash()
83 pub fn connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: &Block, height: u32) {
84 let txdata: Vec<_> = block.txdata.iter().enumerate().collect();
85 node.chain_monitor.chain_monitor.block_connected(&block.header, &txdata, height);
86 node.node.block_connected(&block.header, &txdata, height);
87 node.node.test_process_background_events();
88 node.blocks.borrow_mut().push((block.header, height));
91 pub fn disconnect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, header: &BlockHeader, height: u32) {
92 node.chain_monitor.chain_monitor.block_disconnected(header, height);
93 node.node.block_disconnected(header);
94 node.node.test_process_background_events();
95 node.blocks.borrow_mut().pop();
98 pub struct TestChanMonCfg {
99 pub tx_broadcaster: test_utils::TestBroadcaster,
100 pub fee_estimator: test_utils::TestFeeEstimator,
101 pub chain_source: test_utils::TestChainSource,
102 pub persister: test_utils::TestPersister,
103 pub logger: test_utils::TestLogger,
104 pub keys_manager: test_utils::TestKeysInterface,
107 pub struct NodeCfg<'a> {
108 pub chain_source: &'a test_utils::TestChainSource,
109 pub tx_broadcaster: &'a test_utils::TestBroadcaster,
110 pub fee_estimator: &'a test_utils::TestFeeEstimator,
111 pub chain_monitor: test_utils::TestChainMonitor<'a>,
112 pub keys_manager: &'a test_utils::TestKeysInterface,
113 pub logger: &'a test_utils::TestLogger,
114 pub node_seed: [u8; 32],
117 pub struct Node<'a, 'b: 'a, 'c: 'b> {
118 pub chain_source: &'c test_utils::TestChainSource,
119 pub tx_broadcaster: &'c test_utils::TestBroadcaster,
120 pub chain_monitor: &'b test_utils::TestChainMonitor<'c>,
121 pub keys_manager: &'b test_utils::TestKeysInterface,
122 pub node: &'a ChannelManager<EnforcingSigner, &'b TestChainMonitor<'c>, &'c test_utils::TestBroadcaster, &'b test_utils::TestKeysInterface, &'c test_utils::TestFeeEstimator, &'c test_utils::TestLogger>,
123 pub net_graph_msg_handler: NetGraphMsgHandler<&'c test_utils::TestChainSource, &'c test_utils::TestLogger>,
124 pub node_seed: [u8; 32],
125 pub network_payment_count: Rc<RefCell<u8>>,
126 pub network_chan_count: Rc<RefCell<u32>>,
127 pub logger: &'c test_utils::TestLogger,
128 pub blocks: RefCell<Vec<(BlockHeader, u32)>>,
130 impl<'a, 'b, 'c> Node<'a, 'b, 'c> {
131 pub fn best_block_hash(&self) -> BlockHash {
132 self.blocks.borrow_mut().last().unwrap().0.block_hash()
134 pub fn best_block_info(&self) -> (BlockHash, u32) {
135 self.blocks.borrow_mut().last().map(|(a, b)| (a.block_hash(), *b)).unwrap()
139 impl<'a, 'b, 'c> Drop for Node<'a, 'b, 'c> {
141 if !::std::thread::panicking() {
142 // Check that we processed all pending events
143 assert!(self.node.get_and_clear_pending_msg_events().is_empty());
144 assert!(self.node.get_and_clear_pending_events().is_empty());
145 assert!(self.chain_monitor.added_monitors.lock().unwrap().is_empty());
147 // Check that if we serialize the Router, we can deserialize it again.
149 let mut w = test_utils::TestVecWriter(Vec::new());
150 let network_graph_ser = self.net_graph_msg_handler.network_graph.read().unwrap();
151 network_graph_ser.write(&mut w).unwrap();
152 let network_graph_deser = <NetworkGraph>::read(&mut ::std::io::Cursor::new(&w.0)).unwrap();
153 assert!(network_graph_deser == *self.net_graph_msg_handler.network_graph.read().unwrap());
154 let net_graph_msg_handler = NetGraphMsgHandler::from_net_graph(
155 Some(self.chain_source), self.logger, network_graph_deser
157 let mut chan_progress = 0;
159 let orig_announcements = self.net_graph_msg_handler.get_next_channel_announcements(chan_progress, 255);
160 let deserialized_announcements = net_graph_msg_handler.get_next_channel_announcements(chan_progress, 255);
161 assert!(orig_announcements == deserialized_announcements);
162 chan_progress = match orig_announcements.last() {
163 Some(announcement) => announcement.0.contents.short_channel_id + 1,
167 let mut node_progress = None;
169 let orig_announcements = self.net_graph_msg_handler.get_next_node_announcements(node_progress.as_ref(), 255);
170 let deserialized_announcements = net_graph_msg_handler.get_next_node_announcements(node_progress.as_ref(), 255);
171 assert!(orig_announcements == deserialized_announcements);
172 node_progress = match orig_announcements.last() {
173 Some(announcement) => Some(announcement.contents.node_id),
179 // Check that if we serialize and then deserialize all our channel monitors we get the
180 // same set of outputs to watch for on chain as we have now. Note that if we write
181 // tests that fully close channels and remove the monitors at some point this may break.
182 let feeest = test_utils::TestFeeEstimator { sat_per_kw: 253 };
183 let mut deserialized_monitors = Vec::new();
185 let old_monitors = self.chain_monitor.chain_monitor.monitors.read().unwrap();
186 for (_, old_monitor) in old_monitors.iter() {
187 let mut w = test_utils::TestVecWriter(Vec::new());
188 old_monitor.write(&mut w).unwrap();
189 let (_, deserialized_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
190 &mut ::std::io::Cursor::new(&w.0), self.keys_manager).unwrap();
191 deserialized_monitors.push(deserialized_monitor);
195 // Before using all the new monitors to check the watch outpoints, use the full set of
196 // them to ensure we can write and reload our ChannelManager.
198 let mut channel_monitors = HashMap::new();
199 for monitor in deserialized_monitors.iter_mut() {
200 channel_monitors.insert(monitor.get_funding_txo().0, monitor);
203 let mut w = test_utils::TestVecWriter(Vec::new());
204 self.node.write(&mut w).unwrap();
205 <(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 {
206 default_config: UserConfig::default(),
207 keys_manager: self.keys_manager,
208 fee_estimator: &test_utils::TestFeeEstimator { sat_per_kw: 253 },
209 chain_monitor: self.chain_monitor,
210 tx_broadcaster: &test_utils::TestBroadcaster {
211 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone())
213 logger: &test_utils::TestLogger::new(),
218 let persister = test_utils::TestPersister::new();
219 let broadcaster = test_utils::TestBroadcaster {
220 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone())
222 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
223 let chain_monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &broadcaster, &self.logger, &feeest, &persister, &self.keys_manager);
224 for deserialized_monitor in deserialized_monitors.drain(..) {
225 if let Err(_) = chain_monitor.watch_channel(deserialized_monitor.get_funding_txo().0, deserialized_monitor) {
229 assert_eq!(*chain_source.watched_txn.lock().unwrap(), *self.chain_source.watched_txn.lock().unwrap());
230 assert_eq!(*chain_source.watched_outputs.lock().unwrap(), *self.chain_source.watched_outputs.lock().unwrap());
235 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) {
236 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001, a_flags, b_flags)
239 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) {
240 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);
241 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &funding_locked);
242 (announcement, as_update, bs_update, channel_id, tx)
245 macro_rules! get_revoke_commit_msgs {
246 ($node: expr, $node_id: expr) => {
248 let events = $node.node.get_and_clear_pending_msg_events();
249 assert_eq!(events.len(), 2);
251 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
252 assert_eq!(*node_id, $node_id);
255 _ => panic!("Unexpected event"),
257 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
258 assert_eq!(*node_id, $node_id);
259 assert!(updates.update_add_htlcs.is_empty());
260 assert!(updates.update_fulfill_htlcs.is_empty());
261 assert!(updates.update_fail_htlcs.is_empty());
262 assert!(updates.update_fail_malformed_htlcs.is_empty());
263 assert!(updates.update_fee.is_none());
264 updates.commitment_signed.clone()
266 _ => panic!("Unexpected event"),
272 /// Get an specific event message from the pending events queue.
274 macro_rules! get_event_msg {
275 ($node: expr, $event_type: path, $node_id: expr) => {
277 let events = $node.node.get_and_clear_pending_msg_events();
278 assert_eq!(events.len(), 1);
280 $event_type { ref node_id, ref msg } => {
281 assert_eq!(*node_id, $node_id);
284 _ => panic!("Unexpected event"),
291 macro_rules! get_htlc_update_msgs {
292 ($node: expr, $node_id: expr) => {
294 let events = $node.node.get_and_clear_pending_msg_events();
295 assert_eq!(events.len(), 1);
297 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
298 assert_eq!(*node_id, $node_id);
301 _ => panic!("Unexpected event"),
308 macro_rules! get_feerate {
309 ($node: expr, $channel_id: expr) => {
311 let chan_lock = $node.node.channel_state.lock().unwrap();
312 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
319 macro_rules! get_local_commitment_txn {
320 ($node: expr, $channel_id: expr) => {
322 let monitors = $node.chain_monitor.chain_monitor.monitors.read().unwrap();
323 let mut commitment_txn = None;
324 for (funding_txo, monitor) in monitors.iter() {
325 if funding_txo.to_channel_id() == $channel_id {
326 commitment_txn = Some(monitor.unsafe_get_latest_holder_commitment_txn(&$node.logger));
330 commitment_txn.unwrap()
335 /// Check the error from attempting a payment.
337 macro_rules! unwrap_send_err {
338 ($res: expr, $all_failed: expr, $type: pat, $check: expr) => {
340 &Err(PaymentSendFailure::AllFailedRetrySafe(ref fails)) if $all_failed => {
341 assert_eq!(fails.len(), 1);
347 &Err(PaymentSendFailure::PartialFailure(ref fails)) if !$all_failed => {
348 assert_eq!(fails.len(), 1);
350 Err($type) => { $check },
359 /// Check whether N channel monitor(s) have been added.
361 macro_rules! check_added_monitors {
362 ($node: expr, $count: expr) => {
364 let mut added_monitors = $node.chain_monitor.added_monitors.lock().unwrap();
365 assert_eq!(added_monitors.len(), $count);
366 added_monitors.clear();
371 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) {
372 let chan_id = *node.network_chan_count.borrow();
374 let events = node.node.get_and_clear_pending_events();
375 assert_eq!(events.len(), 1);
377 Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
378 assert_eq!(*channel_value_satoshis, expected_chan_value);
379 assert_eq!(user_channel_id, expected_user_chan_id);
381 let tx = Transaction { version: chan_id as i32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
382 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
384 let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
385 (*temporary_channel_id, tx, funding_outpoint)
387 _ => panic!("Unexpected event"),
391 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 {
392 node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
393 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()));
394 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()));
396 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, channel_value, 42);
398 node_a.node.funding_transaction_generated(&temporary_channel_id, funding_output);
399 check_added_monitors!(node_a, 0);
401 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()));
403 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
404 assert_eq!(added_monitors.len(), 1);
405 assert_eq!(added_monitors[0].0, funding_output);
406 added_monitors.clear();
409 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()));
411 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
412 assert_eq!(added_monitors.len(), 1);
413 assert_eq!(added_monitors[0].0, funding_output);
414 added_monitors.clear();
417 let events_4 = node_a.node.get_and_clear_pending_events();
418 assert_eq!(events_4.len(), 1);
420 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
421 assert_eq!(user_channel_id, 42);
422 assert_eq!(*funding_txo, funding_output);
424 _ => panic!("Unexpected event"),
430 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) {
431 confirm_transaction(node_conf, tx);
432 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()));
435 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]) {
437 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
438 assert_eq!(events_6.len(), 2);
439 ((match events_6[0] {
440 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
441 channel_id = msg.channel_id.clone();
442 assert_eq!(*node_id, node_recv.node.get_our_node_id());
445 _ => panic!("Unexpected event"),
446 }, match events_6[1] {
447 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
448 assert_eq!(*node_id, node_recv.node.get_our_node_id());
451 _ => panic!("Unexpected event"),
455 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]) {
456 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx);
457 confirm_transaction(node_a, tx);
458 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
461 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) {
462 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat, a_flags, b_flags);
463 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
467 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) {
468 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
469 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
470 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
472 let events_7 = node_b.node.get_and_clear_pending_msg_events();
473 assert_eq!(events_7.len(), 1);
474 let (announcement, bs_update) = match events_7[0] {
475 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
478 _ => panic!("Unexpected event"),
481 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
482 let events_8 = node_a.node.get_and_clear_pending_msg_events();
483 assert_eq!(events_8.len(), 1);
484 let as_update = match events_8[0] {
485 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
486 assert!(*announcement == *msg);
487 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
488 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
491 _ => panic!("Unexpected event"),
494 *node_a.network_chan_count.borrow_mut() += 1;
496 ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
499 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) {
500 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001, a_flags, b_flags)
503 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) {
504 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat, a_flags, b_flags);
505 update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
506 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
509 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) {
510 nodes[a].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
511 let a_events = nodes[a].node.get_and_clear_pending_msg_events();
512 assert_eq!(a_events.len(), 1);
513 let a_node_announcement = match a_events[0] {
514 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
517 _ => panic!("Unexpected event"),
520 nodes[b].node.broadcast_node_announcement([1, 1, 1], [1; 32], Vec::new());
521 let b_events = nodes[b].node.get_and_clear_pending_msg_events();
522 assert_eq!(b_events.len(), 1);
523 let b_node_announcement = match b_events[0] {
524 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
527 _ => panic!("Unexpected event"),
531 assert!(node.net_graph_msg_handler.handle_channel_announcement(ann).unwrap());
532 node.net_graph_msg_handler.handle_channel_update(upd_1).unwrap();
533 node.net_graph_msg_handler.handle_channel_update(upd_2).unwrap();
534 node.net_graph_msg_handler.handle_node_announcement(&a_node_announcement).unwrap();
535 node.net_graph_msg_handler.handle_node_announcement(&b_node_announcement).unwrap();
539 macro_rules! check_spends {
540 ($tx: expr, $($spends_txn: expr),*) => {
542 let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
544 if out_point.txid == $spends_txn.txid() {
545 return $spends_txn.output.get(out_point.vout as usize).cloned()
550 let mut total_value_in = 0;
551 for input in $tx.input.iter() {
552 total_value_in += get_output(&input.previous_output).unwrap().value;
554 let mut total_value_out = 0;
555 for output in $tx.output.iter() {
556 total_value_out += output.value;
558 let min_fee = ($tx.get_weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
559 // Input amount - output amount = fee, so check that out + min_fee is smaller than input
560 assert!(total_value_out + min_fee <= total_value_in);
561 $tx.verify(get_output).unwrap();
566 macro_rules! get_closing_signed_broadcast {
567 ($node: expr, $dest_pubkey: expr) => {
569 let events = $node.get_and_clear_pending_msg_events();
570 assert!(events.len() == 1 || events.len() == 2);
571 (match events[events.len() - 1] {
572 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
573 assert_eq!(msg.contents.flags & 2, 2);
576 _ => panic!("Unexpected event"),
577 }, if events.len() == 2 {
579 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
580 assert_eq!(*node_id, $dest_pubkey);
583 _ => panic!("Unexpected event"),
590 /// Check that a channel's closing channel update has been broadcasted, and optionally
591 /// check whether an error message event has occurred.
593 macro_rules! check_closed_broadcast {
594 ($node: expr, $with_error_msg: expr) => {{
595 let events = $node.node.get_and_clear_pending_msg_events();
596 assert_eq!(events.len(), if $with_error_msg { 2 } else { 1 });
598 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
599 assert_eq!(msg.contents.flags & 2, 2);
601 _ => panic!("Unexpected event"),
605 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
606 // TODO: Check node_id
609 _ => panic!("Unexpected event"),
615 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) {
616 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) };
617 let (node_b, broadcaster_b) = if close_inbound_first { (&outbound_node.node, &outbound_node.tx_broadcaster) } else { (&inbound_node.node, &inbound_node.tx_broadcaster) };
620 node_a.close_channel(channel_id).unwrap();
621 node_b.handle_shutdown(&node_a.get_our_node_id(), &InitFeatures::known(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id()));
623 let events_1 = node_b.get_and_clear_pending_msg_events();
624 assert!(events_1.len() >= 1);
625 let shutdown_b = match events_1[0] {
626 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
627 assert_eq!(node_id, &node_a.get_our_node_id());
630 _ => panic!("Unexpected event"),
633 let closing_signed_b = if !close_inbound_first {
634 assert_eq!(events_1.len(), 1);
637 Some(match events_1[1] {
638 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
639 assert_eq!(node_id, &node_a.get_our_node_id());
642 _ => panic!("Unexpected event"),
646 node_a.handle_shutdown(&node_b.get_our_node_id(), &InitFeatures::known(), &shutdown_b);
647 let (as_update, bs_update) = if close_inbound_first {
648 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
649 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
650 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
651 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
652 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
654 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
655 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
656 assert!(none_b.is_none());
657 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
658 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
659 (as_update, bs_update)
661 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
663 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
664 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
665 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
666 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
668 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
669 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
670 assert!(none_a.is_none());
671 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
672 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
673 (as_update, bs_update)
675 assert_eq!(tx_a, tx_b);
676 check_spends!(tx_a, funding_tx);
678 (as_update, bs_update, tx_a)
681 pub struct SendEvent {
682 pub node_id: PublicKey,
683 pub msgs: Vec<msgs::UpdateAddHTLC>,
684 pub commitment_msg: msgs::CommitmentSigned,
687 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
688 assert!(updates.update_fulfill_htlcs.is_empty());
689 assert!(updates.update_fail_htlcs.is_empty());
690 assert!(updates.update_fail_malformed_htlcs.is_empty());
691 assert!(updates.update_fee.is_none());
692 SendEvent { node_id: node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
695 pub fn from_event(event: MessageSendEvent) -> SendEvent {
697 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
698 _ => panic!("Unexpected event type!"),
702 pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
703 let mut events = node.node.get_and_clear_pending_msg_events();
704 assert_eq!(events.len(), 1);
705 SendEvent::from_event(events.pop().unwrap())
709 macro_rules! commitment_signed_dance {
710 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
712 check_added_monitors!($node_a, 0);
713 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
714 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
715 check_added_monitors!($node_a, 1);
716 commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
719 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
721 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
722 check_added_monitors!($node_b, 0);
723 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
724 $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack);
725 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
726 check_added_monitors!($node_b, 1);
727 $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed);
728 let (bs_revoke_and_ack, extra_msg_option) = {
729 let events = $node_b.node.get_and_clear_pending_msg_events();
730 assert!(events.len() <= 2);
732 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
733 assert_eq!(*node_id, $node_a.node.get_our_node_id());
736 _ => panic!("Unexpected event"),
737 }, events.get(1).map(|e| e.clone()))
739 check_added_monitors!($node_b, 1);
741 assert!($node_a.node.get_and_clear_pending_events().is_empty());
742 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
744 (extra_msg_option, bs_revoke_and_ack)
747 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
749 check_added_monitors!($node_a, 0);
750 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
751 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
752 check_added_monitors!($node_a, 1);
753 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
754 assert!(extra_msg_option.is_none());
758 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
760 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
761 $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack);
762 check_added_monitors!($node_a, 1);
766 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
768 assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
771 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
773 commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
775 expect_pending_htlcs_forwardable!($node_a);
776 check_added_monitors!($node_a, 1);
778 let channel_state = $node_a.node.channel_state.lock().unwrap();
779 assert_eq!(channel_state.pending_msg_events.len(), 1);
780 if let MessageSendEvent::UpdateHTLCs { ref node_id, .. } = channel_state.pending_msg_events[0] {
781 assert_ne!(*node_id, $node_b.node.get_our_node_id());
782 } else { panic!("Unexpected event"); }
784 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
790 /// Get a payment preimage and hash.
792 macro_rules! get_payment_preimage_hash {
795 let payment_preimage = PaymentPreimage([*$node.network_payment_count.borrow(); 32]);
796 *$node.network_payment_count.borrow_mut() += 1;
797 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
798 (payment_preimage, payment_hash)
803 macro_rules! expect_pending_htlcs_forwardable_ignore {
805 let events = $node.node.get_and_clear_pending_events();
806 assert_eq!(events.len(), 1);
808 Event::PendingHTLCsForwardable { .. } => { },
809 _ => panic!("Unexpected event"),
814 macro_rules! expect_pending_htlcs_forwardable {
816 expect_pending_htlcs_forwardable_ignore!($node);
817 $node.node.process_pending_htlc_forwards();
822 macro_rules! expect_payment_received {
823 ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
824 let events = $node.node.get_and_clear_pending_events();
825 assert_eq!(events.len(), 1);
827 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
828 assert_eq!($expected_payment_hash, *payment_hash);
829 assert_eq!(None, *payment_secret);
830 assert_eq!($expected_recv_value, amt);
832 _ => panic!("Unexpected event"),
837 macro_rules! expect_payment_sent {
838 ($node: expr, $expected_payment_preimage: expr) => {
839 let events = $node.node.get_and_clear_pending_events();
840 assert_eq!(events.len(), 1);
842 Event::PaymentSent { ref payment_preimage } => {
843 assert_eq!($expected_payment_preimage, *payment_preimage);
845 _ => panic!("Unexpected event"),
851 macro_rules! expect_payment_failed {
852 ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
853 let events = $node.node.get_and_clear_pending_events();
854 assert_eq!(events.len(), 1);
856 Event::PaymentFailed { ref payment_hash, rejected_by_dest, ref error_code, ref error_data } => {
857 assert_eq!(*payment_hash, $expected_payment_hash);
858 assert_eq!(rejected_by_dest, $rejected_by_dest);
859 assert!(error_code.is_some());
860 assert!(error_data.is_some());
862 assert_eq!(error_code.unwrap(), $expected_error_code);
863 assert_eq!(&error_data.as_ref().unwrap()[..], $expected_error_data);
866 _ => panic!("Unexpected event"),
871 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>) {
872 origin_node.node.send_payment(&route, our_payment_hash, &our_payment_secret).unwrap();
873 check_added_monitors!(origin_node, expected_paths.len());
874 pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
877 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) {
878 let mut payment_event = SendEvent::from_event(ev);
879 let mut prev_node = origin_node;
881 for (idx, &node) in expected_path.iter().enumerate() {
882 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
884 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
885 check_added_monitors!(node, 0);
886 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
888 expect_pending_htlcs_forwardable!(node);
890 if idx == expected_path.len() - 1 {
891 let events_2 = node.node.get_and_clear_pending_events();
892 if payment_received_expected {
893 assert_eq!(events_2.len(), 1);
895 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
896 assert_eq!(our_payment_hash, *payment_hash);
897 assert_eq!(our_payment_secret, *payment_secret);
898 assert_eq!(amt, recv_value);
900 _ => panic!("Unexpected event"),
903 assert!(events_2.is_empty());
906 let mut events_2 = node.node.get_and_clear_pending_msg_events();
907 assert_eq!(events_2.len(), 1);
908 check_added_monitors!(node, 1);
909 payment_event = SendEvent::from_event(events_2.remove(0));
910 assert_eq!(payment_event.msgs.len(), 1);
917 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>) {
918 let mut events = origin_node.node.get_and_clear_pending_msg_events();
919 assert_eq!(events.len(), expected_route.len());
920 for (path_idx, (ev, expected_path)) in events.drain(..).zip(expected_route.iter()).enumerate() {
921 // Once we've gotten through all the HTLCs, the last one should result in a
922 // PaymentReceived (but each previous one should not!), .
923 let expect_payment = path_idx == expected_route.len() - 1;
924 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), our_payment_secret, ev, expect_payment);
928 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) {
929 send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, None);
932 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) {
933 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(origin_node);
934 send_along_route_with_hash(origin_node, route, expected_route, recv_value, our_payment_hash);
935 (our_payment_preimage, our_payment_hash)
938 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) {
939 for path in expected_paths.iter() {
940 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
942 assert!(expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage, &our_payment_secret, expected_amount));
943 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
945 macro_rules! msgs_from_ev {
948 &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 } } => {
949 assert!(update_add_htlcs.is_empty());
950 assert_eq!(update_fulfill_htlcs.len(), 1);
951 assert!(update_fail_htlcs.is_empty());
952 assert!(update_fail_malformed_htlcs.is_empty());
953 assert!(update_fee.is_none());
954 ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
956 _ => panic!("Unexpected event"),
960 let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
961 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
962 assert_eq!(events.len(), expected_paths.len());
963 for ev in events.iter() {
964 per_path_msgs.push(msgs_from_ev!(ev));
967 for (expected_route, (path_msgs, next_hop)) in expected_paths.iter().zip(per_path_msgs.drain(..)) {
968 let mut next_msgs = Some(path_msgs);
969 let mut expected_next_node = next_hop;
971 macro_rules! last_update_fulfill_dance {
972 ($node: expr, $prev_node: expr) => {
974 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
975 check_added_monitors!($node, 0);
976 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
977 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
981 macro_rules! mid_update_fulfill_dance {
982 ($node: expr, $prev_node: expr, $new_msgs: expr) => {
984 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
985 check_added_monitors!($node, 1);
986 let new_next_msgs = if $new_msgs {
987 let events = $node.node.get_and_clear_pending_msg_events();
988 assert_eq!(events.len(), 1);
989 let (res, nexthop) = msgs_from_ev!(&events[0]);
990 expected_next_node = nexthop;
993 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
996 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
997 next_msgs = new_next_msgs;
1002 let mut prev_node = expected_route.last().unwrap();
1003 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
1004 assert_eq!(expected_next_node, node.node.get_our_node_id());
1005 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
1006 if next_msgs.is_some() {
1007 mid_update_fulfill_dance!(node, prev_node, update_next_msgs);
1009 assert!(!update_next_msgs);
1010 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
1012 if !skip_last && idx == expected_route.len() - 1 {
1013 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1020 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
1021 expect_payment_sent!(origin_node, our_payment_preimage);
1026 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) {
1027 claim_payment_along_route_with_secret(origin_node, &[expected_route], skip_last, our_payment_preimage, None, expected_amount);
1030 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) {
1031 claim_payment_along_route(origin_node, expected_route, false, our_payment_preimage, expected_amount);
1034 pub const TEST_FINAL_CLTV: u32 = 32;
1036 pub fn route_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) -> (PaymentPreimage, PaymentHash) {
1037 let net_graph_msg_handler = &origin_node.net_graph_msg_handler;
1038 let logger = test_utils::TestLogger::new();
1039 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, None, &Vec::new(), recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1040 assert_eq!(route.paths.len(), 1);
1041 assert_eq!(route.paths[0].len(), expected_route.len());
1042 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1043 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1046 send_along_route(origin_node, route, expected_route, recv_value)
1049 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
1050 let logger = test_utils::TestLogger::new();
1051 let net_graph_msg_handler = &origin_node.net_graph_msg_handler;
1052 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, None, &Vec::new(), recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1053 assert_eq!(route.paths.len(), 1);
1054 assert_eq!(route.paths[0].len(), expected_route.len());
1055 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1056 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1059 let (_, our_payment_hash) = get_payment_preimage_hash!(origin_node);
1060 unwrap_send_err!(origin_node.node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
1061 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
1064 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64, expected_value: u64) {
1065 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
1066 claim_payment(&origin, expected_route, our_payment_preimage, expected_value);
1069 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) {
1070 assert!(expected_route.last().unwrap().node.fail_htlc_backwards(&our_payment_hash, &None));
1071 expect_pending_htlcs_forwardable!(expected_route.last().unwrap());
1072 check_added_monitors!(expected_route.last().unwrap(), 1);
1074 let mut next_msgs: Option<(msgs::UpdateFailHTLC, msgs::CommitmentSigned)> = None;
1075 macro_rules! update_fail_dance {
1076 ($node: expr, $prev_node: expr, $last_node: expr) => {
1078 $node.node.handle_update_fail_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1079 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, !$last_node);
1080 if skip_last && $last_node {
1081 expect_pending_htlcs_forwardable!($node);
1087 let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
1088 let mut prev_node = expected_route.last().unwrap();
1089 for (idx, node) in expected_route.iter().rev().enumerate() {
1090 assert_eq!(expected_next_node, node.node.get_our_node_id());
1091 if next_msgs.is_some() {
1092 // We may be the "last node" for the purpose of the commitment dance if we're
1093 // skipping the last node (implying it is disconnected) and we're the
1094 // second-to-last node!
1095 update_fail_dance!(node, prev_node, skip_last && idx == expected_route.len() - 1);
1098 let events = node.node.get_and_clear_pending_msg_events();
1099 if !skip_last || idx != expected_route.len() - 1 {
1100 assert_eq!(events.len(), 1);
1102 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 } } => {
1103 assert!(update_add_htlcs.is_empty());
1104 assert!(update_fulfill_htlcs.is_empty());
1105 assert_eq!(update_fail_htlcs.len(), 1);
1106 assert!(update_fail_malformed_htlcs.is_empty());
1107 assert!(update_fee.is_none());
1108 expected_next_node = node_id.clone();
1109 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
1111 _ => panic!("Unexpected event"),
1114 assert!(events.is_empty());
1116 if !skip_last && idx == expected_route.len() - 1 {
1117 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1124 update_fail_dance!(origin_node, expected_route.first().unwrap(), true);
1126 let events = origin_node.node.get_and_clear_pending_events();
1127 assert_eq!(events.len(), 1);
1129 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
1130 assert_eq!(payment_hash, our_payment_hash);
1131 assert!(rejected_by_dest);
1133 _ => panic!("Unexpected event"),
1138 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash) {
1139 fail_payment_along_route(origin_node, expected_route, false, our_payment_hash);
1142 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
1143 let mut chan_mon_cfgs = Vec::new();
1144 for i in 0..node_count {
1145 let tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())};
1146 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
1147 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
1148 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
1149 let persister = test_utils::TestPersister::new();
1150 let seed = [i as u8; 32];
1151 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
1153 chan_mon_cfgs.push(TestChanMonCfg{ tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager });
1159 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
1160 let mut nodes = Vec::new();
1162 for i in 0..node_count {
1163 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);
1164 let seed = [i as u8; 32];
1165 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 });
1171 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>> {
1172 let mut chanmgrs = Vec::new();
1173 for i in 0..node_count {
1174 let mut default_config = UserConfig::default();
1175 default_config.channel_options.announced_channel = true;
1176 default_config.peer_channel_config_limits.force_announced_channel_preference = false;
1177 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
1178 let network = Network::Testnet;
1179 let params = ChainParameters {
1181 latest_hash: genesis_block(network).header.block_hash(),
1184 let node = ChannelManager::new(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 }, params);
1185 chanmgrs.push(node);
1191 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>> {
1192 let mut nodes = Vec::new();
1193 let chan_count = Rc::new(RefCell::new(0));
1194 let payment_count = Rc::new(RefCell::new(0));
1196 for i in 0..node_count {
1197 let net_graph_msg_handler = NetGraphMsgHandler::new(cfgs[i].chain_source.genesis_hash, None, cfgs[i].logger);
1198 nodes.push(Node{ chain_source: cfgs[i].chain_source,
1199 tx_broadcaster: cfgs[i].tx_broadcaster, chain_monitor: &cfgs[i].chain_monitor,
1200 keys_manager: &cfgs[i].keys_manager, node: &chan_mgrs[i], net_graph_msg_handler,
1201 node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
1202 network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
1203 blocks: RefCell::new(vec![(genesis_block(Network::Testnet).header, 0)])
1210 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 138; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
1211 pub const OFFERED_HTLC_SCRIPT_WEIGHT: usize = 133;
1213 #[derive(PartialEq)]
1214 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
1215 /// Tests that the given node has broadcast transactions for the given Channel
1217 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
1218 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
1219 /// broadcast and the revoked outputs were claimed.
1221 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
1222 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
1224 /// All broadcast transactions must be accounted for in one of the above three types of we'll
1226 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> {
1227 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1228 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
1230 let mut res = Vec::with_capacity(2);
1231 node_txn.retain(|tx| {
1232 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
1233 check_spends!(tx, chan.3);
1234 if commitment_tx.is_none() {
1235 res.push(tx.clone());
1240 if let Some(explicit_tx) = commitment_tx {
1241 res.push(explicit_tx.clone());
1244 assert_eq!(res.len(), 1);
1246 if has_htlc_tx != HTLCType::NONE {
1247 node_txn.retain(|tx| {
1248 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
1249 check_spends!(tx, res[0]);
1250 if has_htlc_tx == HTLCType::TIMEOUT {
1251 assert!(tx.lock_time != 0);
1253 assert!(tx.lock_time == 0);
1255 res.push(tx.clone());
1259 assert!(res.len() == 2 || res.len() == 3);
1261 assert_eq!(res[1], res[2]);
1265 assert!(node_txn.is_empty());
1269 /// Tests that the given node has broadcast a claim transaction against the provided revoked
1270 /// HTLC transaction.
1271 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
1272 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1273 // We may issue multiple claiming transaction on revoked outputs due to block rescan
1274 // for revoked htlc outputs
1275 if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
1276 node_txn.retain(|tx| {
1277 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
1278 check_spends!(tx, revoked_tx);
1282 node_txn.retain(|tx| {
1283 check_spends!(tx, commitment_revoked_tx);
1286 assert!(node_txn.is_empty());
1289 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
1290 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1292 assert!(node_txn.len() >= 1);
1293 assert_eq!(node_txn[0].input.len(), 1);
1294 let mut found_prev = false;
1296 for tx in prev_txn {
1297 if node_txn[0].input[0].previous_output.txid == tx.txid() {
1298 check_spends!(node_txn[0], tx);
1299 assert!(node_txn[0].input[0].witness[2].len() > 106); // must spend an htlc output
1300 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
1306 assert!(found_prev);
1308 let mut res = Vec::new();
1309 mem::swap(&mut *node_txn, &mut res);
1313 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize) {
1314 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
1315 assert_eq!(events_1.len(), 1);
1316 let as_update = match events_1[0] {
1317 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1320 _ => panic!("Unexpected event"),
1323 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
1324 assert_eq!(events_2.len(), 1);
1325 let bs_update = match events_2[0] {
1326 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1329 _ => panic!("Unexpected event"),
1333 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
1334 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
1339 macro_rules! get_channel_value_stat {
1340 ($node: expr, $channel_id: expr) => {{
1341 let chan_lock = $node.node.channel_state.lock().unwrap();
1342 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
1343 chan.get_value_stat()
1347 macro_rules! get_chan_reestablish_msgs {
1348 ($src_node: expr, $dst_node: expr) => {
1350 let mut res = Vec::with_capacity(1);
1351 for msg in $src_node.node.get_and_clear_pending_msg_events() {
1352 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
1353 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1354 res.push(msg.clone());
1356 panic!("Unexpected event")
1364 macro_rules! handle_chan_reestablish_msgs {
1365 ($src_node: expr, $dst_node: expr) => {
1367 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
1369 let funding_locked = if let Some(&MessageSendEvent::SendFundingLocked { ref node_id, ref msg }) = msg_events.get(0) {
1371 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1377 let mut revoke_and_ack = None;
1378 let mut commitment_update = None;
1379 let order = if let Some(ev) = msg_events.get(idx) {
1382 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1383 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1384 revoke_and_ack = Some(msg.clone());
1385 RAACommitmentOrder::RevokeAndACKFirst
1387 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1388 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1389 commitment_update = Some(updates.clone());
1390 RAACommitmentOrder::CommitmentFirst
1392 _ => panic!("Unexpected event"),
1395 RAACommitmentOrder::CommitmentFirst
1398 if let Some(ev) = msg_events.get(idx) {
1400 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1401 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1402 assert!(revoke_and_ack.is_none());
1403 revoke_and_ack = Some(msg.clone());
1405 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1406 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1407 assert!(commitment_update.is_none());
1408 commitment_update = Some(updates.clone());
1410 _ => panic!("Unexpected event"),
1414 (funding_locked, revoke_and_ack, commitment_update, order)
1419 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
1420 /// for claims/fails they are separated out.
1421 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)) {
1422 node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1423 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
1424 node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1425 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
1427 if send_funding_locked.0 {
1428 // If a expects a funding_locked, it better not think it has received a revoke_and_ack
1430 for reestablish in reestablish_1.iter() {
1431 assert_eq!(reestablish.next_remote_commitment_number, 0);
1434 if send_funding_locked.1 {
1435 // If b expects a funding_locked, it better not think it has received a revoke_and_ack
1437 for reestablish in reestablish_2.iter() {
1438 assert_eq!(reestablish.next_remote_commitment_number, 0);
1441 if send_funding_locked.0 || send_funding_locked.1 {
1442 // If we expect any funding_locked's, both sides better have set
1443 // next_holder_commitment_number to 1
1444 for reestablish in reestablish_1.iter() {
1445 assert_eq!(reestablish.next_local_commitment_number, 1);
1447 for reestablish in reestablish_2.iter() {
1448 assert_eq!(reestablish.next_local_commitment_number, 1);
1452 let mut resp_1 = Vec::new();
1453 for msg in reestablish_1 {
1454 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
1455 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
1457 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
1458 check_added_monitors!(node_b, 1);
1460 check_added_monitors!(node_b, 0);
1463 let mut resp_2 = Vec::new();
1464 for msg in reestablish_2 {
1465 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
1466 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
1468 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
1469 check_added_monitors!(node_a, 1);
1471 check_added_monitors!(node_a, 0);
1474 // We don't yet support both needing updates, as that would require a different commitment dance:
1475 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
1476 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
1478 for chan_msgs in resp_1.drain(..) {
1479 if send_funding_locked.0 {
1480 node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
1481 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
1482 if !announcement_event.is_empty() {
1483 assert_eq!(announcement_event.len(), 1);
1484 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1485 //TODO: Test announcement_sigs re-sending
1486 } else { panic!("Unexpected event!"); }
1489 assert!(chan_msgs.0.is_none());
1492 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1493 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
1494 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1495 check_added_monitors!(node_a, 1);
1497 assert!(chan_msgs.1.is_none());
1499 if pending_htlc_adds.0 != 0 || pending_htlc_claims.0 != 0 || pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
1500 let commitment_update = chan_msgs.2.unwrap();
1501 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1502 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
1504 assert!(commitment_update.update_add_htlcs.is_empty());
1506 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
1507 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
1508 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1509 for update_add in commitment_update.update_add_htlcs {
1510 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
1512 for update_fulfill in commitment_update.update_fulfill_htlcs {
1513 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
1515 for update_fail in commitment_update.update_fail_htlcs {
1516 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
1519 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1520 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
1522 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
1523 check_added_monitors!(node_a, 1);
1524 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
1525 // No commitment_signed so get_event_msg's assert(len == 1) passes
1526 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
1527 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1528 check_added_monitors!(node_b, 1);
1531 assert!(chan_msgs.2.is_none());
1535 for chan_msgs in resp_2.drain(..) {
1536 if send_funding_locked.1 {
1537 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
1538 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
1539 if !announcement_event.is_empty() {
1540 assert_eq!(announcement_event.len(), 1);
1541 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1542 //TODO: Test announcement_sigs re-sending
1543 } else { panic!("Unexpected event!"); }
1546 assert!(chan_msgs.0.is_none());
1549 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1550 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
1551 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1552 check_added_monitors!(node_b, 1);
1554 assert!(chan_msgs.1.is_none());
1556 if pending_htlc_adds.1 != 0 || pending_htlc_claims.1 != 0 || pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
1557 let commitment_update = chan_msgs.2.unwrap();
1558 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
1559 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
1561 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
1562 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
1563 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1564 for update_add in commitment_update.update_add_htlcs {
1565 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
1567 for update_fulfill in commitment_update.update_fulfill_htlcs {
1568 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
1570 for update_fail in commitment_update.update_fail_htlcs {
1571 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
1574 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
1575 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
1577 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
1578 check_added_monitors!(node_b, 1);
1579 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
1580 // No commitment_signed so get_event_msg's assert(len == 1) passes
1581 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1582 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1583 check_added_monitors!(node_a, 1);
1586 assert!(chan_msgs.2.is_none());