1 //! A bunch of useful utilities for building networks of nodes and exchanging messages between
2 //! nodes for functional tests.
4 use chain::chaininterface;
5 use chain::transaction::OutPoint;
6 use chain::keysinterface::KeysInterface;
7 use ln::channelmanager::{ChannelManager,RAACommitmentOrder, PaymentPreimage, PaymentHash};
8 use ln::router::{Route, Router};
10 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler, Features, FeatureContextInit};
11 use util::enforcing_trait_impls::EnforcingChannelKeys;
13 use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
14 use util::errors::APIError;
15 use util::logger::Logger;
16 use util::config::UserConfig;
18 use bitcoin::util::hash::BitcoinHash;
19 use bitcoin::blockdata::block::BlockHeader;
20 use bitcoin::blockdata::transaction::{Transaction, TxOut};
21 use bitcoin::network::constants::Network;
23 use bitcoin_hashes::sha256::Hash as Sha256;
24 use bitcoin_hashes::sha256d::Hash as Sha256d;
25 use bitcoin_hashes::Hash;
27 use secp256k1::Secp256k1;
28 use secp256k1::key::PublicKey;
30 use rand::{thread_rng,Rng};
32 use std::cell::RefCell;
34 use std::sync::{Arc, Mutex};
37 pub const CHAN_CONFIRM_DEPTH: u32 = 100;
38 pub fn confirm_transaction(notifier: &chaininterface::BlockNotifier, chain: &chaininterface::ChainWatchInterfaceUtil, tx: &Transaction, chan_id: u32) {
39 assert!(chain.does_match_tx(tx));
40 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
41 notifier.block_connected_checked(&header, 1, &[tx; 1], &[chan_id; 1]);
42 for i in 2..CHAN_CONFIRM_DEPTH {
43 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
44 notifier.block_connected_checked(&header, i, &vec![], &[0; 0]);
48 pub fn connect_blocks(notifier: &chaininterface::BlockNotifier, depth: u32, height: u32, parent: bool, prev_blockhash: Sha256d) -> Sha256d {
49 let mut header = BlockHeader { version: 0x2000000, prev_blockhash: if parent { prev_blockhash } else { Default::default() }, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
50 notifier.block_connected_checked(&header, height + 1, &Vec::new(), &Vec::new());
51 for i in 2..depth + 1 {
52 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
53 notifier.block_connected_checked(&header, height + i, &Vec::new(), &Vec::new());
59 pub block_notifier: Arc<chaininterface::BlockNotifier>,
60 pub chain_monitor: Arc<chaininterface::ChainWatchInterfaceUtil>,
61 pub tx_broadcaster: Arc<test_utils::TestBroadcaster>,
62 pub chan_monitor: Arc<test_utils::TestChannelMonitor>,
63 pub keys_manager: Arc<test_utils::TestKeysInterface>,
64 pub node: Arc<ChannelManager<EnforcingChannelKeys>>,
66 pub node_seed: [u8; 32],
67 pub network_payment_count: Rc<RefCell<u8>>,
68 pub network_chan_count: Rc<RefCell<u32>>,
69 pub logger: Arc<test_utils::TestLogger>
73 if !::std::thread::panicking() {
74 // Check that we processed all pending events
75 assert!(self.node.get_and_clear_pending_msg_events().is_empty());
76 assert!(self.node.get_and_clear_pending_events().is_empty());
77 assert!(self.chan_monitor.added_monitors.lock().unwrap().is_empty());
82 pub fn create_chan_between_nodes(node_a: &Node, node_b: &Node, a_flags: Features<FeatureContextInit>, b_flags: Features<FeatureContextInit>) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
83 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001, a_flags, b_flags)
86 pub fn create_chan_between_nodes_with_value(node_a: &Node, node_b: &Node, channel_value: u64, push_msat: u64, a_flags: Features<FeatureContextInit>, b_flags: Features<FeatureContextInit>) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
87 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);
88 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &funding_locked);
89 (announcement, as_update, bs_update, channel_id, tx)
92 macro_rules! get_revoke_commit_msgs {
93 ($node: expr, $node_id: expr) => {
95 let events = $node.node.get_and_clear_pending_msg_events();
96 assert_eq!(events.len(), 2);
98 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
99 assert_eq!(*node_id, $node_id);
102 _ => panic!("Unexpected event"),
104 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
105 assert_eq!(*node_id, $node_id);
106 assert!(updates.update_add_htlcs.is_empty());
107 assert!(updates.update_fulfill_htlcs.is_empty());
108 assert!(updates.update_fail_htlcs.is_empty());
109 assert!(updates.update_fail_malformed_htlcs.is_empty());
110 assert!(updates.update_fee.is_none());
111 updates.commitment_signed.clone()
113 _ => panic!("Unexpected event"),
119 macro_rules! get_event_msg {
120 ($node: expr, $event_type: path, $node_id: expr) => {
122 let events = $node.node.get_and_clear_pending_msg_events();
123 assert_eq!(events.len(), 1);
125 $event_type { ref node_id, ref msg } => {
126 assert_eq!(*node_id, $node_id);
129 _ => panic!("Unexpected event"),
135 macro_rules! get_htlc_update_msgs {
136 ($node: expr, $node_id: expr) => {
138 let events = $node.node.get_and_clear_pending_msg_events();
139 assert_eq!(events.len(), 1);
141 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
142 assert_eq!(*node_id, $node_id);
145 _ => panic!("Unexpected event"),
151 macro_rules! get_feerate {
152 ($node: expr, $channel_id: expr) => {
154 let chan_lock = $node.node.channel_state.lock().unwrap();
155 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
161 pub fn create_funding_transaction(node: &Node, expected_chan_value: u64, expected_user_chan_id: u64) -> ([u8; 32], Transaction, OutPoint) {
162 let chan_id = *node.network_chan_count.borrow();
164 let events = node.node.get_and_clear_pending_events();
165 assert_eq!(events.len(), 1);
167 Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
168 assert_eq!(*channel_value_satoshis, expected_chan_value);
169 assert_eq!(user_channel_id, expected_user_chan_id);
171 let tx = Transaction { version: chan_id as u32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
172 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
174 let funding_outpoint = OutPoint::new(tx.txid(), 0);
175 (*temporary_channel_id, tx, funding_outpoint)
177 _ => panic!("Unexpected event"),
181 pub fn create_chan_between_nodes_with_value_init(node_a: &Node, node_b: &Node, channel_value: u64, push_msat: u64, a_flags: Features<FeatureContextInit>, b_flags: Features<FeatureContextInit>) -> Transaction {
182 node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42).unwrap();
183 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()));
184 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()));
186 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, channel_value, 42);
189 node_a.node.funding_transaction_generated(&temporary_channel_id, funding_output);
190 let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
191 assert_eq!(added_monitors.len(), 1);
192 assert_eq!(added_monitors[0].0, funding_output);
193 added_monitors.clear();
196 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()));
198 let mut added_monitors = node_b.chan_monitor.added_monitors.lock().unwrap();
199 assert_eq!(added_monitors.len(), 1);
200 assert_eq!(added_monitors[0].0, funding_output);
201 added_monitors.clear();
204 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()));
206 let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
207 assert_eq!(added_monitors.len(), 1);
208 assert_eq!(added_monitors[0].0, funding_output);
209 added_monitors.clear();
212 let events_4 = node_a.node.get_and_clear_pending_events();
213 assert_eq!(events_4.len(), 1);
215 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
216 assert_eq!(user_channel_id, 42);
217 assert_eq!(*funding_txo, funding_output);
219 _ => panic!("Unexpected event"),
225 pub fn create_chan_between_nodes_with_value_confirm_first(node_recv: &Node, node_conf: &Node, tx: &Transaction) {
226 confirm_transaction(&node_conf.block_notifier, &node_conf.chain_monitor, &tx, tx.version);
227 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()));
230 pub fn create_chan_between_nodes_with_value_confirm_second(node_recv: &Node, node_conf: &Node) -> ((msgs::FundingLocked, msgs::AnnouncementSignatures), [u8; 32]) {
232 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
233 assert_eq!(events_6.len(), 2);
234 ((match events_6[0] {
235 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
236 channel_id = msg.channel_id.clone();
237 assert_eq!(*node_id, node_recv.node.get_our_node_id());
240 _ => panic!("Unexpected event"),
241 }, match events_6[1] {
242 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
243 assert_eq!(*node_id, node_recv.node.get_our_node_id());
246 _ => panic!("Unexpected event"),
250 pub fn create_chan_between_nodes_with_value_confirm(node_a: &Node, node_b: &Node, tx: &Transaction) -> ((msgs::FundingLocked, msgs::AnnouncementSignatures), [u8; 32]) {
251 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx);
252 confirm_transaction(&node_a.block_notifier, &node_a.chain_monitor, &tx, tx.version);
253 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
256 pub fn create_chan_between_nodes_with_value_a(node_a: &Node, node_b: &Node, channel_value: u64, push_msat: u64, a_flags: Features<FeatureContextInit>, b_flags: Features<FeatureContextInit>) -> ((msgs::FundingLocked, msgs::AnnouncementSignatures), [u8; 32], Transaction) {
257 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat, a_flags, b_flags);
258 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
262 pub fn create_chan_between_nodes_with_value_b(node_a: &Node, node_b: &Node, as_funding_msgs: &(msgs::FundingLocked, msgs::AnnouncementSignatures)) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate) {
263 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
264 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
265 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
267 let events_7 = node_b.node.get_and_clear_pending_msg_events();
268 assert_eq!(events_7.len(), 1);
269 let (announcement, bs_update) = match events_7[0] {
270 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
273 _ => panic!("Unexpected event"),
276 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
277 let events_8 = node_a.node.get_and_clear_pending_msg_events();
278 assert_eq!(events_8.len(), 1);
279 let as_update = match events_8[0] {
280 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
281 assert!(*announcement == *msg);
282 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
283 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
286 _ => panic!("Unexpected event"),
289 *node_a.network_chan_count.borrow_mut() += 1;
291 ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
294 pub fn create_announced_chan_between_nodes(nodes: &Vec<Node>, a: usize, b: usize, a_flags: Features<FeatureContextInit>, b_flags: Features<FeatureContextInit>) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
295 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001, a_flags, b_flags)
298 pub fn create_announced_chan_between_nodes_with_value(nodes: &Vec<Node>, a: usize, b: usize, channel_value: u64, push_msat: u64, a_flags: Features<FeatureContextInit>, b_flags: Features<FeatureContextInit>) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
299 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat, a_flags, b_flags);
301 assert!(node.router.handle_channel_announcement(&chan_announcement.0).unwrap());
302 node.router.handle_channel_update(&chan_announcement.1).unwrap();
303 node.router.handle_channel_update(&chan_announcement.2).unwrap();
305 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
308 macro_rules! check_spends {
309 ($tx: expr, $spends_tx: expr) => {
311 $tx.verify(|out_point| {
312 if out_point.txid == $spends_tx.txid() {
313 $spends_tx.output.get(out_point.vout as usize).cloned()
322 macro_rules! get_closing_signed_broadcast {
323 ($node: expr, $dest_pubkey: expr) => {
325 let events = $node.get_and_clear_pending_msg_events();
326 assert!(events.len() == 1 || events.len() == 2);
327 (match events[events.len() - 1] {
328 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
329 assert_eq!(msg.contents.flags & 2, 2);
332 _ => panic!("Unexpected event"),
333 }, if events.len() == 2 {
335 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
336 assert_eq!(*node_id, $dest_pubkey);
339 _ => panic!("Unexpected event"),
346 macro_rules! check_closed_broadcast {
347 ($node: expr, $with_error_msg: expr) => {{
348 let events = $node.node.get_and_clear_pending_msg_events();
349 assert_eq!(events.len(), if $with_error_msg { 2 } else { 1 });
351 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
352 assert_eq!(msg.contents.flags & 2, 2);
354 _ => panic!("Unexpected event"),
358 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
359 // TODO: Check node_id
362 _ => panic!("Unexpected event"),
368 pub fn close_channel(outbound_node: &Node, inbound_node: &Node, channel_id: &[u8; 32], funding_tx: Transaction, close_inbound_first: bool) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, Transaction) {
369 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) };
370 let (node_b, broadcaster_b) = if close_inbound_first { (&outbound_node.node, &outbound_node.tx_broadcaster) } else { (&inbound_node.node, &inbound_node.tx_broadcaster) };
373 node_a.close_channel(channel_id).unwrap();
374 node_b.handle_shutdown(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id()));
376 let events_1 = node_b.get_and_clear_pending_msg_events();
377 assert!(events_1.len() >= 1);
378 let shutdown_b = match events_1[0] {
379 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
380 assert_eq!(node_id, &node_a.get_our_node_id());
383 _ => panic!("Unexpected event"),
386 let closing_signed_b = if !close_inbound_first {
387 assert_eq!(events_1.len(), 1);
390 Some(match events_1[1] {
391 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
392 assert_eq!(node_id, &node_a.get_our_node_id());
395 _ => panic!("Unexpected event"),
399 node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b);
400 let (as_update, bs_update) = if close_inbound_first {
401 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
402 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
403 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
404 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
405 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
407 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
408 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
409 assert!(none_b.is_none());
410 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
411 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
412 (as_update, bs_update)
414 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
416 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
417 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
418 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
419 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
421 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
422 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
423 assert!(none_a.is_none());
424 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
425 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
426 (as_update, bs_update)
428 assert_eq!(tx_a, tx_b);
429 check_spends!(tx_a, funding_tx);
431 (as_update, bs_update, tx_a)
434 pub struct SendEvent {
435 pub node_id: PublicKey,
436 pub msgs: Vec<msgs::UpdateAddHTLC>,
437 pub commitment_msg: msgs::CommitmentSigned,
440 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
441 assert!(updates.update_fulfill_htlcs.is_empty());
442 assert!(updates.update_fail_htlcs.is_empty());
443 assert!(updates.update_fail_malformed_htlcs.is_empty());
444 assert!(updates.update_fee.is_none());
445 SendEvent { node_id: node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
448 pub fn from_event(event: MessageSendEvent) -> SendEvent {
450 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
451 _ => panic!("Unexpected event type!"),
455 pub fn from_node(node: &Node) -> SendEvent {
456 let mut events = node.node.get_and_clear_pending_msg_events();
457 assert_eq!(events.len(), 1);
458 SendEvent::from_event(events.pop().unwrap())
462 macro_rules! check_added_monitors {
463 ($node: expr, $count: expr) => {
465 let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
466 assert_eq!(added_monitors.len(), $count);
467 added_monitors.clear();
472 macro_rules! commitment_signed_dance {
473 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
475 check_added_monitors!($node_a, 0);
476 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
477 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
478 check_added_monitors!($node_a, 1);
479 commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
482 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
484 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
485 check_added_monitors!($node_b, 0);
486 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
487 $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack);
488 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
489 check_added_monitors!($node_b, 1);
490 $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed);
491 let (bs_revoke_and_ack, extra_msg_option) = {
492 let events = $node_b.node.get_and_clear_pending_msg_events();
493 assert!(events.len() <= 2);
495 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
496 assert_eq!(*node_id, $node_a.node.get_our_node_id());
499 _ => panic!("Unexpected event"),
500 }, events.get(1).map(|e| e.clone()))
502 check_added_monitors!($node_b, 1);
504 assert!($node_a.node.get_and_clear_pending_events().is_empty());
505 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
507 (extra_msg_option, bs_revoke_and_ack)
510 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
512 check_added_monitors!($node_a, 0);
513 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
514 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
515 check_added_monitors!($node_a, 1);
516 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
517 assert!(extra_msg_option.is_none());
521 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
523 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
524 $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack);
525 check_added_monitors!($node_a, 1);
529 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
531 assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
534 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
536 commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
538 expect_pending_htlcs_forwardable!($node_a);
539 check_added_monitors!($node_a, 1);
541 let channel_state = $node_a.node.channel_state.lock().unwrap();
542 assert_eq!(channel_state.pending_msg_events.len(), 1);
543 if let MessageSendEvent::UpdateHTLCs { ref node_id, .. } = channel_state.pending_msg_events[0] {
544 assert_ne!(*node_id, $node_b.node.get_our_node_id());
545 } else { panic!("Unexpected event"); }
547 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
553 macro_rules! get_payment_preimage_hash {
556 let payment_preimage = PaymentPreimage([*$node.network_payment_count.borrow(); 32]);
557 *$node.network_payment_count.borrow_mut() += 1;
558 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
559 (payment_preimage, payment_hash)
564 macro_rules! expect_pending_htlcs_forwardable {
566 let events = $node.node.get_and_clear_pending_events();
567 assert_eq!(events.len(), 1);
569 Event::PendingHTLCsForwardable { .. } => { },
570 _ => panic!("Unexpected event"),
572 $node.node.process_pending_htlc_forwards();
576 macro_rules! expect_payment_received {
577 ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
578 let events = $node.node.get_and_clear_pending_events();
579 assert_eq!(events.len(), 1);
581 Event::PaymentReceived { ref payment_hash, amt } => {
582 assert_eq!($expected_payment_hash, *payment_hash);
583 assert_eq!($expected_recv_value, amt);
585 _ => panic!("Unexpected event"),
590 macro_rules! expect_payment_sent {
591 ($node: expr, $expected_payment_preimage: expr) => {
592 let events = $node.node.get_and_clear_pending_events();
593 assert_eq!(events.len(), 1);
595 Event::PaymentSent { ref payment_preimage } => {
596 assert_eq!($expected_payment_preimage, *payment_preimage);
598 _ => panic!("Unexpected event"),
603 pub fn send_along_route_with_hash(origin_node: &Node, route: Route, expected_route: &[&Node], recv_value: u64, our_payment_hash: PaymentHash) {
604 let mut payment_event = {
605 origin_node.node.send_payment(route, our_payment_hash).unwrap();
606 check_added_monitors!(origin_node, 1);
608 let mut events = origin_node.node.get_and_clear_pending_msg_events();
609 assert_eq!(events.len(), 1);
610 SendEvent::from_event(events.remove(0))
612 let mut prev_node = origin_node;
614 for (idx, &node) in expected_route.iter().enumerate() {
615 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
617 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
618 check_added_monitors!(node, 0);
619 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
621 expect_pending_htlcs_forwardable!(node);
623 if idx == expected_route.len() - 1 {
624 let events_2 = node.node.get_and_clear_pending_events();
625 assert_eq!(events_2.len(), 1);
627 Event::PaymentReceived { ref payment_hash, amt } => {
628 assert_eq!(our_payment_hash, *payment_hash);
629 assert_eq!(amt, recv_value);
631 _ => panic!("Unexpected event"),
634 let mut events_2 = node.node.get_and_clear_pending_msg_events();
635 assert_eq!(events_2.len(), 1);
636 check_added_monitors!(node, 1);
637 payment_event = SendEvent::from_event(events_2.remove(0));
638 assert_eq!(payment_event.msgs.len(), 1);
645 pub fn send_along_route(origin_node: &Node, route: Route, expected_route: &[&Node], recv_value: u64) -> (PaymentPreimage, PaymentHash) {
646 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(origin_node);
647 send_along_route_with_hash(origin_node, route, expected_route, recv_value, our_payment_hash);
648 (our_payment_preimage, our_payment_hash)
651 pub fn claim_payment_along_route(origin_node: &Node, expected_route: &[&Node], skip_last: bool, our_payment_preimage: PaymentPreimage, expected_amount: u64) {
652 assert!(expected_route.last().unwrap().node.claim_funds(our_payment_preimage, expected_amount));
653 check_added_monitors!(expected_route.last().unwrap(), 1);
655 let mut next_msgs: Option<(msgs::UpdateFulfillHTLC, msgs::CommitmentSigned)> = None;
656 let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
657 macro_rules! get_next_msgs {
660 let events = $node.node.get_and_clear_pending_msg_events();
661 assert_eq!(events.len(), 1);
663 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 } } => {
664 assert!(update_add_htlcs.is_empty());
665 assert_eq!(update_fulfill_htlcs.len(), 1);
666 assert!(update_fail_htlcs.is_empty());
667 assert!(update_fail_malformed_htlcs.is_empty());
668 assert!(update_fee.is_none());
669 expected_next_node = node_id.clone();
670 Some((update_fulfill_htlcs[0].clone(), commitment_signed.clone()))
672 _ => panic!("Unexpected event"),
678 macro_rules! last_update_fulfill_dance {
679 ($node: expr, $prev_node: expr) => {
681 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
682 check_added_monitors!($node, 0);
683 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
684 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
688 macro_rules! mid_update_fulfill_dance {
689 ($node: expr, $prev_node: expr, $new_msgs: expr) => {
691 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
692 check_added_monitors!($node, 1);
693 let new_next_msgs = if $new_msgs {
694 get_next_msgs!($node)
696 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
699 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
700 next_msgs = new_next_msgs;
705 let mut prev_node = expected_route.last().unwrap();
706 for (idx, node) in expected_route.iter().rev().enumerate() {
707 assert_eq!(expected_next_node, node.node.get_our_node_id());
708 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
709 if next_msgs.is_some() {
710 mid_update_fulfill_dance!(node, prev_node, update_next_msgs);
711 } else if update_next_msgs {
712 next_msgs = get_next_msgs!(node);
714 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
716 if !skip_last && idx == expected_route.len() - 1 {
717 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
724 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
725 expect_payment_sent!(origin_node, our_payment_preimage);
729 pub fn claim_payment(origin_node: &Node, expected_route: &[&Node], our_payment_preimage: PaymentPreimage, expected_amount: u64) {
730 claim_payment_along_route(origin_node, expected_route, false, our_payment_preimage, expected_amount);
733 pub const TEST_FINAL_CLTV: u32 = 32;
735 pub fn route_payment(origin_node: &Node, expected_route: &[&Node], recv_value: u64) -> (PaymentPreimage, PaymentHash) {
736 let route = origin_node.router.get_route(&expected_route.last().unwrap().node.get_our_node_id(), None, &Vec::new(), recv_value, TEST_FINAL_CLTV).unwrap();
737 assert_eq!(route.hops.len(), expected_route.len());
738 for (node, hop) in expected_route.iter().zip(route.hops.iter()) {
739 assert_eq!(hop.pubkey, node.node.get_our_node_id());
742 send_along_route(origin_node, route, expected_route, recv_value)
745 pub fn route_over_limit(origin_node: &Node, expected_route: &[&Node], recv_value: u64) {
746 let route = origin_node.router.get_route(&expected_route.last().unwrap().node.get_our_node_id(), None, &Vec::new(), recv_value, TEST_FINAL_CLTV).unwrap();
747 assert_eq!(route.hops.len(), expected_route.len());
748 for (node, hop) in expected_route.iter().zip(route.hops.iter()) {
749 assert_eq!(hop.pubkey, node.node.get_our_node_id());
752 let (_, our_payment_hash) = get_payment_preimage_hash!(origin_node);
754 let err = origin_node.node.send_payment(route, our_payment_hash).err().unwrap();
756 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight our peer will accept"),
757 _ => panic!("Unknown error variants"),
761 pub fn send_payment(origin: &Node, expected_route: &[&Node], recv_value: u64, expected_value: u64) {
762 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
763 claim_payment(&origin, expected_route, our_payment_preimage, expected_value);
766 pub fn fail_payment_along_route(origin_node: &Node, expected_route: &[&Node], skip_last: bool, our_payment_hash: PaymentHash) {
767 assert!(expected_route.last().unwrap().node.fail_htlc_backwards(&our_payment_hash));
768 expect_pending_htlcs_forwardable!(expected_route.last().unwrap());
769 check_added_monitors!(expected_route.last().unwrap(), 1);
771 let mut next_msgs: Option<(msgs::UpdateFailHTLC, msgs::CommitmentSigned)> = None;
772 macro_rules! update_fail_dance {
773 ($node: expr, $prev_node: expr, $last_node: expr) => {
775 $node.node.handle_update_fail_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
776 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, !$last_node);
777 if skip_last && $last_node {
778 expect_pending_htlcs_forwardable!($node);
784 let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
785 let mut prev_node = expected_route.last().unwrap();
786 for (idx, node) in expected_route.iter().rev().enumerate() {
787 assert_eq!(expected_next_node, node.node.get_our_node_id());
788 if next_msgs.is_some() {
789 // We may be the "last node" for the purpose of the commitment dance if we're
790 // skipping the last node (implying it is disconnected) and we're the
791 // second-to-last node!
792 update_fail_dance!(node, prev_node, skip_last && idx == expected_route.len() - 1);
795 let events = node.node.get_and_clear_pending_msg_events();
796 if !skip_last || idx != expected_route.len() - 1 {
797 assert_eq!(events.len(), 1);
799 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 } } => {
800 assert!(update_add_htlcs.is_empty());
801 assert!(update_fulfill_htlcs.is_empty());
802 assert_eq!(update_fail_htlcs.len(), 1);
803 assert!(update_fail_malformed_htlcs.is_empty());
804 assert!(update_fee.is_none());
805 expected_next_node = node_id.clone();
806 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
808 _ => panic!("Unexpected event"),
811 assert!(events.is_empty());
813 if !skip_last && idx == expected_route.len() - 1 {
814 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
821 update_fail_dance!(origin_node, expected_route.first().unwrap(), true);
823 let events = origin_node.node.get_and_clear_pending_events();
824 assert_eq!(events.len(), 1);
826 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
827 assert_eq!(payment_hash, our_payment_hash);
828 assert!(rejected_by_dest);
830 _ => panic!("Unexpected event"),
835 pub fn fail_payment(origin_node: &Node, expected_route: &[&Node], our_payment_hash: PaymentHash) {
836 fail_payment_along_route(origin_node, expected_route, false, our_payment_hash);
839 pub fn create_network(node_count: usize, node_config: &[Option<UserConfig>]) -> Vec<Node> {
840 let mut nodes = Vec::new();
841 let mut rng = thread_rng();
842 let secp_ctx = Secp256k1::new();
844 let chan_count = Rc::new(RefCell::new(0));
845 let payment_count = Rc::new(RefCell::new(0));
847 for i in 0..node_count {
848 let test_logger = Arc::new(test_utils::TestLogger::with_id(format!("node {}", i)));
849 let logger = &(Arc::clone(&test_logger) as Arc<Logger>);
850 let feeest = Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 });
851 let chain_monitor = Arc::new(chaininterface::ChainWatchInterfaceUtil::new(Network::Testnet, Arc::clone(&logger)));
852 let block_notifier = Arc::new(chaininterface::BlockNotifier::new(chain_monitor.clone()));
853 let tx_broadcaster = Arc::new(test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())});
854 let mut seed = [0; 32];
855 rng.fill_bytes(&mut seed);
856 let keys_manager = Arc::new(test_utils::TestKeysInterface::new(&seed, Network::Testnet, Arc::clone(&logger)));
857 let chan_monitor = Arc::new(test_utils::TestChannelMonitor::new(chain_monitor.clone(), tx_broadcaster.clone(), logger.clone(), feeest.clone()));
858 let weak_res = Arc::downgrade(&chan_monitor.simple_monitor);
859 block_notifier.register_listener(weak_res);
860 let mut default_config = UserConfig::default();
861 default_config.channel_options.announced_channel = true;
862 default_config.peer_channel_config_limits.force_announced_channel_preference = false;
863 let node = ChannelManager::new(Network::Testnet, feeest.clone(), chan_monitor.clone(), tx_broadcaster.clone(), Arc::clone(&logger), keys_manager.clone(), if node_config[i].is_some() { node_config[i].clone().unwrap() } else { default_config }, 0).unwrap();
864 let weak_res = Arc::downgrade(&node);
865 block_notifier.register_listener(weak_res);
866 let router = Router::new(PublicKey::from_secret_key(&secp_ctx, &keys_manager.get_node_secret()), chain_monitor.clone(), Arc::clone(&logger));
867 nodes.push(Node { chain_monitor, tx_broadcaster, chan_monitor, node, router, keys_manager, node_seed: seed,
868 network_payment_count: payment_count.clone(),
869 network_chan_count: chan_count.clone(),
879 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
880 /// Tests that the given node has broadcast transactions for the given Channel
882 /// First checks that the latest local commitment tx has been broadcast, unless an explicit
883 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
884 /// broadcast and the revoked outputs were claimed.
886 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
887 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
889 /// All broadcast transactions must be accounted for in one of the above three types of we'll
891 pub fn test_txn_broadcast(node: &Node, chan: &(msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction), commitment_tx: Option<Transaction>, has_htlc_tx: HTLCType) -> Vec<Transaction> {
892 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
893 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
895 let mut res = Vec::with_capacity(2);
896 node_txn.retain(|tx| {
897 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
898 check_spends!(tx, chan.3.clone());
899 if commitment_tx.is_none() {
900 res.push(tx.clone());
905 if let Some(explicit_tx) = commitment_tx {
906 res.push(explicit_tx.clone());
909 assert_eq!(res.len(), 1);
911 if has_htlc_tx != HTLCType::NONE {
912 node_txn.retain(|tx| {
913 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
914 check_spends!(tx, res[0].clone());
915 if has_htlc_tx == HTLCType::TIMEOUT {
916 assert!(tx.lock_time != 0);
918 assert!(tx.lock_time == 0);
920 res.push(tx.clone());
924 assert!(res.len() == 2 || res.len() == 3);
926 assert_eq!(res[1], res[2]);
930 assert!(node_txn.is_empty());
934 /// Tests that the given node has broadcast a claim transaction against the provided revoked
935 /// HTLC transaction.
936 pub fn test_revoked_htlc_claim_txn_broadcast(node: &Node, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
937 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
938 // We should issue a 2nd transaction if one htlc is dropped from initial claiming tx
939 // but sometimes not as feerate is too-low
940 if node_txn.len() != 1 && node_txn.len() != 2 { assert!(false); }
941 node_txn.retain(|tx| {
942 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
943 check_spends!(tx, revoked_tx);
947 node_txn.retain(|tx| {
948 check_spends!(tx, commitment_revoked_tx);
951 assert!(node_txn.is_empty());
954 pub fn check_preimage_claim(node: &Node, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
955 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
957 assert!(node_txn.len() >= 1);
958 assert_eq!(node_txn[0].input.len(), 1);
959 let mut found_prev = false;
962 if node_txn[0].input[0].previous_output.txid == tx.txid() {
963 check_spends!(node_txn[0], tx.clone());
964 assert!(node_txn[0].input[0].witness[2].len() > 106); // must spend an htlc output
965 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
973 let mut res = Vec::new();
974 mem::swap(&mut *node_txn, &mut res);
978 pub fn get_announce_close_broadcast_events(nodes: &Vec<Node>, a: usize, b: usize) {
979 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
980 assert_eq!(events_1.len(), 1);
981 let as_update = match events_1[0] {
982 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
985 _ => panic!("Unexpected event"),
988 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
989 assert_eq!(events_2.len(), 1);
990 let bs_update = match events_2[0] {
991 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
994 _ => panic!("Unexpected event"),
998 node.router.handle_channel_update(&as_update).unwrap();
999 node.router.handle_channel_update(&bs_update).unwrap();
1003 macro_rules! get_channel_value_stat {
1004 ($node: expr, $channel_id: expr) => {{
1005 let chan_lock = $node.node.channel_state.lock().unwrap();
1006 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
1007 chan.get_value_stat()
1011 macro_rules! get_chan_reestablish_msgs {
1012 ($src_node: expr, $dst_node: expr) => {
1014 let mut res = Vec::with_capacity(1);
1015 for msg in $src_node.node.get_and_clear_pending_msg_events() {
1016 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
1017 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1018 res.push(msg.clone());
1020 panic!("Unexpected event")
1028 macro_rules! handle_chan_reestablish_msgs {
1029 ($src_node: expr, $dst_node: expr) => {
1031 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
1033 let funding_locked = if let Some(&MessageSendEvent::SendFundingLocked { ref node_id, ref msg }) = msg_events.get(0) {
1035 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1041 let mut revoke_and_ack = None;
1042 let mut commitment_update = None;
1043 let order = if let Some(ev) = msg_events.get(idx) {
1046 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1047 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1048 revoke_and_ack = Some(msg.clone());
1049 RAACommitmentOrder::RevokeAndACKFirst
1051 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1052 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1053 commitment_update = Some(updates.clone());
1054 RAACommitmentOrder::CommitmentFirst
1056 _ => panic!("Unexpected event"),
1059 RAACommitmentOrder::CommitmentFirst
1062 if let Some(ev) = msg_events.get(idx) {
1064 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1065 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1066 assert!(revoke_and_ack.is_none());
1067 revoke_and_ack = Some(msg.clone());
1069 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1070 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1071 assert!(commitment_update.is_none());
1072 commitment_update = Some(updates.clone());
1074 _ => panic!("Unexpected event"),
1078 (funding_locked, revoke_and_ack, commitment_update, order)
1083 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
1084 /// for claims/fails they are separated out.
1085 pub fn reconnect_nodes(node_a: &Node, node_b: &Node, 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)) {
1086 node_a.node.peer_connected(&node_b.node.get_our_node_id());
1087 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
1088 node_b.node.peer_connected(&node_a.node.get_our_node_id());
1089 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
1091 if send_funding_locked.0 {
1092 // If a expects a funding_locked, it better not think it has received a revoke_and_ack
1094 for reestablish in reestablish_1.iter() {
1095 assert_eq!(reestablish.next_remote_commitment_number, 0);
1098 if send_funding_locked.1 {
1099 // If b expects a funding_locked, it better not think it has received a revoke_and_ack
1101 for reestablish in reestablish_2.iter() {
1102 assert_eq!(reestablish.next_remote_commitment_number, 0);
1105 if send_funding_locked.0 || send_funding_locked.1 {
1106 // If we expect any funding_locked's, both sides better have set
1107 // next_local_commitment_number to 1
1108 for reestablish in reestablish_1.iter() {
1109 assert_eq!(reestablish.next_local_commitment_number, 1);
1111 for reestablish in reestablish_2.iter() {
1112 assert_eq!(reestablish.next_local_commitment_number, 1);
1116 let mut resp_1 = Vec::new();
1117 for msg in reestablish_1 {
1118 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
1119 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
1121 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
1122 check_added_monitors!(node_b, 1);
1124 check_added_monitors!(node_b, 0);
1127 let mut resp_2 = Vec::new();
1128 for msg in reestablish_2 {
1129 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
1130 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
1132 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
1133 check_added_monitors!(node_a, 1);
1135 check_added_monitors!(node_a, 0);
1138 // We don't yet support both needing updates, as that would require a different commitment dance:
1139 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
1140 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
1142 for chan_msgs in resp_1.drain(..) {
1143 if send_funding_locked.0 {
1144 node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
1145 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
1146 if !announcement_event.is_empty() {
1147 assert_eq!(announcement_event.len(), 1);
1148 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1149 //TODO: Test announcement_sigs re-sending
1150 } else { panic!("Unexpected event!"); }
1153 assert!(chan_msgs.0.is_none());
1156 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1157 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
1158 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1159 check_added_monitors!(node_a, 1);
1161 assert!(chan_msgs.1.is_none());
1163 if pending_htlc_adds.0 != 0 || pending_htlc_claims.0 != 0 || pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
1164 let commitment_update = chan_msgs.2.unwrap();
1165 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1166 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
1168 assert!(commitment_update.update_add_htlcs.is_empty());
1170 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
1171 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
1172 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1173 for update_add in commitment_update.update_add_htlcs {
1174 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
1176 for update_fulfill in commitment_update.update_fulfill_htlcs {
1177 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
1179 for update_fail in commitment_update.update_fail_htlcs {
1180 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
1183 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1184 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
1186 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
1187 check_added_monitors!(node_a, 1);
1188 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
1189 // No commitment_signed so get_event_msg's assert(len == 1) passes
1190 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
1191 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1192 check_added_monitors!(node_b, 1);
1195 assert!(chan_msgs.2.is_none());
1199 for chan_msgs in resp_2.drain(..) {
1200 if send_funding_locked.1 {
1201 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
1202 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
1203 if !announcement_event.is_empty() {
1204 assert_eq!(announcement_event.len(), 1);
1205 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1206 //TODO: Test announcement_sigs re-sending
1207 } else { panic!("Unexpected event!"); }
1210 assert!(chan_msgs.0.is_none());
1213 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1214 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
1215 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1216 check_added_monitors!(node_b, 1);
1218 assert!(chan_msgs.1.is_none());
1220 if pending_htlc_adds.1 != 0 || pending_htlc_claims.1 != 0 || pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
1221 let commitment_update = chan_msgs.2.unwrap();
1222 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
1223 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
1225 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
1226 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
1227 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1228 for update_add in commitment_update.update_add_htlcs {
1229 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
1231 for update_fulfill in commitment_update.update_fulfill_htlcs {
1232 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
1234 for update_fail in commitment_update.update_fail_htlcs {
1235 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
1238 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
1239 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
1241 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
1242 check_added_monitors!(node_b, 1);
1243 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
1244 // No commitment_signed so get_event_msg's assert(len == 1) passes
1245 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1246 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1247 check_added_monitors!(node_a, 1);
1250 assert!(chan_msgs.2.is_none());