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 //! Tests that test standing up a network of ChannelManagers, creating channels, sending
11 //! payments/messages between them, and often checking the resulting ChannelMonitors are able to
12 //! claim outputs on-chain.
15 use crate::chain::{ChannelMonitorUpdateStatus, Confirm, Listen, Watch};
16 use crate::chain::chaininterface::LowerBoundedFeeEstimator;
17 use crate::chain::channelmonitor;
18 use crate::chain::channelmonitor::{CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY};
19 use crate::chain::transaction::OutPoint;
20 use crate::chain::keysinterface::{ChannelSigner, EcdsaChannelSigner, EntropySource};
21 use crate::ln::{PaymentPreimage, PaymentSecret, PaymentHash};
22 use crate::ln::channel::{commitment_tx_base_weight, COMMITMENT_TX_WEIGHT_PER_HTLC, CONCURRENT_INBOUND_HTLC_FEE_BUFFER, FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE, MIN_AFFORDABLE_HTLC_COUNT};
23 use crate::ln::channelmanager::{self, PaymentId, RAACommitmentOrder, PaymentSendFailure, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA};
24 use crate::ln::channel::{Channel, ChannelError};
25 use crate::ln::{chan_utils, onion_utils};
26 use crate::ln::chan_utils::{OFFERED_HTLC_SCRIPT_WEIGHT, htlc_success_tx_weight, htlc_timeout_tx_weight, HTLCOutputInCommitment};
27 use crate::routing::gossip::{NetworkGraph, NetworkUpdate};
28 use crate::routing::router::{PaymentParameters, Route, RouteHop, RouteParameters, find_route, get_route};
29 use crate::ln::features::{ChannelFeatures, NodeFeatures};
31 use crate::ln::msgs::{ChannelMessageHandler, RoutingMessageHandler, ErrorAction};
32 use crate::util::enforcing_trait_impls::EnforcingSigner;
33 use crate::util::test_utils;
34 use crate::util::events::{Event, MessageSendEvent, MessageSendEventsProvider, PaymentPurpose, ClosureReason, HTLCDestination};
35 use crate::util::errors::APIError;
36 use crate::util::ser::{Writeable, ReadableArgs};
37 use crate::util::config::UserConfig;
39 use bitcoin::hash_types::BlockHash;
40 use bitcoin::blockdata::block::{Block, BlockHeader};
41 use bitcoin::blockdata::script::{Builder, Script};
42 use bitcoin::blockdata::opcodes;
43 use bitcoin::blockdata::constants::genesis_block;
44 use bitcoin::network::constants::Network;
45 use bitcoin::{PackedLockTime, Sequence, Transaction, TxIn, TxMerkleNode, TxOut, Witness};
46 use bitcoin::OutPoint as BitcoinOutPoint;
48 use bitcoin::secp256k1::Secp256k1;
49 use bitcoin::secp256k1::{PublicKey,SecretKey};
54 use crate::prelude::*;
55 use alloc::collections::BTreeSet;
56 use core::default::Default;
57 use core::iter::repeat;
58 use bitcoin::hashes::Hash;
59 use crate::sync::{Arc, Mutex};
61 use crate::ln::functional_test_utils::*;
62 use crate::ln::chan_utils::CommitmentTransaction;
65 fn test_insane_channel_opens() {
66 // Stand up a network of 2 nodes
67 use crate::ln::channel::TOTAL_BITCOIN_SUPPLY_SATOSHIS;
68 let mut cfg = UserConfig::default();
69 cfg.channel_handshake_limits.max_funding_satoshis = TOTAL_BITCOIN_SUPPLY_SATOSHIS + 1;
70 let chanmon_cfgs = create_chanmon_cfgs(2);
71 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
72 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(cfg)]);
73 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
75 // Instantiate channel parameters where we push the maximum msats given our
77 let channel_value_sat = 31337; // same as funding satoshis
78 let channel_reserve_satoshis = Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(channel_value_sat, &cfg);
79 let push_msat = (channel_value_sat - channel_reserve_satoshis) * 1000;
81 // Have node0 initiate a channel to node1 with aforementioned parameters
82 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_sat, push_msat, 42, None).unwrap();
84 // Extract the channel open message from node0 to node1
85 let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
87 // Test helper that asserts we get the correct error string given a mutator
88 // that supposedly makes the channel open message insane
89 let insane_open_helper = |expected_error_str: &str, message_mutator: fn(msgs::OpenChannel) -> msgs::OpenChannel| {
90 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &message_mutator(open_channel_message.clone()));
91 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
92 assert_eq!(msg_events.len(), 1);
93 let expected_regex = regex::Regex::new(expected_error_str).unwrap();
94 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
96 &ErrorAction::SendErrorMessage { .. } => {
97 nodes[1].logger.assert_log_regex("lightning::ln::channelmanager".to_string(), expected_regex, 1);
99 _ => panic!("unexpected event!"),
101 } else { assert!(false); }
104 use crate::ln::channelmanager::MAX_LOCAL_BREAKDOWN_TIMEOUT;
106 // Test all mutations that would make the channel open message insane
107 insane_open_helper(format!("Per our config, funding must be at most {}. It was {}", TOTAL_BITCOIN_SUPPLY_SATOSHIS + 1, TOTAL_BITCOIN_SUPPLY_SATOSHIS + 2).as_str(), |mut msg| { msg.funding_satoshis = TOTAL_BITCOIN_SUPPLY_SATOSHIS + 2; msg });
108 insane_open_helper(format!("Funding must be smaller than the total bitcoin supply. It was {}", TOTAL_BITCOIN_SUPPLY_SATOSHIS).as_str(), |mut msg| { msg.funding_satoshis = TOTAL_BITCOIN_SUPPLY_SATOSHIS; msg });
110 insane_open_helper("Bogus channel_reserve_satoshis", |mut msg| { msg.channel_reserve_satoshis = msg.funding_satoshis + 1; msg });
112 insane_open_helper(r"push_msat \d+ was larger than channel amount minus reserve \(\d+\)", |mut msg| { msg.push_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 + 1; msg });
114 insane_open_helper("Peer never wants payout outputs?", |mut msg| { msg.dust_limit_satoshis = msg.funding_satoshis + 1 ; msg });
116 insane_open_helper(r"Minimum htlc value \(\d+\) was larger than full channel value \(\d+\)", |mut msg| { msg.htlc_minimum_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000; msg });
118 insane_open_helper("They wanted our payments to be delayed by a needlessly long period", |mut msg| { msg.to_self_delay = MAX_LOCAL_BREAKDOWN_TIMEOUT + 1; msg });
120 insane_open_helper("0 max_accepted_htlcs makes for a useless channel", |mut msg| { msg.max_accepted_htlcs = 0; msg });
122 insane_open_helper("max_accepted_htlcs was 484. It must not be larger than 483", |mut msg| { msg.max_accepted_htlcs = 484; msg });
126 fn test_funding_exceeds_no_wumbo_limit() {
127 // Test that if a peer does not support wumbo channels, we'll refuse to open a wumbo channel to
129 use crate::ln::channel::MAX_FUNDING_SATOSHIS_NO_WUMBO;
130 let chanmon_cfgs = create_chanmon_cfgs(2);
131 let mut node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
132 *node_cfgs[1].override_init_features.borrow_mut() = Some(channelmanager::provided_init_features(&test_default_channel_config()).clear_wumbo());
133 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
134 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
136 match nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), MAX_FUNDING_SATOSHIS_NO_WUMBO + 1, 0, 42, None) {
137 Err(APIError::APIMisuseError { err }) => {
138 assert_eq!(format!("funding_value must not exceed {}, it was {}", MAX_FUNDING_SATOSHIS_NO_WUMBO, MAX_FUNDING_SATOSHIS_NO_WUMBO + 1), err);
144 fn do_test_counterparty_no_reserve(send_from_initiator: bool) {
145 // A peer providing a channel_reserve_satoshis of 0 (or less than our dust limit) is insecure,
146 // but only for them. Because some LSPs do it with some level of trust of the clients (for a
147 // substantial UX improvement), we explicitly allow it. Because it's unlikely to happen often
148 // in normal testing, we test it explicitly here.
149 let chanmon_cfgs = create_chanmon_cfgs(2);
150 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
151 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
152 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
153 let default_config = UserConfig::default();
155 // Have node0 initiate a channel to node1 with aforementioned parameters
156 let mut push_amt = 100_000_000;
157 let feerate_per_kw = 253;
158 let opt_anchors = false;
159 push_amt -= feerate_per_kw as u64 * (commitment_tx_base_weight(opt_anchors) + 4 * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000 * 1000;
160 push_amt -= Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100_000, &default_config) * 1000;
162 let temp_channel_id = nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, if send_from_initiator { 0 } else { push_amt }, 42, None).unwrap();
163 let mut open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
164 if !send_from_initiator {
165 open_channel_message.channel_reserve_satoshis = 0;
166 open_channel_message.max_htlc_value_in_flight_msat = 100_000_000;
168 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_message);
170 // Extract the channel accept message from node1 to node0
171 let mut accept_channel_message = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
172 if send_from_initiator {
173 accept_channel_message.channel_reserve_satoshis = 0;
174 accept_channel_message.max_htlc_value_in_flight_msat = 100_000_000;
176 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel_message);
178 let sender_node = if send_from_initiator { &nodes[1] } else { &nodes[0] };
179 let counterparty_node = if send_from_initiator { &nodes[0] } else { &nodes[1] };
180 let mut sender_node_per_peer_lock;
181 let mut sender_node_peer_state_lock;
182 let mut chan = get_channel_ref!(sender_node, counterparty_node, sender_node_per_peer_lock, sender_node_peer_state_lock, temp_channel_id);
183 chan.holder_selected_channel_reserve_satoshis = 0;
184 chan.holder_max_htlc_value_in_flight_msat = 100_000_000;
187 let funding_tx = sign_funding_transaction(&nodes[0], &nodes[1], 100_000, temp_channel_id);
188 let funding_msgs = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &funding_tx);
189 create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_msgs.0);
191 // nodes[0] should now be able to send the full balance to nodes[1], violating nodes[1]'s
192 // security model if it ever tries to send funds back to nodes[0] (but that's not our problem).
193 if send_from_initiator {
194 send_payment(&nodes[0], &[&nodes[1]], 100_000_000
195 // Note that for outbound channels we have to consider the commitment tx fee and the
196 // "fee spike buffer", which is currently a multiple of the total commitment tx fee as
197 // well as an additional HTLC.
198 - FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE * commit_tx_fee_msat(feerate_per_kw, 2, opt_anchors));
200 send_payment(&nodes[1], &[&nodes[0]], push_amt);
205 fn test_counterparty_no_reserve() {
206 do_test_counterparty_no_reserve(true);
207 do_test_counterparty_no_reserve(false);
211 fn test_async_inbound_update_fee() {
212 let chanmon_cfgs = create_chanmon_cfgs(2);
213 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
214 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
215 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
216 create_announced_chan_between_nodes(&nodes, 0, 1);
219 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
223 // send (1) commitment_signed -.
224 // <- update_add_htlc/commitment_signed
225 // send (2) RAA (awaiting remote revoke) -.
226 // (1) commitment_signed is delivered ->
227 // .- send (3) RAA (awaiting remote revoke)
228 // (2) RAA is delivered ->
229 // .- send (4) commitment_signed
230 // <- (3) RAA is delivered
231 // send (5) commitment_signed -.
232 // <- (4) commitment_signed is delivered
234 // (5) commitment_signed is delivered ->
236 // (6) RAA is delivered ->
238 // First nodes[0] generates an update_fee
240 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
243 nodes[0].node.timer_tick_occurred();
244 check_added_monitors!(nodes[0], 1);
246 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
247 assert_eq!(events_0.len(), 1);
248 let (update_msg, commitment_signed) = match events_0[0] { // (1)
249 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
250 (update_fee.as_ref(), commitment_signed)
252 _ => panic!("Unexpected event"),
255 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
257 // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
258 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 40000);
259 nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
260 check_added_monitors!(nodes[1], 1);
262 let payment_event = {
263 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
264 assert_eq!(events_1.len(), 1);
265 SendEvent::from_event(events_1.remove(0))
267 assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
268 assert_eq!(payment_event.msgs.len(), 1);
270 // ...now when the messages get delivered everyone should be happy
271 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
272 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
273 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
274 // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
275 check_added_monitors!(nodes[0], 1);
277 // deliver(1), generate (3):
278 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
279 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
280 // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
281 check_added_monitors!(nodes[1], 1);
283 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack); // deliver (2)
284 let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
285 assert!(bs_update.update_add_htlcs.is_empty()); // (4)
286 assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
287 assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
288 assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
289 assert!(bs_update.update_fee.is_none()); // (4)
290 check_added_monitors!(nodes[1], 1);
292 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack); // deliver (3)
293 let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
294 assert!(as_update.update_add_htlcs.is_empty()); // (5)
295 assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
296 assert!(as_update.update_fail_htlcs.is_empty()); // (5)
297 assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
298 assert!(as_update.update_fee.is_none()); // (5)
299 check_added_monitors!(nodes[0], 1);
301 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed); // deliver (4)
302 let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
303 // only (6) so get_event_msg's assert(len == 1) passes
304 check_added_monitors!(nodes[0], 1);
306 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed); // deliver (5)
307 let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
308 check_added_monitors!(nodes[1], 1);
310 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
311 check_added_monitors!(nodes[0], 1);
313 let events_2 = nodes[0].node.get_and_clear_pending_events();
314 assert_eq!(events_2.len(), 1);
316 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
317 _ => panic!("Unexpected event"),
320 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke); // deliver (6)
321 check_added_monitors!(nodes[1], 1);
325 fn test_update_fee_unordered_raa() {
326 // Just the intro to the previous test followed by an out-of-order RAA (which caused a
327 // crash in an earlier version of the update_fee patch)
328 let chanmon_cfgs = create_chanmon_cfgs(2);
329 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
330 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
331 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
332 create_announced_chan_between_nodes(&nodes, 0, 1);
335 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
337 // First nodes[0] generates an update_fee
339 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
342 nodes[0].node.timer_tick_occurred();
343 check_added_monitors!(nodes[0], 1);
345 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
346 assert_eq!(events_0.len(), 1);
347 let update_msg = match events_0[0] { // (1)
348 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
351 _ => panic!("Unexpected event"),
354 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
356 // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
357 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 40000);
358 nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
359 check_added_monitors!(nodes[1], 1);
361 let payment_event = {
362 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
363 assert_eq!(events_1.len(), 1);
364 SendEvent::from_event(events_1.remove(0))
366 assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
367 assert_eq!(payment_event.msgs.len(), 1);
369 // ...now when the messages get delivered everyone should be happy
370 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
371 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
372 let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
373 // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
374 check_added_monitors!(nodes[0], 1);
376 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg); // deliver (2)
377 check_added_monitors!(nodes[1], 1);
379 // We can't continue, sadly, because our (1) now has a bogus signature
383 fn test_multi_flight_update_fee() {
384 let chanmon_cfgs = create_chanmon_cfgs(2);
385 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
386 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
387 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
388 create_announced_chan_between_nodes(&nodes, 0, 1);
391 // update_fee/commitment_signed ->
392 // .- send (1) RAA and (2) commitment_signed
393 // update_fee (never committed) ->
395 // We have to manually generate the above update_fee, it is allowed by the protocol but we
396 // don't track which updates correspond to which revoke_and_ack responses so we're in
397 // AwaitingRAA mode and will not generate the update_fee yet.
398 // <- (1) RAA delivered
399 // (3) is generated and send (4) CS -.
400 // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
401 // know the per_commitment_point to use for it.
402 // <- (2) commitment_signed delivered
404 // B should send no response here
405 // (4) commitment_signed delivered ->
406 // <- RAA/commitment_signed delivered
409 // First nodes[0] generates an update_fee
412 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
413 initial_feerate = *feerate_lock;
414 *feerate_lock = initial_feerate + 20;
416 nodes[0].node.timer_tick_occurred();
417 check_added_monitors!(nodes[0], 1);
419 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
420 assert_eq!(events_0.len(), 1);
421 let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
422 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
423 (update_fee.as_ref().unwrap(), commitment_signed)
425 _ => panic!("Unexpected event"),
428 // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
429 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1);
430 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1);
431 let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
432 check_added_monitors!(nodes[1], 1);
434 // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
437 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
438 *feerate_lock = initial_feerate + 40;
440 nodes[0].node.timer_tick_occurred();
441 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
442 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
444 // Create the (3) update_fee message that nodes[0] will generate before it does...
445 let mut update_msg_2 = msgs::UpdateFee {
446 channel_id: update_msg_1.channel_id.clone(),
447 feerate_per_kw: (initial_feerate + 30) as u32,
450 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
452 update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
454 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
456 // Deliver (1), generating (3) and (4)
457 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg);
458 let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
459 check_added_monitors!(nodes[0], 1);
460 assert!(as_second_update.update_add_htlcs.is_empty());
461 assert!(as_second_update.update_fulfill_htlcs.is_empty());
462 assert!(as_second_update.update_fail_htlcs.is_empty());
463 assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
464 // Check that the update_fee newly generated matches what we delivered:
465 assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
466 assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
468 // Deliver (2) commitment_signed
469 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
470 let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
471 check_added_monitors!(nodes[0], 1);
472 // No commitment_signed so get_event_msg's assert(len == 1) passes
474 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg);
475 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
476 check_added_monitors!(nodes[1], 1);
479 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
480 let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
481 check_added_monitors!(nodes[1], 1);
483 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
484 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
485 check_added_monitors!(nodes[0], 1);
487 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment);
488 let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
489 // No commitment_signed so get_event_msg's assert(len == 1) passes
490 check_added_monitors!(nodes[0], 1);
492 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke);
493 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
494 check_added_monitors!(nodes[1], 1);
497 fn do_test_sanity_on_in_flight_opens(steps: u8) {
498 // Previously, we had issues deserializing channels when we hadn't connected the first block
499 // after creation. To catch that and similar issues, we lean on the Node::drop impl to test
500 // serialization round-trips and simply do steps towards opening a channel and then drop the
503 let chanmon_cfgs = create_chanmon_cfgs(2);
504 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
505 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
506 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
508 if steps & 0b1000_0000 != 0{
510 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 },
513 connect_block(&nodes[0], &block);
514 connect_block(&nodes[1], &block);
517 if steps & 0x0f == 0 { return; }
518 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
519 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
521 if steps & 0x0f == 1 { return; }
522 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
523 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
525 if steps & 0x0f == 2 { return; }
526 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
528 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100000, 42);
530 if steps & 0x0f == 3 { return; }
531 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).unwrap();
532 check_added_monitors!(nodes[0], 0);
533 let funding_created = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
535 if steps & 0x0f == 4 { return; }
536 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
538 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
539 assert_eq!(added_monitors.len(), 1);
540 assert_eq!(added_monitors[0].0, funding_output);
541 added_monitors.clear();
543 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
545 if steps & 0x0f == 5 { return; }
546 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
548 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
549 assert_eq!(added_monitors.len(), 1);
550 assert_eq!(added_monitors[0].0, funding_output);
551 added_monitors.clear();
554 let events_4 = nodes[0].node.get_and_clear_pending_events();
555 assert_eq!(events_4.len(), 0);
557 if steps & 0x0f == 6 { return; }
558 create_chan_between_nodes_with_value_confirm_first(&nodes[0], &nodes[1], &tx, 2);
560 if steps & 0x0f == 7 { return; }
561 confirm_transaction_at(&nodes[0], &tx, 2);
562 connect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH);
563 create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
564 expect_channel_ready_event(&nodes[0], &nodes[1].node.get_our_node_id());
568 fn test_sanity_on_in_flight_opens() {
569 do_test_sanity_on_in_flight_opens(0);
570 do_test_sanity_on_in_flight_opens(0 | 0b1000_0000);
571 do_test_sanity_on_in_flight_opens(1);
572 do_test_sanity_on_in_flight_opens(1 | 0b1000_0000);
573 do_test_sanity_on_in_flight_opens(2);
574 do_test_sanity_on_in_flight_opens(2 | 0b1000_0000);
575 do_test_sanity_on_in_flight_opens(3);
576 do_test_sanity_on_in_flight_opens(3 | 0b1000_0000);
577 do_test_sanity_on_in_flight_opens(4);
578 do_test_sanity_on_in_flight_opens(4 | 0b1000_0000);
579 do_test_sanity_on_in_flight_opens(5);
580 do_test_sanity_on_in_flight_opens(5 | 0b1000_0000);
581 do_test_sanity_on_in_flight_opens(6);
582 do_test_sanity_on_in_flight_opens(6 | 0b1000_0000);
583 do_test_sanity_on_in_flight_opens(7);
584 do_test_sanity_on_in_flight_opens(7 | 0b1000_0000);
585 do_test_sanity_on_in_flight_opens(8);
586 do_test_sanity_on_in_flight_opens(8 | 0b1000_0000);
590 fn test_update_fee_vanilla() {
591 let chanmon_cfgs = create_chanmon_cfgs(2);
592 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
593 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
594 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
595 create_announced_chan_between_nodes(&nodes, 0, 1);
598 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
601 nodes[0].node.timer_tick_occurred();
602 check_added_monitors!(nodes[0], 1);
604 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
605 assert_eq!(events_0.len(), 1);
606 let (update_msg, commitment_signed) = match events_0[0] {
607 MessageSendEvent::UpdateHTLCs { node_id:_, updates: msgs::CommitmentUpdate { update_add_htlcs:_, update_fulfill_htlcs:_, update_fail_htlcs:_, update_fail_malformed_htlcs:_, ref update_fee, ref commitment_signed } } => {
608 (update_fee.as_ref(), commitment_signed)
610 _ => panic!("Unexpected event"),
612 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
614 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
615 let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
616 check_added_monitors!(nodes[1], 1);
618 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
619 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
620 check_added_monitors!(nodes[0], 1);
622 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
623 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
624 // No commitment_signed so get_event_msg's assert(len == 1) passes
625 check_added_monitors!(nodes[0], 1);
627 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
628 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
629 check_added_monitors!(nodes[1], 1);
633 fn test_update_fee_that_funder_cannot_afford() {
634 let chanmon_cfgs = create_chanmon_cfgs(2);
635 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
636 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
637 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
638 let channel_value = 5000;
640 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, push_sats * 1000);
641 let channel_id = chan.2;
642 let secp_ctx = Secp256k1::new();
643 let default_config = UserConfig::default();
644 let bs_channel_reserve_sats = Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(channel_value, &default_config);
646 let opt_anchors = false;
648 // Calculate the maximum feerate that A can afford. Note that we don't send an update_fee
649 // CONCURRENT_INBOUND_HTLC_FEE_BUFFER HTLCs before actually running out of local balance, so we
650 // calculate two different feerates here - the expected local limit as well as the expected
652 let feerate = ((channel_value - bs_channel_reserve_sats - push_sats) * 1000 / (commitment_tx_base_weight(opt_anchors) + CONCURRENT_INBOUND_HTLC_FEE_BUFFER as u64 * COMMITMENT_TX_WEIGHT_PER_HTLC)) as u32;
653 let non_buffer_feerate = ((channel_value - bs_channel_reserve_sats - push_sats) * 1000 / commitment_tx_base_weight(opt_anchors)) as u32;
655 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
656 *feerate_lock = feerate;
658 nodes[0].node.timer_tick_occurred();
659 check_added_monitors!(nodes[0], 1);
660 let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
662 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap());
664 commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
666 // Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate set above.
668 let commitment_tx = get_local_commitment_txn!(nodes[1], channel_id)[0].clone();
670 //We made sure neither party's funds are below the dust limit and there are no HTLCs here
671 assert_eq!(commitment_tx.output.len(), 2);
672 let total_fee: u64 = commit_tx_fee_msat(feerate, 0, opt_anchors) / 1000;
673 let mut actual_fee = commitment_tx.output.iter().fold(0, |acc, output| acc + output.value);
674 actual_fee = channel_value - actual_fee;
675 assert_eq!(total_fee, actual_fee);
679 // Increment the feerate by a small constant, accounting for rounding errors
680 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
683 nodes[0].node.timer_tick_occurred();
684 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), format!("Cannot afford to send new feerate at {}", feerate + 4), 1);
685 check_added_monitors!(nodes[0], 0);
687 const INITIAL_COMMITMENT_NUMBER: u64 = 281474976710654;
689 // Get the EnforcingSigner for each channel, which will be used to (1) get the keys
690 // needed to sign the new commitment tx and (2) sign the new commitment tx.
691 let (local_revocation_basepoint, local_htlc_basepoint, local_funding) = {
692 let per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
693 let chan_lock = per_peer_state.get(&nodes[1].node.get_our_node_id()).unwrap().lock().unwrap();
694 let local_chan = chan_lock.channel_by_id.get(&chan.2).unwrap();
695 let chan_signer = local_chan.get_signer();
696 let pubkeys = chan_signer.pubkeys();
697 (pubkeys.revocation_basepoint, pubkeys.htlc_basepoint,
698 pubkeys.funding_pubkey)
700 let (remote_delayed_payment_basepoint, remote_htlc_basepoint,remote_point, remote_funding) = {
701 let per_peer_state = nodes[1].node.per_peer_state.read().unwrap();
702 let chan_lock = per_peer_state.get(&nodes[0].node.get_our_node_id()).unwrap().lock().unwrap();
703 let remote_chan = chan_lock.channel_by_id.get(&chan.2).unwrap();
704 let chan_signer = remote_chan.get_signer();
705 let pubkeys = chan_signer.pubkeys();
706 (pubkeys.delayed_payment_basepoint, pubkeys.htlc_basepoint,
707 chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 1, &secp_ctx),
708 pubkeys.funding_pubkey)
711 // Assemble the set of keys we can use for signatures for our commitment_signed message.
712 let commit_tx_keys = chan_utils::TxCreationKeys::derive_new(&secp_ctx, &remote_point, &remote_delayed_payment_basepoint,
713 &remote_htlc_basepoint, &local_revocation_basepoint, &local_htlc_basepoint);
716 let per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
717 let local_chan_lock = per_peer_state.get(&nodes[1].node.get_our_node_id()).unwrap().lock().unwrap();
718 let local_chan = local_chan_lock.channel_by_id.get(&chan.2).unwrap();
719 let local_chan_signer = local_chan.get_signer();
720 let mut htlcs: Vec<(HTLCOutputInCommitment, ())> = vec![];
721 let commitment_tx = CommitmentTransaction::new_with_auxiliary_htlc_data(
722 INITIAL_COMMITMENT_NUMBER - 1,
724 channel_value - push_sats - commit_tx_fee_msat(non_buffer_feerate + 4, 0, opt_anchors) / 1000,
725 opt_anchors, local_funding, remote_funding,
726 commit_tx_keys.clone(),
727 non_buffer_feerate + 4,
729 &local_chan.channel_transaction_parameters.as_counterparty_broadcastable()
731 local_chan_signer.sign_counterparty_commitment(&commitment_tx, Vec::new(), &secp_ctx).unwrap()
734 let commit_signed_msg = msgs::CommitmentSigned {
737 htlc_signatures: res.1
740 let update_fee = msgs::UpdateFee {
742 feerate_per_kw: non_buffer_feerate + 4,
745 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_fee);
747 //While producing the commitment_signed response after handling a received update_fee request the
748 //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
749 //Should produce and error.
750 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commit_signed_msg);
751 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Funding remote cannot afford proposed new fee".to_string(), 1);
752 check_added_monitors!(nodes[1], 1);
753 check_closed_broadcast!(nodes[1], true);
754 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: String::from("Funding remote cannot afford proposed new fee") });
758 fn test_update_fee_with_fundee_update_add_htlc() {
759 let chanmon_cfgs = create_chanmon_cfgs(2);
760 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
761 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
762 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
763 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
766 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
769 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
772 nodes[0].node.timer_tick_occurred();
773 check_added_monitors!(nodes[0], 1);
775 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
776 assert_eq!(events_0.len(), 1);
777 let (update_msg, commitment_signed) = match events_0[0] {
778 MessageSendEvent::UpdateHTLCs { node_id:_, updates: msgs::CommitmentUpdate { update_add_htlcs:_, update_fulfill_htlcs:_, update_fail_htlcs:_, update_fail_malformed_htlcs:_, ref update_fee, ref commitment_signed } } => {
779 (update_fee.as_ref(), commitment_signed)
781 _ => panic!("Unexpected event"),
783 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
784 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
785 let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
786 check_added_monitors!(nodes[1], 1);
788 let (route, our_payment_hash, our_payment_preimage, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 800000);
790 // nothing happens since node[1] is in AwaitingRemoteRevoke
791 nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
793 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
794 assert_eq!(added_monitors.len(), 0);
795 added_monitors.clear();
797 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
798 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
799 // node[1] has nothing to do
801 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
802 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
803 check_added_monitors!(nodes[0], 1);
805 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
806 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
807 // No commitment_signed so get_event_msg's assert(len == 1) passes
808 check_added_monitors!(nodes[0], 1);
809 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
810 check_added_monitors!(nodes[1], 1);
811 // AwaitingRemoteRevoke ends here
813 let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
814 assert_eq!(commitment_update.update_add_htlcs.len(), 1);
815 assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
816 assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
817 assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
818 assert_eq!(commitment_update.update_fee.is_none(), true);
820 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]);
821 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
822 check_added_monitors!(nodes[0], 1);
823 let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
825 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke);
826 check_added_monitors!(nodes[1], 1);
827 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
829 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
830 check_added_monitors!(nodes[1], 1);
831 let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
832 // No commitment_signed so get_event_msg's assert(len == 1) passes
834 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke);
835 check_added_monitors!(nodes[0], 1);
836 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
838 expect_pending_htlcs_forwardable!(nodes[0]);
840 let events = nodes[0].node.get_and_clear_pending_events();
841 assert_eq!(events.len(), 1);
843 Event::PaymentClaimable { .. } => { },
844 _ => panic!("Unexpected event"),
847 claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage);
849 send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000);
850 send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000);
851 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
852 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
853 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
857 fn test_update_fee() {
858 let chanmon_cfgs = create_chanmon_cfgs(2);
859 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
860 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
861 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
862 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
863 let channel_id = chan.2;
866 // (1) update_fee/commitment_signed ->
867 // <- (2) revoke_and_ack
868 // .- send (3) commitment_signed
869 // (4) update_fee/commitment_signed ->
870 // .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
871 // <- (3) commitment_signed delivered
872 // send (6) revoke_and_ack -.
873 // <- (5) deliver revoke_and_ack
874 // (6) deliver revoke_and_ack ->
875 // .- send (7) commitment_signed in response to (4)
876 // <- (7) deliver commitment_signed
879 // Create and deliver (1)...
882 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
883 feerate = *feerate_lock;
884 *feerate_lock = feerate + 20;
886 nodes[0].node.timer_tick_occurred();
887 check_added_monitors!(nodes[0], 1);
889 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
890 assert_eq!(events_0.len(), 1);
891 let (update_msg, commitment_signed) = match events_0[0] {
892 MessageSendEvent::UpdateHTLCs { node_id:_, updates: msgs::CommitmentUpdate { update_add_htlcs:_, update_fulfill_htlcs:_, update_fail_htlcs:_, update_fail_malformed_htlcs:_, ref update_fee, ref commitment_signed } } => {
893 (update_fee.as_ref(), commitment_signed)
895 _ => panic!("Unexpected event"),
897 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
899 // Generate (2) and (3):
900 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
901 let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
902 check_added_monitors!(nodes[1], 1);
905 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
906 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
907 check_added_monitors!(nodes[0], 1);
909 // Create and deliver (4)...
911 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
912 *feerate_lock = feerate + 30;
914 nodes[0].node.timer_tick_occurred();
915 check_added_monitors!(nodes[0], 1);
916 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
917 assert_eq!(events_0.len(), 1);
918 let (update_msg, commitment_signed) = match events_0[0] {
919 MessageSendEvent::UpdateHTLCs { node_id:_, updates: msgs::CommitmentUpdate { update_add_htlcs:_, update_fulfill_htlcs:_, update_fail_htlcs:_, update_fail_malformed_htlcs:_, ref update_fee, ref commitment_signed } } => {
920 (update_fee.as_ref(), commitment_signed)
922 _ => panic!("Unexpected event"),
925 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
926 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
927 check_added_monitors!(nodes[1], 1);
929 let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
930 // No commitment_signed so get_event_msg's assert(len == 1) passes
932 // Handle (3), creating (6):
933 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0);
934 check_added_monitors!(nodes[0], 1);
935 let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
936 // No commitment_signed so get_event_msg's assert(len == 1) passes
939 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
940 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
941 check_added_monitors!(nodes[0], 1);
943 // Deliver (6), creating (7):
944 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0);
945 let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
946 assert!(commitment_update.update_add_htlcs.is_empty());
947 assert!(commitment_update.update_fulfill_htlcs.is_empty());
948 assert!(commitment_update.update_fail_htlcs.is_empty());
949 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
950 assert!(commitment_update.update_fee.is_none());
951 check_added_monitors!(nodes[1], 1);
954 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
955 check_added_monitors!(nodes[0], 1);
956 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
957 // No commitment_signed so get_event_msg's assert(len == 1) passes
959 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
960 check_added_monitors!(nodes[1], 1);
961 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
963 assert_eq!(get_feerate!(nodes[0], nodes[1], channel_id), feerate + 30);
964 assert_eq!(get_feerate!(nodes[1], nodes[0], channel_id), feerate + 30);
965 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
966 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
967 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
971 fn fake_network_test() {
972 // Simple test which builds a network of ChannelManagers, connects them to each other, and
973 // tests that payments get routed and transactions broadcast in semi-reasonable ways.
974 let chanmon_cfgs = create_chanmon_cfgs(4);
975 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
976 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
977 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
979 // Create some initial channels
980 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
981 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
982 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3);
984 // Rebalance the network a bit by relaying one payment through all the channels...
985 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
986 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
987 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
988 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
990 // Send some more payments
991 send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000);
992 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000);
993 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000);
995 // Test failure packets
996 let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
997 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
999 // Add a new channel that skips 3
1000 let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3);
1002 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000);
1003 send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000);
1004 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1005 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1006 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1007 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1008 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1010 // Do some rebalance loop payments, simultaneously
1011 let mut hops = Vec::with_capacity(3);
1012 hops.push(RouteHop {
1013 pubkey: nodes[2].node.get_our_node_id(),
1014 node_features: NodeFeatures::empty(),
1015 short_channel_id: chan_2.0.contents.short_channel_id,
1016 channel_features: ChannelFeatures::empty(),
1018 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
1020 hops.push(RouteHop {
1021 pubkey: nodes[3].node.get_our_node_id(),
1022 node_features: NodeFeatures::empty(),
1023 short_channel_id: chan_3.0.contents.short_channel_id,
1024 channel_features: ChannelFeatures::empty(),
1026 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
1028 hops.push(RouteHop {
1029 pubkey: nodes[1].node.get_our_node_id(),
1030 node_features: nodes[1].node.node_features(),
1031 short_channel_id: chan_4.0.contents.short_channel_id,
1032 channel_features: nodes[1].node.channel_features(),
1034 cltv_expiry_delta: TEST_FINAL_CLTV,
1036 hops[1].fee_msat = chan_4.1.contents.fee_base_msat as u64 + chan_4.1.contents.fee_proportional_millionths as u64 * hops[2].fee_msat as u64 / 1000000;
1037 hops[0].fee_msat = chan_3.0.contents.fee_base_msat as u64 + chan_3.0.contents.fee_proportional_millionths as u64 * hops[1].fee_msat as u64 / 1000000;
1038 let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![hops], payment_params: None }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
1040 let mut hops = Vec::with_capacity(3);
1041 hops.push(RouteHop {
1042 pubkey: nodes[3].node.get_our_node_id(),
1043 node_features: NodeFeatures::empty(),
1044 short_channel_id: chan_4.0.contents.short_channel_id,
1045 channel_features: ChannelFeatures::empty(),
1047 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
1049 hops.push(RouteHop {
1050 pubkey: nodes[2].node.get_our_node_id(),
1051 node_features: NodeFeatures::empty(),
1052 short_channel_id: chan_3.0.contents.short_channel_id,
1053 channel_features: ChannelFeatures::empty(),
1055 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
1057 hops.push(RouteHop {
1058 pubkey: nodes[1].node.get_our_node_id(),
1059 node_features: nodes[1].node.node_features(),
1060 short_channel_id: chan_2.0.contents.short_channel_id,
1061 channel_features: nodes[1].node.channel_features(),
1063 cltv_expiry_delta: TEST_FINAL_CLTV,
1065 hops[1].fee_msat = chan_2.1.contents.fee_base_msat as u64 + chan_2.1.contents.fee_proportional_millionths as u64 * hops[2].fee_msat as u64 / 1000000;
1066 hops[0].fee_msat = chan_3.1.contents.fee_base_msat as u64 + chan_3.1.contents.fee_proportional_millionths as u64 * hops[1].fee_msat as u64 / 1000000;
1067 let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![hops], payment_params: None }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1069 // Claim the rebalances...
1070 fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1071 claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1);
1073 // Close down the channels...
1074 close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1075 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
1076 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
1077 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1078 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
1079 check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure);
1080 close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1081 check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure);
1082 check_closed_event!(nodes[3], 1, ClosureReason::CooperativeClosure);
1083 close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1084 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
1085 check_closed_event!(nodes[3], 1, ClosureReason::CooperativeClosure);
1089 fn holding_cell_htlc_counting() {
1090 // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1091 // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1092 // commitment dance rounds.
1093 let chanmon_cfgs = create_chanmon_cfgs(3);
1094 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1095 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1096 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1097 create_announced_chan_between_nodes(&nodes, 0, 1);
1098 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
1100 let mut payments = Vec::new();
1101 for _ in 0..crate::ln::channel::OUR_MAX_HTLCS {
1102 let (route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[2], 100000);
1103 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
1104 payments.push((payment_preimage, payment_hash));
1106 check_added_monitors!(nodes[1], 1);
1108 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1109 assert_eq!(events.len(), 1);
1110 let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1111 assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1113 // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1114 // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1116 let (route, payment_hash_1, _, payment_secret_1) = get_route_and_payment_hash!(nodes[1], nodes[2], 100000);
1118 unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1), PaymentId(payment_hash_1.0)), true, APIError::ChannelUnavailable { ref err },
1119 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
1120 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1121 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1124 // This should also be true if we try to forward a payment.
1125 let (route, payment_hash_2, _, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[2], 100000);
1127 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1128 check_added_monitors!(nodes[0], 1);
1131 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1132 assert_eq!(events.len(), 1);
1133 let payment_event = SendEvent::from_event(events.pop().unwrap());
1134 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1136 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1137 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1138 // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1139 // fails), the second will process the resulting failure and fail the HTLC backward.
1140 expect_pending_htlcs_forwardable!(nodes[1]);
1141 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::NextHopChannel { node_id: Some(nodes[2].node.get_our_node_id()), channel_id: chan_2.2 }]);
1142 check_added_monitors!(nodes[1], 1);
1144 let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1145 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1146 commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1148 expect_payment_failed_with_update!(nodes[0], payment_hash_2, false, chan_2.0.contents.short_channel_id, false);
1150 // Now forward all the pending HTLCs and claim them back
1151 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1152 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1153 check_added_monitors!(nodes[2], 1);
1155 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1156 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1157 check_added_monitors!(nodes[1], 1);
1158 let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1160 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1161 check_added_monitors!(nodes[1], 1);
1162 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1164 for ref update in as_updates.update_add_htlcs.iter() {
1165 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1167 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1168 check_added_monitors!(nodes[2], 1);
1169 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1170 check_added_monitors!(nodes[2], 1);
1171 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1173 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1174 check_added_monitors!(nodes[1], 1);
1175 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1176 check_added_monitors!(nodes[1], 1);
1177 let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1179 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1180 check_added_monitors!(nodes[2], 1);
1182 expect_pending_htlcs_forwardable!(nodes[2]);
1184 let events = nodes[2].node.get_and_clear_pending_events();
1185 assert_eq!(events.len(), payments.len());
1186 for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1188 &Event::PaymentClaimable { ref payment_hash, .. } => {
1189 assert_eq!(*payment_hash, *hash);
1191 _ => panic!("Unexpected event"),
1195 for (preimage, _) in payments.drain(..) {
1196 claim_payment(&nodes[1], &[&nodes[2]], preimage);
1199 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
1203 fn duplicate_htlc_test() {
1204 // Test that we accept duplicate payment_hash HTLCs across the network and that
1205 // claiming/failing them are all separate and don't affect each other
1206 let chanmon_cfgs = create_chanmon_cfgs(6);
1207 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1208 let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1209 let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1211 // Create some initial channels to route via 3 to 4/5 from 0/1/2
1212 create_announced_chan_between_nodes(&nodes, 0, 3);
1213 create_announced_chan_between_nodes(&nodes, 1, 3);
1214 create_announced_chan_between_nodes(&nodes, 2, 3);
1215 create_announced_chan_between_nodes(&nodes, 3, 4);
1216 create_announced_chan_between_nodes(&nodes, 3, 5);
1218 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1220 *nodes[0].network_payment_count.borrow_mut() -= 1;
1221 assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1223 *nodes[0].network_payment_count.borrow_mut() -= 1;
1224 assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1226 claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage);
1227 fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1228 claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage);
1232 fn test_duplicate_htlc_different_direction_onchain() {
1233 // Test that ChannelMonitor doesn't generate 2 preimage txn
1234 // when we have 2 HTLCs with same preimage that go across a node
1235 // in opposite directions, even with the same payment secret.
1236 let chanmon_cfgs = create_chanmon_cfgs(2);
1237 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1238 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1239 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1241 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
1244 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
1246 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1248 let (route, _, _, _) = get_route_and_payment_hash!(nodes[1], nodes[0], 800_000);
1249 let node_a_payment_secret = nodes[0].node.create_inbound_payment_for_hash(payment_hash, None, 7200, None).unwrap();
1250 send_along_route_with_secret(&nodes[1], route, &[&[&nodes[0]]], 800_000, payment_hash, node_a_payment_secret);
1252 // Provide preimage to node 0 by claiming payment
1253 nodes[0].node.claim_funds(payment_preimage);
1254 expect_payment_claimed!(nodes[0], payment_hash, 800_000);
1255 check_added_monitors!(nodes[0], 1);
1257 // Broadcast node 1 commitment txn
1258 let remote_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
1260 assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1261 let mut has_both_htlcs = 0; // check htlcs match ones committed
1262 for outp in remote_txn[0].output.iter() {
1263 if outp.value == 800_000 / 1000 {
1264 has_both_htlcs += 1;
1265 } else if outp.value == 900_000 / 1000 {
1266 has_both_htlcs += 1;
1269 assert_eq!(has_both_htlcs, 2);
1271 mine_transaction(&nodes[0], &remote_txn[0]);
1272 check_added_monitors!(nodes[0], 1);
1273 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
1274 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
1276 let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1277 assert_eq!(claim_txn.len(), 3);
1279 check_spends!(claim_txn[0], remote_txn[0]); // Immediate HTLC claim with preimage
1280 check_spends!(claim_txn[1], remote_txn[0]);
1281 check_spends!(claim_txn[2], remote_txn[0]);
1282 let preimage_tx = &claim_txn[0];
1283 let (preimage_bump_tx, timeout_tx) = if claim_txn[1].input[0].previous_output == preimage_tx.input[0].previous_output {
1284 (&claim_txn[1], &claim_txn[2])
1286 (&claim_txn[2], &claim_txn[1])
1289 assert_eq!(preimage_tx.input.len(), 1);
1290 assert_eq!(preimage_bump_tx.input.len(), 1);
1292 assert_eq!(preimage_tx.input.len(), 1);
1293 assert_eq!(preimage_tx.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1294 assert_eq!(remote_txn[0].output[preimage_tx.input[0].previous_output.vout as usize].value, 800);
1296 assert_eq!(timeout_tx.input.len(), 1);
1297 assert_eq!(timeout_tx.input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1298 check_spends!(timeout_tx, remote_txn[0]);
1299 assert_eq!(remote_txn[0].output[timeout_tx.input[0].previous_output.vout as usize].value, 900);
1301 let events = nodes[0].node.get_and_clear_pending_msg_events();
1302 assert_eq!(events.len(), 3);
1305 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1306 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1307 assert_eq!(node_id, nodes[1].node.get_our_node_id());
1308 assert_eq!(msg.data, "Channel closed because commitment or closing transaction was confirmed on chain.");
1310 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, .. } } => {
1311 assert!(update_add_htlcs.is_empty());
1312 assert!(update_fail_htlcs.is_empty());
1313 assert_eq!(update_fulfill_htlcs.len(), 1);
1314 assert!(update_fail_malformed_htlcs.is_empty());
1315 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1317 _ => panic!("Unexpected event"),
1323 fn test_basic_channel_reserve() {
1324 let chanmon_cfgs = create_chanmon_cfgs(2);
1325 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1326 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1327 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1328 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
1330 let chan_stat = get_channel_value_stat!(nodes[0], nodes[1], chan.2);
1331 let channel_reserve = chan_stat.channel_reserve_msat;
1333 // The 2* and +1 are for the fee spike reserve.
1334 let commit_tx_fee = 2 * commit_tx_fee_msat(get_feerate!(nodes[0], nodes[1], chan.2), 1 + 1, get_opt_anchors!(nodes[0], nodes[1], chan.2));
1335 let max_can_send = 5000000 - channel_reserve - commit_tx_fee;
1336 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], max_can_send + 1);
1337 let err = nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).err().unwrap();
1339 PaymentSendFailure::AllFailedResendSafe(ref fails) => {
1341 &APIError::ChannelUnavailable{ref err} =>
1342 assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)),
1343 _ => panic!("Unexpected error variant"),
1346 _ => panic!("Unexpected error variant"),
1348 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1349 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send value that would put our balance under counterparty-announced channel reserve value".to_string(), 1);
1351 send_payment(&nodes[0], &vec![&nodes[1]], max_can_send);
1355 fn test_fee_spike_violation_fails_htlc() {
1356 let chanmon_cfgs = create_chanmon_cfgs(2);
1357 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1358 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1359 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1360 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
1362 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 3460001);
1363 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1364 let secp_ctx = Secp256k1::new();
1365 let session_priv = SecretKey::from_slice(&[42; 32]).expect("RNG is bad!");
1367 let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1369 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1370 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3460001, &Some(payment_secret), cur_height, &None).unwrap();
1371 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1372 let msg = msgs::UpdateAddHTLC {
1375 amount_msat: htlc_msat,
1376 payment_hash: payment_hash,
1377 cltv_expiry: htlc_cltv,
1378 onion_routing_packet: onion_packet,
1381 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1383 // Now manually create the commitment_signed message corresponding to the update_add
1384 // nodes[0] just sent. In the code for construction of this message, "local" refers
1385 // to the sender of the message, and "remote" refers to the receiver.
1387 let feerate_per_kw = get_feerate!(nodes[0], nodes[1], chan.2);
1389 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
1391 // Get the EnforcingSigner for each channel, which will be used to (1) get the keys
1392 // needed to sign the new commitment tx and (2) sign the new commitment tx.
1393 let (local_revocation_basepoint, local_htlc_basepoint, local_secret, next_local_point, local_funding) = {
1394 let per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
1395 let chan_lock = per_peer_state.get(&nodes[1].node.get_our_node_id()).unwrap().lock().unwrap();
1396 let local_chan = chan_lock.channel_by_id.get(&chan.2).unwrap();
1397 let chan_signer = local_chan.get_signer();
1398 // Make the signer believe we validated another commitment, so we can release the secret
1399 chan_signer.get_enforcement_state().last_holder_commitment -= 1;
1401 let pubkeys = chan_signer.pubkeys();
1402 (pubkeys.revocation_basepoint, pubkeys.htlc_basepoint,
1403 chan_signer.release_commitment_secret(INITIAL_COMMITMENT_NUMBER),
1404 chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 2, &secp_ctx),
1405 chan_signer.pubkeys().funding_pubkey)
1407 let (remote_delayed_payment_basepoint, remote_htlc_basepoint, remote_point, remote_funding) = {
1408 let per_peer_state = nodes[1].node.per_peer_state.read().unwrap();
1409 let chan_lock = per_peer_state.get(&nodes[0].node.get_our_node_id()).unwrap().lock().unwrap();
1410 let remote_chan = chan_lock.channel_by_id.get(&chan.2).unwrap();
1411 let chan_signer = remote_chan.get_signer();
1412 let pubkeys = chan_signer.pubkeys();
1413 (pubkeys.delayed_payment_basepoint, pubkeys.htlc_basepoint,
1414 chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 1, &secp_ctx),
1415 chan_signer.pubkeys().funding_pubkey)
1418 // Assemble the set of keys we can use for signatures for our commitment_signed message.
1419 let commit_tx_keys = chan_utils::TxCreationKeys::derive_new(&secp_ctx, &remote_point, &remote_delayed_payment_basepoint,
1420 &remote_htlc_basepoint, &local_revocation_basepoint, &local_htlc_basepoint);
1422 // Build the remote commitment transaction so we can sign it, and then later use the
1423 // signature for the commitment_signed message.
1424 let local_chan_balance = 1313;
1426 let accepted_htlc_info = chan_utils::HTLCOutputInCommitment {
1428 amount_msat: 3460001,
1429 cltv_expiry: htlc_cltv,
1431 transaction_output_index: Some(1),
1434 let commitment_number = INITIAL_COMMITMENT_NUMBER - 1;
1437 let per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
1438 let local_chan_lock = per_peer_state.get(&nodes[1].node.get_our_node_id()).unwrap().lock().unwrap();
1439 let local_chan = local_chan_lock.channel_by_id.get(&chan.2).unwrap();
1440 let local_chan_signer = local_chan.get_signer();
1441 let commitment_tx = CommitmentTransaction::new_with_auxiliary_htlc_data(
1445 local_chan.opt_anchors(), local_funding, remote_funding,
1446 commit_tx_keys.clone(),
1448 &mut vec![(accepted_htlc_info, ())],
1449 &local_chan.channel_transaction_parameters.as_counterparty_broadcastable()
1451 local_chan_signer.sign_counterparty_commitment(&commitment_tx, Vec::new(), &secp_ctx).unwrap()
1454 let commit_signed_msg = msgs::CommitmentSigned {
1457 htlc_signatures: res.1
1460 // Send the commitment_signed message to the nodes[1].
1461 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commit_signed_msg);
1462 let _ = nodes[1].node.get_and_clear_pending_msg_events();
1464 // Send the RAA to nodes[1].
1465 let raa_msg = msgs::RevokeAndACK {
1467 per_commitment_secret: local_secret,
1468 next_per_commitment_point: next_local_point
1470 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_msg);
1472 let events = nodes[1].node.get_and_clear_pending_msg_events();
1473 assert_eq!(events.len(), 1);
1474 // Make sure the HTLC failed in the way we expect.
1476 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, .. }, .. } => {
1477 assert_eq!(update_fail_htlcs.len(), 1);
1478 update_fail_htlcs[0].clone()
1480 _ => panic!("Unexpected event"),
1482 nodes[1].logger.assert_log("lightning::ln::channel".to_string(),
1483 format!("Attempting to fail HTLC due to fee spike buffer violation in channel {}. Rebalancing is required.", ::hex::encode(raa_msg.channel_id)), 1);
1485 check_added_monitors!(nodes[1], 2);
1489 fn test_chan_reserve_violation_outbound_htlc_inbound_chan() {
1490 let mut chanmon_cfgs = create_chanmon_cfgs(2);
1491 // Set the fee rate for the channel very high, to the point where the fundee
1492 // sending any above-dust amount would result in a channel reserve violation.
1493 // In this test we check that we would be prevented from sending an HTLC in
1495 let feerate_per_kw = *chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
1496 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1497 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1498 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1499 let default_config = UserConfig::default();
1500 let opt_anchors = false;
1502 let mut push_amt = 100_000_000;
1503 push_amt -= commit_tx_fee_msat(feerate_per_kw, MIN_AFFORDABLE_HTLC_COUNT as u64, opt_anchors);
1505 push_amt -= Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100_000, &default_config) * 1000;
1507 let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, push_amt);
1509 // Sending exactly enough to hit the reserve amount should be accepted
1510 for _ in 0..MIN_AFFORDABLE_HTLC_COUNT {
1511 let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], 1_000_000);
1514 // However one more HTLC should be significantly over the reserve amount and fail.
1515 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 1_000_000);
1516 unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)), true, APIError::ChannelUnavailable { ref err },
1517 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1518 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1519 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put counterparty balance under holder-announced channel reserve value".to_string(), 1);
1523 fn test_chan_reserve_violation_inbound_htlc_outbound_channel() {
1524 let mut chanmon_cfgs = create_chanmon_cfgs(2);
1525 let feerate_per_kw = *chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
1526 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1527 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1528 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1529 let default_config = UserConfig::default();
1530 let opt_anchors = false;
1532 // Set nodes[0]'s balance such that they will consider any above-dust received HTLC to be a
1533 // channel reserve violation (so their balance is channel reserve (1000 sats) + commitment
1534 // transaction fee with 0 HTLCs (183 sats)).
1535 let mut push_amt = 100_000_000;
1536 push_amt -= commit_tx_fee_msat(feerate_per_kw, MIN_AFFORDABLE_HTLC_COUNT as u64, opt_anchors);
1537 push_amt -= Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100_000, &default_config) * 1000;
1538 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, push_amt);
1540 // Send four HTLCs to cover the initial push_msat buffer we're required to include
1541 for _ in 0..MIN_AFFORDABLE_HTLC_COUNT {
1542 let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], 1_000_000);
1545 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 700_000);
1546 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1547 let secp_ctx = Secp256k1::new();
1548 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1549 let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1550 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1551 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 700_000, &Some(payment_secret), cur_height, &None).unwrap();
1552 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1553 let msg = msgs::UpdateAddHTLC {
1555 htlc_id: MIN_AFFORDABLE_HTLC_COUNT as u64,
1556 amount_msat: htlc_msat,
1557 payment_hash: payment_hash,
1558 cltv_expiry: htlc_cltv,
1559 onion_routing_packet: onion_packet,
1562 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &msg);
1563 // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1564 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value".to_string(), 1);
1565 assert_eq!(nodes[0].node.list_channels().len(), 0);
1566 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
1567 assert_eq!(err_msg.data, "Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value");
1568 check_added_monitors!(nodes[0], 1);
1569 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value".to_string() });
1573 fn test_chan_reserve_dust_inbound_htlcs_outbound_chan() {
1574 // Test that if we receive many dust HTLCs over an outbound channel, they don't count when
1575 // calculating our commitment transaction fee (this was previously broken).
1576 let mut chanmon_cfgs = create_chanmon_cfgs(2);
1577 let feerate_per_kw = *chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
1579 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1580 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1581 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1582 let default_config = UserConfig::default();
1583 let opt_anchors = false;
1585 // Set nodes[0]'s balance such that they will consider any above-dust received HTLC to be a
1586 // channel reserve violation (so their balance is channel reserve (1000 sats) + commitment
1587 // transaction fee with 0 HTLCs (183 sats)).
1588 let mut push_amt = 100_000_000;
1589 push_amt -= commit_tx_fee_msat(feerate_per_kw, MIN_AFFORDABLE_HTLC_COUNT as u64, opt_anchors);
1590 push_amt -= Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100_000, &default_config) * 1000;
1591 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, push_amt);
1593 let dust_amt = crate::ln::channel::MIN_CHAN_DUST_LIMIT_SATOSHIS * 1000
1594 + feerate_per_kw as u64 * htlc_success_tx_weight(opt_anchors) / 1000 * 1000 - 1;
1595 // In the previous code, routing this dust payment would cause nodes[0] to perceive a channel
1596 // reserve violation even though it's a dust HTLC and therefore shouldn't count towards the
1597 // commitment transaction fee.
1598 let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], dust_amt);
1600 // Send four HTLCs to cover the initial push_msat buffer we're required to include
1601 for _ in 0..MIN_AFFORDABLE_HTLC_COUNT {
1602 let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], 1_000_000);
1605 // One more than the dust amt should fail, however.
1606 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], dust_amt + 1);
1607 unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)), true, APIError::ChannelUnavailable { ref err },
1608 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1612 fn test_chan_init_feerate_unaffordability() {
1613 // Test that we will reject channel opens which do not leave enough to pay for any HTLCs due to
1614 // channel reserve and feerate requirements.
1615 let mut chanmon_cfgs = create_chanmon_cfgs(2);
1616 let feerate_per_kw = *chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
1617 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1618 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1619 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1620 let default_config = UserConfig::default();
1621 let opt_anchors = false;
1623 // Set the push_msat amount such that nodes[0] will not be able to afford to add even a single
1625 let mut push_amt = 100_000_000;
1626 push_amt -= commit_tx_fee_msat(feerate_per_kw, MIN_AFFORDABLE_HTLC_COUNT as u64, opt_anchors);
1627 assert_eq!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, push_amt + 1, 42, None).unwrap_err(),
1628 APIError::APIMisuseError { err: "Funding amount (356) can't even pay fee for initial commitment transaction fee of 357.".to_string() });
1630 // During open, we don't have a "counterparty channel reserve" to check against, so that
1631 // requirement only comes into play on the open_channel handling side.
1632 push_amt -= Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100_000, &default_config) * 1000;
1633 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, push_amt, 42, None).unwrap();
1634 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
1635 open_channel_msg.push_msat += 1;
1636 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
1638 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
1639 assert_eq!(msg_events.len(), 1);
1640 match msg_events[0] {
1641 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
1642 assert_eq!(msg.data, "Insufficient funding amount for initial reserve");
1644 _ => panic!("Unexpected event"),
1649 fn test_chan_reserve_dust_inbound_htlcs_inbound_chan() {
1650 // Test that if we receive many dust HTLCs over an inbound channel, they don't count when
1651 // calculating our counterparty's commitment transaction fee (this was previously broken).
1652 let chanmon_cfgs = create_chanmon_cfgs(2);
1653 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1654 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1655 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1656 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98000000);
1658 let payment_amt = 46000; // Dust amount
1659 // In the previous code, these first four payments would succeed.
1660 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1661 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1662 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1663 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1665 // Then these next 5 would be interpreted by nodes[1] as violating the fee spike buffer.
1666 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1667 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1668 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1669 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1670 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1672 // And this last payment previously resulted in nodes[1] closing on its inbound-channel
1673 // counterparty, because it counted all the previous dust HTLCs against nodes[0]'s commitment
1674 // transaction fee and therefore perceived this next payment as a channel reserve violation.
1675 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1679 fn test_chan_reserve_violation_inbound_htlc_inbound_chan() {
1680 let chanmon_cfgs = create_chanmon_cfgs(3);
1681 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1682 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1683 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1684 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
1685 let _ = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000);
1688 let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1689 let chan_stat = get_channel_value_stat!(nodes[0], nodes[1], chan.2);
1690 let feerate = get_feerate!(nodes[0], nodes[1], chan.2);
1691 let opt_anchors = get_opt_anchors!(nodes[0], nodes[1], chan.2);
1693 // Add a 2* and +1 for the fee spike reserve.
1694 let commit_tx_fee_2_htlc = 2*commit_tx_fee_msat(feerate, 2 + 1, opt_anchors);
1695 let recv_value_1 = (chan_stat.value_to_self_msat - chan_stat.channel_reserve_msat - total_routing_fee_msat - commit_tx_fee_2_htlc)/2;
1696 let amt_msat_1 = recv_value_1 + total_routing_fee_msat;
1698 // Add a pending HTLC.
1699 let (route_1, our_payment_hash_1, _, our_payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_1);
1700 let payment_event_1 = {
1701 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1), PaymentId(our_payment_hash_1.0)).unwrap();
1702 check_added_monitors!(nodes[0], 1);
1704 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1705 assert_eq!(events.len(), 1);
1706 SendEvent::from_event(events.remove(0))
1708 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1710 // Attempt to trigger a channel reserve violation --> payment failure.
1711 let commit_tx_fee_2_htlcs = commit_tx_fee_msat(feerate, 2, opt_anchors);
1712 let recv_value_2 = chan_stat.value_to_self_msat - amt_msat_1 - chan_stat.channel_reserve_msat - total_routing_fee_msat - commit_tx_fee_2_htlcs + 1;
1713 let amt_msat_2 = recv_value_2 + total_routing_fee_msat;
1714 let (route_2, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_2);
1716 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1717 let secp_ctx = Secp256k1::new();
1718 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1719 let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
1720 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route_2.paths[0], &session_priv).unwrap();
1721 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route_2.paths[0], recv_value_2, &None, cur_height, &None).unwrap();
1722 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash_1);
1723 let msg = msgs::UpdateAddHTLC {
1726 amount_msat: htlc_msat + 1,
1727 payment_hash: our_payment_hash_1,
1728 cltv_expiry: htlc_cltv,
1729 onion_routing_packet: onion_packet,
1732 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1733 // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1734 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote HTLC add would put them under remote reserve value".to_string(), 1);
1735 assert_eq!(nodes[1].node.list_channels().len(), 1);
1736 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1737 assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
1738 check_added_monitors!(nodes[1], 1);
1739 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "Remote HTLC add would put them under remote reserve value".to_string() });
1743 fn test_inbound_outbound_capacity_is_not_zero() {
1744 let chanmon_cfgs = create_chanmon_cfgs(2);
1745 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1746 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1747 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1748 let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
1749 let channels0 = node_chanmgrs[0].list_channels();
1750 let channels1 = node_chanmgrs[1].list_channels();
1751 let default_config = UserConfig::default();
1752 assert_eq!(channels0.len(), 1);
1753 assert_eq!(channels1.len(), 1);
1755 let reserve = Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100_000, &default_config);
1756 assert_eq!(channels0[0].inbound_capacity_msat, 95000000 - reserve*1000);
1757 assert_eq!(channels1[0].outbound_capacity_msat, 95000000 - reserve*1000);
1759 assert_eq!(channels0[0].outbound_capacity_msat, 100000 * 1000 - 95000000 - reserve*1000);
1760 assert_eq!(channels1[0].inbound_capacity_msat, 100000 * 1000 - 95000000 - reserve*1000);
1763 fn commit_tx_fee_msat(feerate: u32, num_htlcs: u64, opt_anchors: bool) -> u64 {
1764 (commitment_tx_base_weight(opt_anchors) + num_htlcs * COMMITMENT_TX_WEIGHT_PER_HTLC) * feerate as u64 / 1000 * 1000
1768 fn test_channel_reserve_holding_cell_htlcs() {
1769 let chanmon_cfgs = create_chanmon_cfgs(3);
1770 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1771 // When this test was written, the default base fee floated based on the HTLC count.
1772 // It is now fixed, so we simply set the fee to the expected value here.
1773 let mut config = test_default_channel_config();
1774 config.channel_config.forwarding_fee_base_msat = 239;
1775 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config.clone()), Some(config.clone()), Some(config.clone())]);
1776 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1777 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 190000, 1001);
1778 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 190000, 1001);
1780 let mut stat01 = get_channel_value_stat!(nodes[0], nodes[1], chan_1.2);
1781 let mut stat11 = get_channel_value_stat!(nodes[1], nodes[0], chan_1.2);
1783 let mut stat12 = get_channel_value_stat!(nodes[1], nodes[2], chan_2.2);
1784 let mut stat22 = get_channel_value_stat!(nodes[2], nodes[1], chan_2.2);
1786 macro_rules! expect_forward {
1788 let mut events = $node.node.get_and_clear_pending_msg_events();
1789 assert_eq!(events.len(), 1);
1790 check_added_monitors!($node, 1);
1791 let payment_event = SendEvent::from_event(events.remove(0));
1796 let feemsat = 239; // set above
1797 let total_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1798 let feerate = get_feerate!(nodes[0], nodes[1], chan_1.2);
1799 let opt_anchors = get_opt_anchors!(nodes[0], nodes[1], chan_1.2);
1801 let recv_value_0 = stat01.counterparty_max_htlc_value_in_flight_msat - total_fee_msat;
1803 // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1805 let payment_params = PaymentParameters::from_node_id(nodes[2].node.get_our_node_id())
1806 .with_features(nodes[2].node.invoice_features()).with_max_channel_saturation_power_of_half(0);
1807 let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], payment_params, recv_value_0, TEST_FINAL_CLTV);
1808 route.paths[0].last_mut().unwrap().fee_msat += 1;
1809 assert!(route.paths[0].iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1811 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)), true, APIError::ChannelUnavailable { ref err },
1812 assert!(regex::Regex::new(r"Cannot send value that would put us over the max HTLC value in flight our peer will accept \(\d+\)").unwrap().is_match(err)));
1813 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1814 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over the max HTLC value in flight our peer will accept".to_string(), 1);
1817 // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1818 // nodes[0]'s wealth
1820 let amt_msat = recv_value_0 + total_fee_msat;
1821 // 3 for the 3 HTLCs that will be sent, 2* and +1 for the fee spike reserve.
1822 // Also, ensure that each payment has enough to be over the dust limit to
1823 // ensure it'll be included in each commit tx fee calculation.
1824 let commit_tx_fee_all_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1, opt_anchors);
1825 let ensure_htlc_amounts_above_dust_buffer = 3 * (stat01.counterparty_dust_limit_msat + 1000);
1826 if stat01.value_to_self_msat < stat01.channel_reserve_msat + commit_tx_fee_all_htlcs + ensure_htlc_amounts_above_dust_buffer + amt_msat {
1830 let payment_params = PaymentParameters::from_node_id(nodes[2].node.get_our_node_id())
1831 .with_features(nodes[2].node.invoice_features()).with_max_channel_saturation_power_of_half(0);
1832 let route = get_route!(nodes[0], payment_params, recv_value_0, TEST_FINAL_CLTV).unwrap();
1833 let (payment_preimage, ..) = send_along_route(&nodes[0], route, &[&nodes[1], &nodes[2]], recv_value_0);
1834 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
1836 let (stat01_, stat11_, stat12_, stat22_) = (
1837 get_channel_value_stat!(nodes[0], nodes[1], chan_1.2),
1838 get_channel_value_stat!(nodes[1], nodes[0], chan_1.2),
1839 get_channel_value_stat!(nodes[1], nodes[2], chan_2.2),
1840 get_channel_value_stat!(nodes[2], nodes[1], chan_2.2),
1843 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1844 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1845 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1846 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1847 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1850 // adding pending output.
1851 // 2* and +1 HTLCs on the commit tx fee for the fee spike reserve.
1852 // The reason we're dividing by two here is as follows: the dividend is the total outbound liquidity
1853 // after fees, the channel reserve, and the fee spike buffer are removed. We eventually want to
1854 // divide this quantity into 3 portions, that will each be sent in an HTLC. This allows us
1855 // to test channel channel reserve policy at the edges of what amount is sendable, i.e.
1856 // cases where 1 msat over X amount will cause a payment failure, but anything less than
1857 // that can be sent successfully. So, dividing by two is a somewhat arbitrary way of getting
1858 // the amount of the first of these aforementioned 3 payments. The reason we split into 3 payments
1859 // is to test the behavior of the holding cell with respect to channel reserve and commit tx fee
1861 let commit_tx_fee_2_htlcs = 2*commit_tx_fee_msat(feerate, 2 + 1, opt_anchors);
1862 let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs)/2;
1863 let amt_msat_1 = recv_value_1 + total_fee_msat;
1865 let (route_1, our_payment_hash_1, our_payment_preimage_1, our_payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_1);
1866 let payment_event_1 = {
1867 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1), PaymentId(our_payment_hash_1.0)).unwrap();
1868 check_added_monitors!(nodes[0], 1);
1870 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1871 assert_eq!(events.len(), 1);
1872 SendEvent::from_event(events.remove(0))
1874 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1876 // channel reserve test with htlc pending output > 0
1877 let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs;
1879 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_2 + 1);
1880 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)), true, APIError::ChannelUnavailable { ref err },
1881 assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
1882 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1885 // split the rest to test holding cell
1886 let commit_tx_fee_3_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1, opt_anchors);
1887 let additional_htlc_cost_msat = commit_tx_fee_3_htlcs - commit_tx_fee_2_htlcs;
1888 let recv_value_21 = recv_value_2/2 - additional_htlc_cost_msat/2;
1889 let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat - additional_htlc_cost_msat;
1891 let stat = get_channel_value_stat!(nodes[0], nodes[1], chan_1.2);
1892 assert_eq!(stat.value_to_self_msat - (stat.pending_outbound_htlcs_amount_msat + recv_value_21 + recv_value_22 + total_fee_msat + total_fee_msat + commit_tx_fee_3_htlcs), stat.channel_reserve_msat);
1895 // now see if they go through on both sides
1896 let (route_21, our_payment_hash_21, our_payment_preimage_21, our_payment_secret_21) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_21);
1897 // but this will stuck in the holding cell
1898 nodes[0].node.send_payment(&route_21, our_payment_hash_21, &Some(our_payment_secret_21), PaymentId(our_payment_hash_21.0)).unwrap();
1899 check_added_monitors!(nodes[0], 0);
1900 let events = nodes[0].node.get_and_clear_pending_events();
1901 assert_eq!(events.len(), 0);
1903 // test with outbound holding cell amount > 0
1905 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_22+1);
1906 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)), true, APIError::ChannelUnavailable { ref err },
1907 assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
1908 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1909 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send value that would put our balance under counterparty-announced channel reserve value".to_string(), 2);
1912 let (route_22, our_payment_hash_22, our_payment_preimage_22, our_payment_secret_22) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_22);
1913 // this will also stuck in the holding cell
1914 nodes[0].node.send_payment(&route_22, our_payment_hash_22, &Some(our_payment_secret_22), PaymentId(our_payment_hash_22.0)).unwrap();
1915 check_added_monitors!(nodes[0], 0);
1916 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1917 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1919 // flush the pending htlc
1920 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
1921 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1922 check_added_monitors!(nodes[1], 1);
1924 // the pending htlc should be promoted to committed
1925 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
1926 check_added_monitors!(nodes[0], 1);
1927 let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1929 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
1930 let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1931 // No commitment_signed so get_event_msg's assert(len == 1) passes
1932 check_added_monitors!(nodes[0], 1);
1934 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
1935 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1936 check_added_monitors!(nodes[1], 1);
1938 expect_pending_htlcs_forwardable!(nodes[1]);
1940 let ref payment_event_11 = expect_forward!(nodes[1]);
1941 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
1942 commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
1944 expect_pending_htlcs_forwardable!(nodes[2]);
1945 expect_payment_claimable!(nodes[2], our_payment_hash_1, our_payment_secret_1, recv_value_1);
1947 // flush the htlcs in the holding cell
1948 assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
1949 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
1950 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
1951 commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
1952 expect_pending_htlcs_forwardable!(nodes[1]);
1954 let ref payment_event_3 = expect_forward!(nodes[1]);
1955 assert_eq!(payment_event_3.msgs.len(), 2);
1956 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
1957 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
1959 commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
1960 expect_pending_htlcs_forwardable!(nodes[2]);
1962 let events = nodes[2].node.get_and_clear_pending_events();
1963 assert_eq!(events.len(), 2);
1965 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, via_user_channel_id: _ } => {
1966 assert_eq!(our_payment_hash_21, *payment_hash);
1967 assert_eq!(recv_value_21, amount_msat);
1968 assert_eq!(nodes[2].node.get_our_node_id(), receiver_node_id.unwrap());
1969 assert_eq!(via_channel_id, Some(chan_2.2));
1971 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1972 assert!(payment_preimage.is_none());
1973 assert_eq!(our_payment_secret_21, *payment_secret);
1975 _ => panic!("expected PaymentPurpose::InvoicePayment")
1978 _ => panic!("Unexpected event"),
1981 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, via_user_channel_id: _ } => {
1982 assert_eq!(our_payment_hash_22, *payment_hash);
1983 assert_eq!(recv_value_22, amount_msat);
1984 assert_eq!(nodes[2].node.get_our_node_id(), receiver_node_id.unwrap());
1985 assert_eq!(via_channel_id, Some(chan_2.2));
1987 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1988 assert!(payment_preimage.is_none());
1989 assert_eq!(our_payment_secret_22, *payment_secret);
1991 _ => panic!("expected PaymentPurpose::InvoicePayment")
1994 _ => panic!("Unexpected event"),
1997 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1);
1998 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21);
1999 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22);
2001 let commit_tx_fee_0_htlcs = 2*commit_tx_fee_msat(feerate, 1, opt_anchors);
2002 let recv_value_3 = commit_tx_fee_2_htlcs - commit_tx_fee_0_htlcs - total_fee_msat;
2003 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_3);
2005 let commit_tx_fee_1_htlc = 2*commit_tx_fee_msat(feerate, 1 + 1, opt_anchors);
2006 let expected_value_to_self = stat01.value_to_self_msat - (recv_value_1 + total_fee_msat) - (recv_value_21 + total_fee_msat) - (recv_value_22 + total_fee_msat) - (recv_value_3 + total_fee_msat);
2007 let stat0 = get_channel_value_stat!(nodes[0], nodes[1], chan_1.2);
2008 assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
2009 assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat + commit_tx_fee_1_htlc);
2011 let stat2 = get_channel_value_stat!(nodes[2], nodes[1], chan_2.2);
2012 assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22 + recv_value_3);
2016 fn channel_reserve_in_flight_removes() {
2017 // In cases where one side claims an HTLC, it thinks it has additional available funds that it
2018 // can send to its counterparty, but due to update ordering, the other side may not yet have
2019 // considered those HTLCs fully removed.
2020 // This tests that we don't count HTLCs which will not be included in the next remote
2021 // commitment transaction towards the reserve value (as it implies no commitment transaction
2022 // will be generated which violates the remote reserve value).
2023 // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
2025 // * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
2026 // you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
2027 // you only consider the value of the first HTLC, it may not),
2028 // * start routing a third HTLC from A to B,
2029 // * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
2030 // the other claim in its holding cell, as it immediately goes into AwaitingRAA),
2031 // * deliver the first fulfill from B
2032 // * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
2034 // * deliver A's response CS and RAA.
2035 // This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
2036 // removed it fully. B now has the push_msat plus the first two HTLCs in value.
2037 // * Now B happily sends another HTLC, potentially violating its reserve value from A's point
2038 // of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
2039 let chanmon_cfgs = create_chanmon_cfgs(2);
2040 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2041 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2042 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2043 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
2045 let b_chan_values = get_channel_value_stat!(nodes[1], nodes[0], chan_1.2);
2046 // Route the first two HTLCs.
2047 let payment_value_1 = b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000;
2048 let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], payment_value_1);
2049 let (payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[0], &[&nodes[1]], 20_000);
2051 // Start routing the third HTLC (this is just used to get everyone in the right state).
2052 let (route, payment_hash_3, payment_preimage_3, payment_secret_3) = get_route_and_payment_hash!(nodes[0], nodes[1], 100000);
2054 nodes[0].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3), PaymentId(payment_hash_3.0)).unwrap();
2055 check_added_monitors!(nodes[0], 1);
2056 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2057 assert_eq!(events.len(), 1);
2058 SendEvent::from_event(events.remove(0))
2061 // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
2062 // initial fulfill/CS.
2063 nodes[1].node.claim_funds(payment_preimage_1);
2064 expect_payment_claimed!(nodes[1], payment_hash_1, payment_value_1);
2065 check_added_monitors!(nodes[1], 1);
2066 let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2068 // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
2069 // remove the second HTLC when we send the HTLC back from B to A.
2070 nodes[1].node.claim_funds(payment_preimage_2);
2071 expect_payment_claimed!(nodes[1], payment_hash_2, 20_000);
2072 check_added_monitors!(nodes[1], 1);
2073 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2075 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
2076 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
2077 check_added_monitors!(nodes[0], 1);
2078 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2079 expect_payment_sent_without_paths!(nodes[0], payment_preimage_1);
2081 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
2082 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
2083 check_added_monitors!(nodes[1], 1);
2084 // B is already AwaitingRAA, so cant generate a CS here
2085 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2087 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2088 check_added_monitors!(nodes[1], 1);
2089 let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2091 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2092 check_added_monitors!(nodes[0], 1);
2093 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2095 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2096 check_added_monitors!(nodes[1], 1);
2097 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2099 // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
2100 // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
2101 // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
2102 // can no longer broadcast a commitment transaction with it and B has the preimage so can go
2103 // on-chain as necessary).
2104 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
2105 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
2106 check_added_monitors!(nodes[0], 1);
2107 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2108 expect_payment_sent_without_paths!(nodes[0], payment_preimage_2);
2110 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2111 check_added_monitors!(nodes[1], 1);
2112 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2114 expect_pending_htlcs_forwardable!(nodes[1]);
2115 expect_payment_claimable!(nodes[1], payment_hash_3, payment_secret_3, 100000);
2117 // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
2118 // resolve the second HTLC from A's point of view.
2119 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2120 check_added_monitors!(nodes[0], 1);
2121 expect_payment_path_successful!(nodes[0]);
2122 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2124 // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
2125 // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
2126 let (route, payment_hash_4, payment_preimage_4, payment_secret_4) = get_route_and_payment_hash!(nodes[1], nodes[0], 10000);
2128 nodes[1].node.send_payment(&route, payment_hash_4, &Some(payment_secret_4), PaymentId(payment_hash_4.0)).unwrap();
2129 check_added_monitors!(nodes[1], 1);
2130 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
2131 assert_eq!(events.len(), 1);
2132 SendEvent::from_event(events.remove(0))
2135 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
2136 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
2137 check_added_monitors!(nodes[0], 1);
2138 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2140 // Now just resolve all the outstanding messages/HTLCs for completeness...
2142 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2143 check_added_monitors!(nodes[1], 1);
2144 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2146 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2147 check_added_monitors!(nodes[1], 1);
2149 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2150 check_added_monitors!(nodes[0], 1);
2151 expect_payment_path_successful!(nodes[0]);
2152 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2154 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2155 check_added_monitors!(nodes[1], 1);
2156 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2158 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2159 check_added_monitors!(nodes[0], 1);
2161 expect_pending_htlcs_forwardable!(nodes[0]);
2162 expect_payment_claimable!(nodes[0], payment_hash_4, payment_secret_4, 10000);
2164 claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4);
2165 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3);
2169 fn channel_monitor_network_test() {
2170 // Simple test which builds a network of ChannelManagers, connects them to each other, and
2171 // tests that ChannelMonitor is able to recover from various states.
2172 let chanmon_cfgs = create_chanmon_cfgs(5);
2173 let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
2174 let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
2175 let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
2177 // Create some initial channels
2178 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
2179 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
2180 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3);
2181 let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4);
2183 // Make sure all nodes are at the same starting height
2184 connect_blocks(&nodes[0], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
2185 connect_blocks(&nodes[1], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
2186 connect_blocks(&nodes[2], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
2187 connect_blocks(&nodes[3], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[3].best_block_info().1);
2188 connect_blocks(&nodes[4], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[4].best_block_info().1);
2190 // Rebalance the network a bit by relaying one payment through all the channels...
2191 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2192 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2193 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2194 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2196 // Simple case with no pending HTLCs:
2197 nodes[1].node.force_close_broadcasting_latest_txn(&chan_1.2, &nodes[0].node.get_our_node_id()).unwrap();
2198 check_added_monitors!(nodes[1], 1);
2199 check_closed_broadcast!(nodes[1], true);
2201 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
2202 assert_eq!(node_txn.len(), 1);
2203 mine_transaction(&nodes[0], &node_txn[0]);
2204 check_added_monitors!(nodes[0], 1);
2205 test_txn_broadcast(&nodes[0], &chan_1, Some(node_txn[0].clone()), HTLCType::NONE);
2207 check_closed_broadcast!(nodes[0], true);
2208 assert_eq!(nodes[0].node.list_channels().len(), 0);
2209 assert_eq!(nodes[1].node.list_channels().len(), 1);
2210 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
2211 check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed);
2213 // One pending HTLC is discarded by the force-close:
2214 let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[1], &[&nodes[2], &nodes[3]], 3_000_000);
2216 // Simple case of one pending HTLC to HTLC-Timeout (note that the HTLC-Timeout is not
2217 // broadcasted until we reach the timelock time).
2218 nodes[1].node.force_close_broadcasting_latest_txn(&chan_2.2, &nodes[2].node.get_our_node_id()).unwrap();
2219 check_closed_broadcast!(nodes[1], true);
2220 check_added_monitors!(nodes[1], 1);
2222 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::NONE);
2223 connect_blocks(&nodes[1], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + MIN_CLTV_EXPIRY_DELTA as u32 + 1);
2224 test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
2225 mine_transaction(&nodes[2], &node_txn[0]);
2226 check_added_monitors!(nodes[2], 1);
2227 test_txn_broadcast(&nodes[2], &chan_2, Some(node_txn[0].clone()), HTLCType::NONE);
2229 check_closed_broadcast!(nodes[2], true);
2230 assert_eq!(nodes[1].node.list_channels().len(), 0);
2231 assert_eq!(nodes[2].node.list_channels().len(), 1);
2232 check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed);
2233 check_closed_event!(nodes[2], 1, ClosureReason::CommitmentTxConfirmed);
2235 macro_rules! claim_funds {
2236 ($node: expr, $prev_node: expr, $preimage: expr, $payment_hash: expr) => {
2238 $node.node.claim_funds($preimage);
2239 expect_payment_claimed!($node, $payment_hash, 3_000_000);
2240 check_added_monitors!($node, 1);
2242 let events = $node.node.get_and_clear_pending_msg_events();
2243 assert_eq!(events.len(), 1);
2245 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2246 assert!(update_add_htlcs.is_empty());
2247 assert!(update_fail_htlcs.is_empty());
2248 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2250 _ => panic!("Unexpected event"),
2256 // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2257 // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2258 nodes[2].node.force_close_broadcasting_latest_txn(&chan_3.2, &nodes[3].node.get_our_node_id()).unwrap();
2259 check_added_monitors!(nodes[2], 1);
2260 check_closed_broadcast!(nodes[2], true);
2261 let node2_commitment_txid;
2263 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::NONE);
2264 connect_blocks(&nodes[2], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + MIN_CLTV_EXPIRY_DELTA as u32 + 1);
2265 test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2266 node2_commitment_txid = node_txn[0].txid();
2268 // Claim the payment on nodes[3], giving it knowledge of the preimage
2269 claim_funds!(nodes[3], nodes[2], payment_preimage_1, payment_hash_1);
2270 mine_transaction(&nodes[3], &node_txn[0]);
2271 check_added_monitors!(nodes[3], 1);
2272 check_preimage_claim(&nodes[3], &node_txn);
2274 check_closed_broadcast!(nodes[3], true);
2275 assert_eq!(nodes[2].node.list_channels().len(), 0);
2276 assert_eq!(nodes[3].node.list_channels().len(), 1);
2277 check_closed_event!(nodes[2], 1, ClosureReason::HolderForceClosed);
2278 check_closed_event!(nodes[3], 1, ClosureReason::CommitmentTxConfirmed);
2280 // Drop the ChannelMonitor for the previous channel to avoid it broadcasting transactions and
2281 // confusing us in the following tests.
2282 let chan_3_mon = nodes[3].chain_monitor.chain_monitor.remove_monitor(&OutPoint { txid: chan_3.3.txid(), index: 0 });
2284 // One pending HTLC to time out:
2285 let (payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[3], &[&nodes[4]], 3_000_000);
2286 // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2289 let (close_chan_update_1, close_chan_update_2) = {
2290 connect_blocks(&nodes[3], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
2291 let events = nodes[3].node.get_and_clear_pending_msg_events();
2292 assert_eq!(events.len(), 2);
2293 let close_chan_update_1 = match events[0] {
2294 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2297 _ => panic!("Unexpected event"),
2300 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2301 assert_eq!(node_id, nodes[4].node.get_our_node_id());
2303 _ => panic!("Unexpected event"),
2305 check_added_monitors!(nodes[3], 1);
2307 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2309 let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2310 node_txn.retain(|tx| {
2311 if tx.input[0].previous_output.txid == node2_commitment_txid {
2317 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2319 // Claim the payment on nodes[4], giving it knowledge of the preimage
2320 claim_funds!(nodes[4], nodes[3], payment_preimage_2, payment_hash_2);
2322 connect_blocks(&nodes[4], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + 2);
2323 let events = nodes[4].node.get_and_clear_pending_msg_events();
2324 assert_eq!(events.len(), 2);
2325 let close_chan_update_2 = match events[0] {
2326 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2329 _ => panic!("Unexpected event"),
2332 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2333 assert_eq!(node_id, nodes[3].node.get_our_node_id());
2335 _ => panic!("Unexpected event"),
2337 check_added_monitors!(nodes[4], 1);
2338 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2340 mine_transaction(&nodes[4], &node_txn[0]);
2341 check_preimage_claim(&nodes[4], &node_txn);
2342 (close_chan_update_1, close_chan_update_2)
2344 nodes[3].gossip_sync.handle_channel_update(&close_chan_update_2).unwrap();
2345 nodes[4].gossip_sync.handle_channel_update(&close_chan_update_1).unwrap();
2346 assert_eq!(nodes[3].node.list_channels().len(), 0);
2347 assert_eq!(nodes[4].node.list_channels().len(), 0);
2349 assert_eq!(nodes[3].chain_monitor.chain_monitor.watch_channel(OutPoint { txid: chan_3.3.txid(), index: 0 }, chan_3_mon),
2350 ChannelMonitorUpdateStatus::Completed);
2351 check_closed_event!(nodes[3], 1, ClosureReason::CommitmentTxConfirmed);
2352 check_closed_event!(nodes[4], 1, ClosureReason::CommitmentTxConfirmed);
2356 fn test_justice_tx() {
2357 // Test justice txn built on revoked HTLC-Success tx, against both sides
2358 let mut alice_config = UserConfig::default();
2359 alice_config.channel_handshake_config.announced_channel = true;
2360 alice_config.channel_handshake_limits.force_announced_channel_preference = false;
2361 alice_config.channel_handshake_config.our_to_self_delay = 6 * 24 * 5;
2362 let mut bob_config = UserConfig::default();
2363 bob_config.channel_handshake_config.announced_channel = true;
2364 bob_config.channel_handshake_limits.force_announced_channel_preference = false;
2365 bob_config.channel_handshake_config.our_to_self_delay = 6 * 24 * 3;
2366 let user_cfgs = [Some(alice_config), Some(bob_config)];
2367 let mut chanmon_cfgs = create_chanmon_cfgs(2);
2368 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2369 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
2370 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2371 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2372 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2373 *nodes[0].connect_style.borrow_mut() = ConnectStyle::FullBlockViaListen;
2374 // Create some new channels:
2375 let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1);
2377 // A pending HTLC which will be revoked:
2378 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2379 // Get the will-be-revoked local txn from nodes[0]
2380 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2381 assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2382 assert_eq!(revoked_local_txn[0].input.len(), 1);
2383 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2384 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2385 assert_eq!(revoked_local_txn[1].input.len(), 1);
2386 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2387 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2388 // Revoke the old state
2389 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
2392 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2394 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2395 assert_eq!(node_txn.len(), 1); // ChannelMonitor: penalty tx
2396 assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2398 check_spends!(node_txn[0], revoked_local_txn[0]);
2399 node_txn.swap_remove(0);
2401 check_added_monitors!(nodes[1], 1);
2402 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
2403 test_txn_broadcast(&nodes[1], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::NONE);
2405 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2406 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
2407 // Verify broadcast of revoked HTLC-timeout
2408 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2409 check_added_monitors!(nodes[0], 1);
2410 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
2411 // Broadcast revoked HTLC-timeout on node 1
2412 mine_transaction(&nodes[1], &node_txn[1]);
2413 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2415 get_announce_close_broadcast_events(&nodes, 0, 1);
2417 assert_eq!(nodes[0].node.list_channels().len(), 0);
2418 assert_eq!(nodes[1].node.list_channels().len(), 0);
2420 // We test justice_tx build by A on B's revoked HTLC-Success tx
2421 // Create some new channels:
2422 let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1);
2424 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2428 // A pending HTLC which will be revoked:
2429 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2430 // Get the will-be-revoked local txn from B
2431 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2432 assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2433 assert_eq!(revoked_local_txn[0].input.len(), 1);
2434 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2435 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2436 // Revoke the old state
2437 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4);
2439 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2441 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2442 assert_eq!(node_txn.len(), 1); // ChannelMonitor: penalty tx
2443 assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2445 check_spends!(node_txn[0], revoked_local_txn[0]);
2446 node_txn.swap_remove(0);
2448 check_added_monitors!(nodes[0], 1);
2449 test_txn_broadcast(&nodes[0], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::NONE);
2451 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2452 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
2453 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2454 check_added_monitors!(nodes[1], 1);
2455 mine_transaction(&nodes[0], &node_txn[1]);
2456 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
2457 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2459 get_announce_close_broadcast_events(&nodes, 0, 1);
2460 assert_eq!(nodes[0].node.list_channels().len(), 0);
2461 assert_eq!(nodes[1].node.list_channels().len(), 0);
2465 fn revoked_output_claim() {
2466 // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2467 // transaction is broadcast by its counterparty
2468 let chanmon_cfgs = create_chanmon_cfgs(2);
2469 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2470 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2471 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2472 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
2473 // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2474 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2475 assert_eq!(revoked_local_txn.len(), 1);
2476 // Only output is the full channel value back to nodes[0]:
2477 assert_eq!(revoked_local_txn[0].output.len(), 1);
2478 // Send a payment through, updating everyone's latest commitment txn
2479 send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000);
2481 // Inform nodes[1] that nodes[0] broadcast a stale tx
2482 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2483 check_added_monitors!(nodes[1], 1);
2484 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
2485 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
2486 assert_eq!(node_txn.len(), 1); // ChannelMonitor: justice tx against revoked to_local output
2488 check_spends!(node_txn[0], revoked_local_txn[0]);
2490 // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2491 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2492 get_announce_close_broadcast_events(&nodes, 0, 1);
2493 check_added_monitors!(nodes[0], 1);
2494 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
2498 fn claim_htlc_outputs_shared_tx() {
2499 // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2500 let mut chanmon_cfgs = create_chanmon_cfgs(2);
2501 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2502 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2503 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2504 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2506 // Create some new channel:
2507 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
2509 // Rebalance the network to generate htlc in the two directions
2510 send_payment(&nodes[0], &[&nodes[1]], 8_000_000);
2511 // node[0] is gonna to revoke an old state thus node[1] should be able to claim both offered/received HTLC outputs on top of commitment tx
2512 let payment_preimage_1 = route_payment(&nodes[0], &[&nodes[1]], 3_000_000).0;
2513 let (_payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[1], &[&nodes[0]], 3_000_000);
2515 // Get the will-be-revoked local txn from node[0]
2516 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2517 assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2518 assert_eq!(revoked_local_txn[0].input.len(), 1);
2519 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2520 assert_eq!(revoked_local_txn[1].input.len(), 1);
2521 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2522 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2523 check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2525 //Revoke the old state
2526 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2529 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2530 check_added_monitors!(nodes[0], 1);
2531 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
2532 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2533 check_added_monitors!(nodes[1], 1);
2534 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
2535 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2536 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2538 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2539 assert_eq!(node_txn.len(), 1); // ChannelMonitor: penalty tx
2541 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2542 check_spends!(node_txn[0], revoked_local_txn[0]);
2544 let mut witness_lens = BTreeSet::new();
2545 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2546 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2547 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2548 assert_eq!(witness_lens.len(), 3);
2549 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2550 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2551 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2553 // Finally, mine the penalty transaction and check that we get an HTLC failure after
2554 // ANTI_REORG_DELAY confirmations.
2555 mine_transaction(&nodes[1], &node_txn[0]);
2556 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2557 expect_payment_failed!(nodes[1], payment_hash_2, false);
2559 get_announce_close_broadcast_events(&nodes, 0, 1);
2560 assert_eq!(nodes[0].node.list_channels().len(), 0);
2561 assert_eq!(nodes[1].node.list_channels().len(), 0);
2565 fn claim_htlc_outputs_single_tx() {
2566 // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2567 let mut chanmon_cfgs = create_chanmon_cfgs(2);
2568 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2569 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2570 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2571 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2573 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
2575 // Rebalance the network to generate htlc in the two directions
2576 send_payment(&nodes[0], &[&nodes[1]], 8_000_000);
2577 // node[0] is gonna to revoke an old state thus node[1] should be able to claim both offered/received HTLC outputs on top of commitment tx, but this
2578 // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2579 let payment_preimage_1 = route_payment(&nodes[0], &[&nodes[1]], 3_000_000).0;
2580 let (_payment_preimage_2, payment_hash_2, _payment_secret_2) = route_payment(&nodes[1], &[&nodes[0]], 3_000_000);
2582 // Get the will-be-revoked local txn from node[0]
2583 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2585 //Revoke the old state
2586 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2589 confirm_transaction_at(&nodes[0], &revoked_local_txn[0], 100);
2590 check_added_monitors!(nodes[0], 1);
2591 confirm_transaction_at(&nodes[1], &revoked_local_txn[0], 100);
2592 check_added_monitors!(nodes[1], 1);
2593 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
2594 let mut events = nodes[0].node.get_and_clear_pending_events();
2595 expect_pending_htlcs_forwardable_from_events!(nodes[0], events[0..1], true);
2596 match events.last().unwrap() {
2597 Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => {}
2598 _ => panic!("Unexpected event"),
2601 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2602 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2604 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2605 assert_eq!(node_txn.len(), 7);
2607 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2608 assert_eq!(node_txn[0].input.len(), 1);
2609 check_spends!(node_txn[0], chan_1.3);
2610 assert_eq!(node_txn[1].input.len(), 1);
2611 let witness_script = node_txn[1].input[0].witness.last().unwrap();
2612 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2613 check_spends!(node_txn[1], node_txn[0]);
2615 // Justice transactions are indices 2-3-4
2616 assert_eq!(node_txn[2].input.len(), 1);
2617 assert_eq!(node_txn[3].input.len(), 1);
2618 assert_eq!(node_txn[4].input.len(), 1);
2620 check_spends!(node_txn[2], revoked_local_txn[0]);
2621 check_spends!(node_txn[3], revoked_local_txn[0]);
2622 check_spends!(node_txn[4], revoked_local_txn[0]);
2624 let mut witness_lens = BTreeSet::new();
2625 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2626 witness_lens.insert(node_txn[3].input[0].witness.last().unwrap().len());
2627 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2628 assert_eq!(witness_lens.len(), 3);
2629 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2630 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2631 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2633 // Finally, mine the penalty transactions and check that we get an HTLC failure after
2634 // ANTI_REORG_DELAY confirmations.
2635 mine_transaction(&nodes[1], &node_txn[2]);
2636 mine_transaction(&nodes[1], &node_txn[3]);
2637 mine_transaction(&nodes[1], &node_txn[4]);
2638 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2639 expect_payment_failed!(nodes[1], payment_hash_2, false);
2641 get_announce_close_broadcast_events(&nodes, 0, 1);
2642 assert_eq!(nodes[0].node.list_channels().len(), 0);
2643 assert_eq!(nodes[1].node.list_channels().len(), 0);
2647 fn test_htlc_on_chain_success() {
2648 // Test that in case of a unilateral close onchain, we detect the state of output and pass
2649 // the preimage backward accordingly. So here we test that ChannelManager is
2650 // broadcasting the right event to other nodes in payment path.
2651 // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2652 // A --------------------> B ----------------------> C (preimage)
2653 // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2654 // commitment transaction was broadcast.
2655 // Then, B should learn the preimage from said transactions, attempting to claim backwards
2657 // B should be able to claim via preimage if A then broadcasts its local tx.
2658 // Finally, when A sees B's latest local commitment transaction it should be able to claim
2659 // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2660 // PaymentSent event).
2662 let chanmon_cfgs = create_chanmon_cfgs(3);
2663 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2664 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2665 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2667 // Create some initial channels
2668 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
2669 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
2671 // Ensure all nodes are at the same height
2672 let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
2673 connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
2674 connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
2675 connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
2677 // Rebalance the network a bit by relaying one payment through all the channels...
2678 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2679 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2681 let (our_payment_preimage, payment_hash_1, _payment_secret) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3_000_000);
2682 let (our_payment_preimage_2, payment_hash_2, _payment_secret_2) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3_000_000);
2684 // Broadcast legit commitment tx from C on B's chain
2685 // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2686 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2687 assert_eq!(commitment_tx.len(), 1);
2688 check_spends!(commitment_tx[0], chan_2.3);
2689 nodes[2].node.claim_funds(our_payment_preimage);
2690 expect_payment_claimed!(nodes[2], payment_hash_1, 3_000_000);
2691 nodes[2].node.claim_funds(our_payment_preimage_2);
2692 expect_payment_claimed!(nodes[2], payment_hash_2, 3_000_000);
2693 check_added_monitors!(nodes[2], 2);
2694 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2695 assert!(updates.update_add_htlcs.is_empty());
2696 assert!(updates.update_fail_htlcs.is_empty());
2697 assert!(updates.update_fail_malformed_htlcs.is_empty());
2698 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2700 mine_transaction(&nodes[2], &commitment_tx[0]);
2701 check_closed_broadcast!(nodes[2], true);
2702 check_added_monitors!(nodes[2], 1);
2703 check_closed_event!(nodes[2], 1, ClosureReason::CommitmentTxConfirmed);
2704 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelMonitor: 2 (2 * HTLC-Success tx)
2705 assert_eq!(node_txn.len(), 2);
2706 check_spends!(node_txn[0], commitment_tx[0]);
2707 check_spends!(node_txn[1], commitment_tx[0]);
2708 assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2709 assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2710 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2711 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2712 assert_eq!(node_txn[0].lock_time.0, 0);
2713 assert_eq!(node_txn[1].lock_time.0, 0);
2715 // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2716 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42};
2717 connect_block(&nodes[1], &Block { header, txdata: vec![commitment_tx[0].clone(), node_txn[0].clone(), node_txn[1].clone()]});
2718 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
2720 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2721 assert_eq!(added_monitors.len(), 1);
2722 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2723 added_monitors.clear();
2725 let forwarded_events = nodes[1].node.get_and_clear_pending_events();
2726 assert_eq!(forwarded_events.len(), 3);
2727 match forwarded_events[0] {
2728 Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => {}
2729 _ => panic!("Unexpected event"),
2731 let chan_id = Some(chan_1.2);
2732 match forwarded_events[1] {
2733 Event::PaymentForwarded { fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id } => {
2734 assert_eq!(fee_earned_msat, Some(1000));
2735 assert_eq!(prev_channel_id, chan_id);
2736 assert_eq!(claim_from_onchain_tx, true);
2737 assert_eq!(next_channel_id, Some(chan_2.2));
2741 match forwarded_events[2] {
2742 Event::PaymentForwarded { fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id } => {
2743 assert_eq!(fee_earned_msat, Some(1000));
2744 assert_eq!(prev_channel_id, chan_id);
2745 assert_eq!(claim_from_onchain_tx, true);
2746 assert_eq!(next_channel_id, Some(chan_2.2));
2750 let events = nodes[1].node.get_and_clear_pending_msg_events();
2752 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2753 assert_eq!(added_monitors.len(), 2);
2754 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2755 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2756 added_monitors.clear();
2758 assert_eq!(events.len(), 3);
2760 let (nodes_2_event, events) = remove_first_msg_event_to_node(&nodes[2].node.get_our_node_id(), &events);
2761 let (nodes_0_event, events) = remove_first_msg_event_to_node(&nodes[0].node.get_our_node_id(), &events);
2763 match nodes_2_event {
2764 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
2765 _ => panic!("Unexpected event"),
2768 match nodes_0_event {
2769 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, ref update_fulfill_htlcs, ref update_fail_malformed_htlcs, .. } } => {
2770 assert!(update_add_htlcs.is_empty());
2771 assert!(update_fail_htlcs.is_empty());
2772 assert_eq!(update_fulfill_htlcs.len(), 1);
2773 assert!(update_fail_malformed_htlcs.is_empty());
2774 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2776 _ => panic!("Unexpected event"),
2779 // Ensure that the last remaining message event is the BroadcastChannelUpdate msg for chan_2
2781 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2782 _ => panic!("Unexpected event"),
2785 macro_rules! check_tx_local_broadcast {
2786 ($node: expr, $htlc_offered: expr, $commitment_tx: expr) => { {
2787 let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2788 assert_eq!(node_txn.len(), 2);
2789 // Node[1]: 2 * HTLC-timeout tx
2790 // Node[0]: 2 * HTLC-timeout tx
2791 check_spends!(node_txn[0], $commitment_tx);
2792 check_spends!(node_txn[1], $commitment_tx);
2793 assert_ne!(node_txn[0].lock_time.0, 0);
2794 assert_ne!(node_txn[1].lock_time.0, 0);
2796 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2797 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2798 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2799 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2801 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2802 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2803 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2804 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2809 // nodes[1] now broadcasts its own timeout-claim of the output that nodes[2] just claimed via success.
2810 check_tx_local_broadcast!(nodes[1], false, commitment_tx[0]);
2812 // Broadcast legit commitment tx from A on B's chain
2813 // Broadcast preimage tx by B on offered output from A commitment tx on A's chain
2814 let node_a_commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2815 check_spends!(node_a_commitment_tx[0], chan_1.3);
2816 mine_transaction(&nodes[1], &node_a_commitment_tx[0]);
2817 check_closed_broadcast!(nodes[1], true);
2818 check_added_monitors!(nodes[1], 1);
2819 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
2820 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
2821 assert!(node_txn.len() == 1 || node_txn.len() == 3); // HTLC-Success, 2* RBF bumps of above HTLC txn
2822 let commitment_spend =
2823 if node_txn.len() == 1 {
2826 // Certain `ConnectStyle`s will cause RBF bumps of the previous HTLC transaction to be broadcast.
2827 // FullBlockViaListen
2828 if node_txn[0].input[0].previous_output.txid == node_a_commitment_tx[0].txid() {
2829 check_spends!(node_txn[1], commitment_tx[0]);
2830 check_spends!(node_txn[2], commitment_tx[0]);
2831 assert_ne!(node_txn[1].input[0].previous_output.vout, node_txn[2].input[0].previous_output.vout);
2834 check_spends!(node_txn[0], commitment_tx[0]);
2835 check_spends!(node_txn[1], commitment_tx[0]);
2836 assert_ne!(node_txn[0].input[0].previous_output.vout, node_txn[1].input[0].previous_output.vout);
2841 check_spends!(commitment_spend, node_a_commitment_tx[0]);
2842 assert_eq!(commitment_spend.input.len(), 2);
2843 assert_eq!(commitment_spend.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2844 assert_eq!(commitment_spend.input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2845 assert_eq!(commitment_spend.lock_time.0, 0);
2846 assert!(commitment_spend.output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2847 // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2848 // we already checked the same situation with A.
2850 // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2851 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42};
2852 connect_block(&nodes[0], &Block { header, txdata: vec![node_a_commitment_tx[0].clone(), commitment_spend.clone()] });
2853 connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
2854 check_closed_broadcast!(nodes[0], true);
2855 check_added_monitors!(nodes[0], 1);
2856 let events = nodes[0].node.get_and_clear_pending_events();
2857 assert_eq!(events.len(), 5);
2858 let mut first_claimed = false;
2859 for event in events {
2861 Event::PaymentSent { payment_preimage, payment_hash, .. } => {
2862 if payment_preimage == our_payment_preimage && payment_hash == payment_hash_1 {
2863 assert!(!first_claimed);
2864 first_claimed = true;
2866 assert_eq!(payment_preimage, our_payment_preimage_2);
2867 assert_eq!(payment_hash, payment_hash_2);
2870 Event::PaymentPathSuccessful { .. } => {},
2871 Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => {},
2872 _ => panic!("Unexpected event"),
2875 check_tx_local_broadcast!(nodes[0], true, node_a_commitment_tx[0]);
2878 fn do_test_htlc_on_chain_timeout(connect_style: ConnectStyle) {
2879 // Test that in case of a unilateral close onchain, we detect the state of output and
2880 // timeout the HTLC backward accordingly. So here we test that ChannelManager is
2881 // broadcasting the right event to other nodes in payment path.
2882 // A ------------------> B ----------------------> C (timeout)
2883 // B's commitment tx C's commitment tx
2885 // B's HTLC timeout tx B's timeout tx
2887 let chanmon_cfgs = create_chanmon_cfgs(3);
2888 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2889 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2890 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2891 *nodes[0].connect_style.borrow_mut() = connect_style;
2892 *nodes[1].connect_style.borrow_mut() = connect_style;
2893 *nodes[2].connect_style.borrow_mut() = connect_style;
2895 // Create some intial channels
2896 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
2897 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
2899 // Rebalance the network a bit by relaying one payment thorugh all the channels...
2900 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2901 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2903 let (_payment_preimage, payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2905 // Broadcast legit commitment tx from C on B's chain
2906 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2907 check_spends!(commitment_tx[0], chan_2.3);
2908 nodes[2].node.fail_htlc_backwards(&payment_hash);
2909 check_added_monitors!(nodes[2], 0);
2910 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash.clone() }]);
2911 check_added_monitors!(nodes[2], 1);
2913 let events = nodes[2].node.get_and_clear_pending_msg_events();
2914 assert_eq!(events.len(), 1);
2916 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, .. } } => {
2917 assert!(update_add_htlcs.is_empty());
2918 assert!(!update_fail_htlcs.is_empty());
2919 assert!(update_fulfill_htlcs.is_empty());
2920 assert!(update_fail_malformed_htlcs.is_empty());
2921 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2923 _ => panic!("Unexpected event"),
2925 mine_transaction(&nodes[2], &commitment_tx[0]);
2926 check_closed_broadcast!(nodes[2], true);
2927 check_added_monitors!(nodes[2], 1);
2928 check_closed_event!(nodes[2], 1, ClosureReason::CommitmentTxConfirmed);
2929 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
2930 assert_eq!(node_txn.len(), 0);
2932 // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2933 // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2934 connect_blocks(&nodes[1], 200 - nodes[2].best_block_info().1);
2935 mine_transaction(&nodes[1], &commitment_tx[0]);
2936 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
2939 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2940 assert_eq!(node_txn.len(), 3); // 2 (local commitment tx + HTLC-timeout), 1 timeout tx
2942 check_spends!(node_txn[2], commitment_tx[0]);
2943 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2945 check_spends!(node_txn[0], chan_2.3);
2946 check_spends!(node_txn[1], node_txn[0]);
2947 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
2948 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2950 timeout_tx = node_txn[2].clone();
2954 mine_transaction(&nodes[1], &timeout_tx);
2955 check_added_monitors!(nodes[1], 1);
2956 check_closed_broadcast!(nodes[1], true);
2958 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2960 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::NextHopChannel { node_id: Some(nodes[2].node.get_our_node_id()), channel_id: chan_2.2 }]);
2961 check_added_monitors!(nodes[1], 1);
2962 let events = nodes[1].node.get_and_clear_pending_msg_events();
2963 assert_eq!(events.len(), 1);
2965 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, ref update_fulfill_htlcs, ref update_fail_malformed_htlcs, .. } } => {
2966 assert!(update_add_htlcs.is_empty());
2967 assert!(!update_fail_htlcs.is_empty());
2968 assert!(update_fulfill_htlcs.is_empty());
2969 assert!(update_fail_malformed_htlcs.is_empty());
2970 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2972 _ => panic!("Unexpected event"),
2975 // Broadcast legit commitment tx from B on A's chain
2976 let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
2977 check_spends!(commitment_tx[0], chan_1.3);
2979 mine_transaction(&nodes[0], &commitment_tx[0]);
2980 connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
2982 check_closed_broadcast!(nodes[0], true);
2983 check_added_monitors!(nodes[0], 1);
2984 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
2985 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // 1 timeout tx
2986 assert_eq!(node_txn.len(), 1);
2987 check_spends!(node_txn[0], commitment_tx[0]);
2988 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2992 fn test_htlc_on_chain_timeout() {
2993 do_test_htlc_on_chain_timeout(ConnectStyle::BestBlockFirstSkippingBlocks);
2994 do_test_htlc_on_chain_timeout(ConnectStyle::TransactionsFirstSkippingBlocks);
2995 do_test_htlc_on_chain_timeout(ConnectStyle::FullBlockViaListen);
2999 fn test_simple_commitment_revoked_fail_backward() {
3000 // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
3001 // and fail backward accordingly.
3003 let chanmon_cfgs = create_chanmon_cfgs(3);
3004 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3005 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3006 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3008 // Create some initial channels
3009 create_announced_chan_between_nodes(&nodes, 0, 1);
3010 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
3012 let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3013 // Get the will-be-revoked local txn from nodes[2]
3014 let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3015 // Revoke the old state
3016 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
3018 let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3020 mine_transaction(&nodes[1], &revoked_local_txn[0]);
3021 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
3022 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3023 check_added_monitors!(nodes[1], 1);
3024 check_closed_broadcast!(nodes[1], true);
3026 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::NextHopChannel { node_id: Some(nodes[2].node.get_our_node_id()), channel_id: chan_2.2 }]);
3027 check_added_monitors!(nodes[1], 1);
3028 let events = nodes[1].node.get_and_clear_pending_msg_events();
3029 assert_eq!(events.len(), 1);
3031 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, ref update_fulfill_htlcs, ref update_fail_malformed_htlcs, ref commitment_signed, .. } } => {
3032 assert!(update_add_htlcs.is_empty());
3033 assert_eq!(update_fail_htlcs.len(), 1);
3034 assert!(update_fulfill_htlcs.is_empty());
3035 assert!(update_fail_malformed_htlcs.is_empty());
3036 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3038 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3039 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3040 expect_payment_failed_with_update!(nodes[0], payment_hash, false, chan_2.0.contents.short_channel_id, true);
3042 _ => panic!("Unexpected event"),
3046 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
3047 // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
3048 // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
3049 // commitment transaction anymore.
3050 // To do this, we have the peer which will broadcast a revoked commitment transaction send
3051 // a number of update_fail/commitment_signed updates without ever sending the RAA in
3052 // response to our commitment_signed. This is somewhat misbehavior-y, though not
3053 // technically disallowed and we should probably handle it reasonably.
3054 // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
3055 // failed/fulfilled backwards must be in at least one of the latest two remote commitment
3057 // * Once we move it out of our holding cell/add it, we will immediately include it in a
3058 // commitment_signed (implying it will be in the latest remote commitment transaction).
3059 // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
3060 // and once they revoke the previous commitment transaction (allowing us to send a new
3061 // commitment_signed) we will be free to fail/fulfill the HTLC backwards.
3062 let chanmon_cfgs = create_chanmon_cfgs(3);
3063 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3064 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3065 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3067 // Create some initial channels
3068 create_announced_chan_between_nodes(&nodes, 0, 1);
3069 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
3071 let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], if no_to_remote { 10_000 } else { 3_000_000 });
3072 // Get the will-be-revoked local txn from nodes[2]
3073 let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3074 assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
3075 // Revoke the old state
3076 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
3078 let value = if use_dust {
3079 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
3080 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
3081 nodes[2].node.per_peer_state.read().unwrap().get(&nodes[1].node.get_our_node_id())
3082 .unwrap().lock().unwrap().channel_by_id.get(&chan_2.2).unwrap().holder_dust_limit_satoshis * 1000
3085 let (_, first_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3086 let (_, second_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3087 let (_, third_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3089 nodes[2].node.fail_htlc_backwards(&first_payment_hash);
3090 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::FailedPayment { payment_hash: first_payment_hash }]);
3091 check_added_monitors!(nodes[2], 1);
3092 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3093 assert!(updates.update_add_htlcs.is_empty());
3094 assert!(updates.update_fulfill_htlcs.is_empty());
3095 assert!(updates.update_fail_malformed_htlcs.is_empty());
3096 assert_eq!(updates.update_fail_htlcs.len(), 1);
3097 assert!(updates.update_fee.is_none());
3098 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3099 let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
3100 // Drop the last RAA from 3 -> 2
3102 nodes[2].node.fail_htlc_backwards(&second_payment_hash);
3103 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::FailedPayment { payment_hash: second_payment_hash }]);
3104 check_added_monitors!(nodes[2], 1);
3105 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3106 assert!(updates.update_add_htlcs.is_empty());
3107 assert!(updates.update_fulfill_htlcs.is_empty());
3108 assert!(updates.update_fail_malformed_htlcs.is_empty());
3109 assert_eq!(updates.update_fail_htlcs.len(), 1);
3110 assert!(updates.update_fee.is_none());
3111 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3112 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3113 check_added_monitors!(nodes[1], 1);
3114 // Note that nodes[1] is in AwaitingRAA, so won't send a CS
3115 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3116 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3117 check_added_monitors!(nodes[2], 1);
3119 nodes[2].node.fail_htlc_backwards(&third_payment_hash);
3120 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::FailedPayment { payment_hash: third_payment_hash }]);
3121 check_added_monitors!(nodes[2], 1);
3122 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3123 assert!(updates.update_add_htlcs.is_empty());
3124 assert!(updates.update_fulfill_htlcs.is_empty());
3125 assert!(updates.update_fail_malformed_htlcs.is_empty());
3126 assert_eq!(updates.update_fail_htlcs.len(), 1);
3127 assert!(updates.update_fee.is_none());
3128 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3129 // At this point first_payment_hash has dropped out of the latest two commitment
3130 // transactions that nodes[1] is tracking...
3131 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3132 check_added_monitors!(nodes[1], 1);
3133 // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
3134 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3135 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3136 check_added_monitors!(nodes[2], 1);
3138 // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
3139 // on nodes[2]'s RAA.
3140 let (route, fourth_payment_hash, _, fourth_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[2], 1000000);
3141 nodes[1].node.send_payment(&route, fourth_payment_hash, &Some(fourth_payment_secret), PaymentId(fourth_payment_hash.0)).unwrap();
3142 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3143 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3144 check_added_monitors!(nodes[1], 0);
3147 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
3148 // One monitor for the new revocation preimage, no second on as we won't generate a new
3149 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
3150 check_added_monitors!(nodes[1], 1);
3151 let events = nodes[1].node.get_and_clear_pending_events();
3152 assert_eq!(events.len(), 2);
3154 Event::PendingHTLCsForwardable { .. } => { },
3155 _ => panic!("Unexpected event"),
3158 Event::HTLCHandlingFailed { .. } => { },
3159 _ => panic!("Unexpected event"),
3161 // Deliberately don't process the pending fail-back so they all fail back at once after
3162 // block connection just like the !deliver_bs_raa case
3165 let mut failed_htlcs = HashSet::new();
3166 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3168 mine_transaction(&nodes[1], &revoked_local_txn[0]);
3169 check_added_monitors!(nodes[1], 1);
3170 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3172 let events = nodes[1].node.get_and_clear_pending_events();
3173 assert_eq!(events.len(), if deliver_bs_raa { 2 + nodes.len() - 1 } else { 3 + nodes.len() });
3175 Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => { },
3176 _ => panic!("Unexepected event"),
3179 Event::PaymentPathFailed { ref payment_hash, .. } => {
3180 assert_eq!(*payment_hash, fourth_payment_hash);
3182 _ => panic!("Unexpected event"),
3184 if !deliver_bs_raa {
3186 Event::PendingHTLCsForwardable { .. } => { },
3187 _ => panic!("Unexpected event"),
3189 nodes[1].node.abandon_payment(PaymentId(fourth_payment_hash.0));
3190 let payment_failed_events = nodes[1].node.get_and_clear_pending_events();
3191 assert_eq!(payment_failed_events.len(), 1);
3192 match payment_failed_events[0] {
3193 Event::PaymentFailed { ref payment_hash, .. } => {
3194 assert_eq!(*payment_hash, fourth_payment_hash);
3196 _ => panic!("Unexpected event"),
3199 nodes[1].node.process_pending_htlc_forwards();
3200 check_added_monitors!(nodes[1], 1);
3202 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
3203 assert_eq!(events.len(), if deliver_bs_raa { 4 } else { 3 });
3205 let events = if deliver_bs_raa {
3206 let (nodes_2_event, events) = remove_first_msg_event_to_node(&nodes[2].node.get_our_node_id(), &events);
3207 match nodes_2_event {
3208 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, ref update_fulfill_htlcs, ref update_fail_malformed_htlcs, .. } } => {
3209 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
3210 assert_eq!(update_add_htlcs.len(), 1);
3211 assert!(update_fulfill_htlcs.is_empty());
3212 assert!(update_fail_htlcs.is_empty());
3213 assert!(update_fail_malformed_htlcs.is_empty());
3215 _ => panic!("Unexpected event"),
3220 let (nodes_2_event, events) = remove_first_msg_event_to_node(&nodes[2].node.get_our_node_id(), &events);
3221 match nodes_2_event {
3222 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage { channel_id, ref data } }, node_id: _ } => {
3223 assert_eq!(channel_id, chan_2.2);
3224 assert_eq!(data.as_str(), "Channel closed because commitment or closing transaction was confirmed on chain.");
3226 _ => panic!("Unexpected event"),
3229 let (nodes_0_event, events) = remove_first_msg_event_to_node(&nodes[0].node.get_our_node_id(), &events);
3230 match nodes_0_event {
3231 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, ref update_fulfill_htlcs, ref update_fail_malformed_htlcs, ref commitment_signed, .. } } => {
3232 assert!(update_add_htlcs.is_empty());
3233 assert_eq!(update_fail_htlcs.len(), 3);
3234 assert!(update_fulfill_htlcs.is_empty());
3235 assert!(update_fail_malformed_htlcs.is_empty());
3236 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3238 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3239 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
3240 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
3242 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3244 let events = nodes[0].node.get_and_clear_pending_events();
3245 assert_eq!(events.len(), 3);
3247 Event::PaymentPathFailed { ref payment_hash, ref network_update, .. } => {
3248 assert!(failed_htlcs.insert(payment_hash.0));
3249 // If we delivered B's RAA we got an unknown preimage error, not something
3250 // that we should update our routing table for.
3251 if !deliver_bs_raa {
3252 assert!(network_update.is_some());
3255 _ => panic!("Unexpected event"),
3258 Event::PaymentPathFailed { ref payment_hash, ref network_update, .. } => {
3259 assert!(failed_htlcs.insert(payment_hash.0));
3260 assert!(network_update.is_some());
3262 _ => panic!("Unexpected event"),
3265 Event::PaymentPathFailed { ref payment_hash, ref network_update, .. } => {
3266 assert!(failed_htlcs.insert(payment_hash.0));
3267 assert!(network_update.is_some());
3269 _ => panic!("Unexpected event"),
3272 _ => panic!("Unexpected event"),
3275 // Ensure that the last remaining message event is the BroadcastChannelUpdate msg for chan_2
3277 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
3278 _ => panic!("Unexpected event"),
3281 assert!(failed_htlcs.contains(&first_payment_hash.0));
3282 assert!(failed_htlcs.contains(&second_payment_hash.0));
3283 assert!(failed_htlcs.contains(&third_payment_hash.0));
3287 fn test_commitment_revoked_fail_backward_exhaustive_a() {
3288 do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
3289 do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
3290 do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
3291 do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
3295 fn test_commitment_revoked_fail_backward_exhaustive_b() {
3296 do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
3297 do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
3298 do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
3299 do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
3303 fn fail_backward_pending_htlc_upon_channel_failure() {
3304 let chanmon_cfgs = create_chanmon_cfgs(2);
3305 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3306 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3307 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3308 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000);
3310 // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
3312 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 50_000);
3313 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
3314 check_added_monitors!(nodes[0], 1);
3316 let payment_event = {
3317 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3318 assert_eq!(events.len(), 1);
3319 SendEvent::from_event(events.remove(0))
3321 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3322 assert_eq!(payment_event.msgs.len(), 1);
3325 // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3326 let (route, failed_payment_hash, _, failed_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 50_000);
3328 nodes[0].node.send_payment(&route, failed_payment_hash, &Some(failed_payment_secret), PaymentId(failed_payment_hash.0)).unwrap();
3329 check_added_monitors!(nodes[0], 0);
3331 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3334 // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3336 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 50_000);
3338 let secp_ctx = Secp256k1::new();
3339 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
3340 let current_height = nodes[1].node.best_block.read().unwrap().height() + 1;
3341 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &Some(payment_secret), current_height, &None).unwrap();
3342 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3343 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3345 // Send a 0-msat update_add_htlc to fail the channel.
3346 let update_add_htlc = msgs::UpdateAddHTLC {
3352 onion_routing_packet,
3354 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3356 let events = nodes[0].node.get_and_clear_pending_events();
3357 assert_eq!(events.len(), 2);
3358 // Check that Alice fails backward the pending HTLC from the second payment.
3360 Event::PaymentPathFailed { payment_hash, .. } => {
3361 assert_eq!(payment_hash, failed_payment_hash);
3363 _ => panic!("Unexpected event"),
3366 Event::ChannelClosed { reason: ClosureReason::ProcessingError { ref err }, .. } => {
3367 assert_eq!(err, "Remote side tried to send a 0-msat HTLC");
3369 _ => panic!("Unexpected event {:?}", events[1]),
3371 check_closed_broadcast!(nodes[0], true);
3372 check_added_monitors!(nodes[0], 1);
3376 fn test_htlc_ignore_latest_remote_commitment() {
3377 // Test that HTLC transactions spending the latest remote commitment transaction are simply
3378 // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3379 let chanmon_cfgs = create_chanmon_cfgs(2);
3380 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3381 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3382 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3383 if *nodes[1].connect_style.borrow() == ConnectStyle::FullBlockViaListen {
3384 // We rely on the ability to connect a block redundantly, which isn't allowed via
3385 // `chain::Listen`, so we never run the test if we randomly get assigned that
3389 create_announced_chan_between_nodes(&nodes, 0, 1);
3391 route_payment(&nodes[0], &[&nodes[1]], 10000000);
3392 nodes[0].node.force_close_broadcasting_latest_txn(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id()).unwrap();
3393 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
3394 check_closed_broadcast!(nodes[0], true);
3395 check_added_monitors!(nodes[0], 1);
3396 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
3398 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3399 assert_eq!(node_txn.len(), 3);
3400 assert_eq!(node_txn[0], node_txn[1]);
3402 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
3403 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]});
3404 check_closed_broadcast!(nodes[1], true);
3405 check_added_monitors!(nodes[1], 1);
3406 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
3408 // Duplicate the connect_block call since this may happen due to other listeners
3409 // registering new transactions
3410 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[2].clone()]});
3414 fn test_force_close_fail_back() {
3415 // Check which HTLCs are failed-backwards on channel force-closure
3416 let chanmon_cfgs = create_chanmon_cfgs(3);
3417 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3418 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3419 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3420 create_announced_chan_between_nodes(&nodes, 0, 1);
3421 create_announced_chan_between_nodes(&nodes, 1, 2);
3423 let (route, our_payment_hash, our_payment_preimage, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 1000000);
3425 let mut payment_event = {
3426 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
3427 check_added_monitors!(nodes[0], 1);
3429 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3430 assert_eq!(events.len(), 1);
3431 SendEvent::from_event(events.remove(0))
3434 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3435 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3437 expect_pending_htlcs_forwardable!(nodes[1]);
3439 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3440 assert_eq!(events_2.len(), 1);
3441 payment_event = SendEvent::from_event(events_2.remove(0));
3442 assert_eq!(payment_event.msgs.len(), 1);
3444 check_added_monitors!(nodes[1], 1);
3445 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3446 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3447 check_added_monitors!(nodes[2], 1);
3448 let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3450 // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3451 // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3452 // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3454 nodes[2].node.force_close_broadcasting_latest_txn(&payment_event.commitment_msg.channel_id, &nodes[1].node.get_our_node_id()).unwrap();
3455 check_closed_broadcast!(nodes[2], true);
3456 check_added_monitors!(nodes[2], 1);
3457 check_closed_event!(nodes[2], 1, ClosureReason::HolderForceClosed);
3459 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3460 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3461 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3462 // back to nodes[1] upon timeout otherwise.
3463 assert_eq!(node_txn.len(), 1);
3467 mine_transaction(&nodes[1], &tx);
3469 // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3470 check_closed_broadcast!(nodes[1], true);
3471 check_added_monitors!(nodes[1], 1);
3472 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
3474 // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3476 get_monitor!(nodes[2], payment_event.commitment_msg.channel_id)
3477 .provide_payment_preimage(&our_payment_hash, &our_payment_preimage, &node_cfgs[2].tx_broadcaster, &LowerBoundedFeeEstimator::new(node_cfgs[2].fee_estimator), &node_cfgs[2].logger);
3479 mine_transaction(&nodes[2], &tx);
3480 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3481 assert_eq!(node_txn.len(), 1);
3482 assert_eq!(node_txn[0].input.len(), 1);
3483 assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3484 assert_eq!(node_txn[0].lock_time.0, 0); // Must be an HTLC-Success
3485 assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3487 check_spends!(node_txn[0], tx);
3491 fn test_dup_events_on_peer_disconnect() {
3492 // Test that if we receive a duplicative update_fulfill_htlc message after a reconnect we do
3493 // not generate a corresponding duplicative PaymentSent event. This did not use to be the case
3494 // as we used to generate the event immediately upon receipt of the payment preimage in the
3495 // update_fulfill_htlc message.
3497 let chanmon_cfgs = create_chanmon_cfgs(2);
3498 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3499 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3500 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3501 create_announced_chan_between_nodes(&nodes, 0, 1);
3503 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
3505 nodes[1].node.claim_funds(payment_preimage);
3506 expect_payment_claimed!(nodes[1], payment_hash, 1_000_000);
3507 check_added_monitors!(nodes[1], 1);
3508 let claim_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3509 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &claim_msgs.update_fulfill_htlcs[0]);
3510 expect_payment_sent_without_paths!(nodes[0], payment_preimage);
3512 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3513 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3515 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3516 expect_payment_path_successful!(nodes[0]);
3520 fn test_peer_disconnected_before_funding_broadcasted() {
3521 // Test that channels are closed with `ClosureReason::DisconnectedPeer` if the peer disconnects
3522 // before the funding transaction has been broadcasted.
3523 let chanmon_cfgs = create_chanmon_cfgs(2);
3524 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3525 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3526 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3528 // Open a channel between `nodes[0]` and `nodes[1]`, for which the funding transaction is never
3529 // broadcasted, even though it's created by `nodes[0]`.
3530 let expected_temporary_channel_id = nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
3531 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
3532 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
3533 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
3534 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
3536 let (temporary_channel_id, tx, _funding_output) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 1_000_000, 42);
3537 assert_eq!(temporary_channel_id, expected_temporary_channel_id);
3539 assert!(nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).is_ok());
3541 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
3542 assert_eq!(funding_created_msg.temporary_channel_id, expected_temporary_channel_id);
3544 // Even though the funding transaction is created by `nodes[0]`, the `FundingCreated` msg is
3545 // never sent to `nodes[1]`, and therefore the tx is never signed by either party nor
3548 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 0);
3551 // Ensure that the channel is closed with `ClosureReason::DisconnectedPeer` when the peers are
3552 // disconnected before the funding transaction was broadcasted.
3553 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3554 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3556 check_closed_event!(nodes[0], 1, ClosureReason::DisconnectedPeer);
3557 check_closed_event!(nodes[1], 1, ClosureReason::DisconnectedPeer);
3561 fn test_simple_peer_disconnect() {
3562 // Test that we can reconnect when there are no lost messages
3563 let chanmon_cfgs = create_chanmon_cfgs(3);
3564 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3565 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3566 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3567 create_announced_chan_between_nodes(&nodes, 0, 1);
3568 create_announced_chan_between_nodes(&nodes, 1, 2);
3570 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3571 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3572 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3574 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3575 let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3576 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3577 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1);
3579 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3580 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3581 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3583 let (payment_preimage_3, payment_hash_3, _) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000);
3584 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3585 let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3586 let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3588 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3589 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3591 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], true, payment_preimage_3);
3592 fail_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], true, payment_hash_5);
3594 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3596 let events = nodes[0].node.get_and_clear_pending_events();
3597 assert_eq!(events.len(), 3);
3599 Event::PaymentSent { payment_preimage, payment_hash, .. } => {
3600 assert_eq!(payment_preimage, payment_preimage_3);
3601 assert_eq!(payment_hash, payment_hash_3);
3603 _ => panic!("Unexpected event"),
3606 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, .. } => {
3607 assert_eq!(payment_hash, payment_hash_5);
3608 assert!(payment_failed_permanently);
3610 _ => panic!("Unexpected event"),
3613 Event::PaymentPathSuccessful { .. } => {},
3614 _ => panic!("Unexpected event"),
3618 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4);
3619 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3622 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8, simulate_broken_lnd: bool) {
3623 // Test that we can reconnect when in-flight HTLC updates get dropped
3624 let chanmon_cfgs = create_chanmon_cfgs(2);
3625 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3626 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3627 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3629 let mut as_channel_ready = None;
3630 let channel_id = if messages_delivered == 0 {
3631 let (channel_ready, chan_id, _) = create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001);
3632 as_channel_ready = Some(channel_ready);
3633 // nodes[1] doesn't receive the channel_ready message (it'll be re-sent on reconnect)
3634 // Note that we store it so that if we're running with `simulate_broken_lnd` we can deliver
3635 // it before the channel_reestablish message.
3638 create_announced_chan_between_nodes(&nodes, 0, 1).2
3641 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1_000_000);
3643 let payment_event = {
3644 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1), PaymentId(payment_hash_1.0)).unwrap();
3645 check_added_monitors!(nodes[0], 1);
3647 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3648 assert_eq!(events.len(), 1);
3649 SendEvent::from_event(events.remove(0))
3651 assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3653 if messages_delivered < 2 {
3654 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3656 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3657 if messages_delivered >= 3 {
3658 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3659 check_added_monitors!(nodes[1], 1);
3660 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3662 if messages_delivered >= 4 {
3663 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3664 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3665 check_added_monitors!(nodes[0], 1);
3667 if messages_delivered >= 5 {
3668 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3669 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3670 // No commitment_signed so get_event_msg's assert(len == 1) passes
3671 check_added_monitors!(nodes[0], 1);
3673 if messages_delivered >= 6 {
3674 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3675 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3676 check_added_monitors!(nodes[1], 1);
3683 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3684 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3685 if messages_delivered < 3 {
3686 if simulate_broken_lnd {
3687 // lnd has a long-standing bug where they send a channel_ready prior to a
3688 // channel_reestablish if you reconnect prior to channel_ready time.
3690 // Here we simulate that behavior, delivering a channel_ready immediately on
3691 // reconnect. Note that we don't bother skipping the now-duplicate channel_ready sent
3692 // in `reconnect_nodes` but we currently don't fail based on that.
3694 // See-also <https://github.com/lightningnetwork/lnd/issues/4006>
3695 nodes[1].node.handle_channel_ready(&nodes[0].node.get_our_node_id(), &as_channel_ready.as_ref().unwrap().0);
3697 // Even if the channel_ready messages get exchanged, as long as nothing further was
3698 // received on either side, both sides will need to resend them.
3699 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3700 } else if messages_delivered == 3 {
3701 // nodes[0] still wants its RAA + commitment_signed
3702 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3703 } else if messages_delivered == 4 {
3704 // nodes[0] still wants its commitment_signed
3705 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3706 } else if messages_delivered == 5 {
3707 // nodes[1] still wants its final RAA
3708 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3709 } else if messages_delivered == 6 {
3710 // Everything was delivered...
3711 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3714 let events_1 = nodes[1].node.get_and_clear_pending_events();
3715 if messages_delivered == 0 {
3716 assert_eq!(events_1.len(), 2);
3718 Event::ChannelReady { .. } => { },
3719 _ => panic!("Unexpected event"),
3722 Event::PendingHTLCsForwardable { .. } => { },
3723 _ => panic!("Unexpected event"),
3726 assert_eq!(events_1.len(), 1);
3728 Event::PendingHTLCsForwardable { .. } => { },
3729 _ => panic!("Unexpected event"),
3733 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3734 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3735 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3737 nodes[1].node.process_pending_htlc_forwards();
3739 let events_2 = nodes[1].node.get_and_clear_pending_events();
3740 assert_eq!(events_2.len(), 1);
3742 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, via_user_channel_id: _ } => {
3743 assert_eq!(payment_hash_1, *payment_hash);
3744 assert_eq!(amount_msat, 1_000_000);
3745 assert_eq!(receiver_node_id.unwrap(), nodes[1].node.get_our_node_id());
3746 assert_eq!(via_channel_id, Some(channel_id));
3748 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
3749 assert!(payment_preimage.is_none());
3750 assert_eq!(payment_secret_1, *payment_secret);
3752 _ => panic!("expected PaymentPurpose::InvoicePayment")
3755 _ => panic!("Unexpected event"),
3758 nodes[1].node.claim_funds(payment_preimage_1);
3759 check_added_monitors!(nodes[1], 1);
3760 expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
3762 let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3763 assert_eq!(events_3.len(), 1);
3764 let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3765 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3766 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3767 assert!(updates.update_add_htlcs.is_empty());
3768 assert!(updates.update_fail_htlcs.is_empty());
3769 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3770 assert!(updates.update_fail_malformed_htlcs.is_empty());
3771 assert!(updates.update_fee.is_none());
3772 (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3774 _ => panic!("Unexpected event"),
3777 if messages_delivered >= 1 {
3778 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3780 let events_4 = nodes[0].node.get_and_clear_pending_events();
3781 assert_eq!(events_4.len(), 1);
3783 Event::PaymentSent { ref payment_preimage, ref payment_hash, .. } => {
3784 assert_eq!(payment_preimage_1, *payment_preimage);
3785 assert_eq!(payment_hash_1, *payment_hash);
3787 _ => panic!("Unexpected event"),
3790 if messages_delivered >= 2 {
3791 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3792 check_added_monitors!(nodes[0], 1);
3793 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3795 if messages_delivered >= 3 {
3796 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3797 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3798 check_added_monitors!(nodes[1], 1);
3800 if messages_delivered >= 4 {
3801 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3802 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3803 // No commitment_signed so get_event_msg's assert(len == 1) passes
3804 check_added_monitors!(nodes[1], 1);
3806 if messages_delivered >= 5 {
3807 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3808 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3809 check_added_monitors!(nodes[0], 1);
3816 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3817 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3818 if messages_delivered < 2 {
3819 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3820 if messages_delivered < 1 {
3821 expect_payment_sent!(nodes[0], payment_preimage_1);
3823 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3825 } else if messages_delivered == 2 {
3826 // nodes[0] still wants its RAA + commitment_signed
3827 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3828 } else if messages_delivered == 3 {
3829 // nodes[0] still wants its commitment_signed
3830 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3831 } else if messages_delivered == 4 {
3832 // nodes[1] still wants its final RAA
3833 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3834 } else if messages_delivered == 5 {
3835 // Everything was delivered...
3836 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3839 if messages_delivered == 1 || messages_delivered == 2 {
3840 expect_payment_path_successful!(nodes[0]);
3843 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3844 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3845 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3847 if messages_delivered > 2 {
3848 expect_payment_path_successful!(nodes[0]);
3851 // Channel should still work fine...
3852 let (route, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
3853 let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3854 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
3858 fn test_drop_messages_peer_disconnect_a() {
3859 do_test_drop_messages_peer_disconnect(0, true);
3860 do_test_drop_messages_peer_disconnect(0, false);
3861 do_test_drop_messages_peer_disconnect(1, false);
3862 do_test_drop_messages_peer_disconnect(2, false);
3866 fn test_drop_messages_peer_disconnect_b() {
3867 do_test_drop_messages_peer_disconnect(3, false);
3868 do_test_drop_messages_peer_disconnect(4, false);
3869 do_test_drop_messages_peer_disconnect(5, false);
3870 do_test_drop_messages_peer_disconnect(6, false);
3874 fn test_channel_ready_without_best_block_updated() {
3875 // Previously, if we were offline when a funding transaction was locked in, and then we came
3876 // back online, calling best_block_updated once followed by transactions_confirmed, we'd not
3877 // generate a channel_ready until a later best_block_updated. This tests that we generate the
3878 // channel_ready immediately instead.
3879 let chanmon_cfgs = create_chanmon_cfgs(2);
3880 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3881 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3882 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3883 *nodes[0].connect_style.borrow_mut() = ConnectStyle::BestBlockFirstSkippingBlocks;
3885 let funding_tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 1_000_000, 0);
3887 let conf_height = nodes[0].best_block_info().1 + 1;
3888 connect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH);
3889 let block_txn = [funding_tx];
3890 let conf_txn: Vec<_> = block_txn.iter().enumerate().collect();
3891 let conf_block_header = nodes[0].get_block_header(conf_height);
3892 nodes[0].node.transactions_confirmed(&conf_block_header, &conf_txn[..], conf_height);
3894 // Ensure nodes[0] generates a channel_ready after the transactions_confirmed
3895 let as_channel_ready = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReady, nodes[1].node.get_our_node_id());
3896 nodes[1].node.handle_channel_ready(&nodes[0].node.get_our_node_id(), &as_channel_ready);
3900 fn test_drop_messages_peer_disconnect_dual_htlc() {
3901 // Test that we can handle reconnecting when both sides of a channel have pending
3902 // commitment_updates when we disconnect.
3903 let chanmon_cfgs = create_chanmon_cfgs(2);
3904 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3905 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3906 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3907 create_announced_chan_between_nodes(&nodes, 0, 1);
3909 let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
3911 // Now try to send a second payment which will fail to send
3912 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
3913 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
3914 check_added_monitors!(nodes[0], 1);
3916 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3917 assert_eq!(events_1.len(), 1);
3919 MessageSendEvent::UpdateHTLCs { .. } => {},
3920 _ => panic!("Unexpected event"),
3923 nodes[1].node.claim_funds(payment_preimage_1);
3924 expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
3925 check_added_monitors!(nodes[1], 1);
3927 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3928 assert_eq!(events_2.len(), 1);
3930 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 } } => {
3931 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3932 assert!(update_add_htlcs.is_empty());
3933 assert_eq!(update_fulfill_htlcs.len(), 1);
3934 assert!(update_fail_htlcs.is_empty());
3935 assert!(update_fail_malformed_htlcs.is_empty());
3936 assert!(update_fee.is_none());
3938 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3939 let events_3 = nodes[0].node.get_and_clear_pending_events();
3940 assert_eq!(events_3.len(), 1);
3942 Event::PaymentSent { ref payment_preimage, ref payment_hash, .. } => {
3943 assert_eq!(*payment_preimage, payment_preimage_1);
3944 assert_eq!(*payment_hash, payment_hash_1);
3946 _ => panic!("Unexpected event"),
3949 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
3950 let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3951 // No commitment_signed so get_event_msg's assert(len == 1) passes
3952 check_added_monitors!(nodes[0], 1);
3954 _ => panic!("Unexpected event"),
3957 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3958 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3960 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: nodes[1].node.init_features(), remote_network_address: None }).unwrap();
3961 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3962 assert_eq!(reestablish_1.len(), 1);
3963 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: nodes[0].node.init_features(), remote_network_address: None }).unwrap();
3964 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3965 assert_eq!(reestablish_2.len(), 1);
3967 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3968 let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3969 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3970 let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3972 assert!(as_resp.0.is_none());
3973 assert!(bs_resp.0.is_none());
3975 assert!(bs_resp.1.is_none());
3976 assert!(bs_resp.2.is_none());
3978 assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3980 assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3981 assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3982 assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3983 assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3984 assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3985 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
3986 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
3987 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3988 // No commitment_signed so get_event_msg's assert(len == 1) passes
3989 check_added_monitors!(nodes[1], 1);
3991 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
3992 let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3993 assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
3994 assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
3995 assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
3996 assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
3997 assert!(bs_second_commitment_signed.update_fee.is_none());
3998 check_added_monitors!(nodes[1], 1);
4000 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
4001 let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4002 assert!(as_commitment_signed.update_add_htlcs.is_empty());
4003 assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
4004 assert!(as_commitment_signed.update_fail_htlcs.is_empty());
4005 assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
4006 assert!(as_commitment_signed.update_fee.is_none());
4007 check_added_monitors!(nodes[0], 1);
4009 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
4010 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4011 // No commitment_signed so get_event_msg's assert(len == 1) passes
4012 check_added_monitors!(nodes[0], 1);
4014 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
4015 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4016 // No commitment_signed so get_event_msg's assert(len == 1) passes
4017 check_added_monitors!(nodes[1], 1);
4019 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
4020 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4021 check_added_monitors!(nodes[1], 1);
4023 expect_pending_htlcs_forwardable!(nodes[1]);
4025 let events_5 = nodes[1].node.get_and_clear_pending_events();
4026 assert_eq!(events_5.len(), 1);
4028 Event::PaymentClaimable { ref payment_hash, ref purpose, .. } => {
4029 assert_eq!(payment_hash_2, *payment_hash);
4031 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
4032 assert!(payment_preimage.is_none());
4033 assert_eq!(payment_secret_2, *payment_secret);
4035 _ => panic!("expected PaymentPurpose::InvoicePayment")
4038 _ => panic!("Unexpected event"),
4041 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
4042 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4043 check_added_monitors!(nodes[0], 1);
4045 expect_payment_path_successful!(nodes[0]);
4046 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
4049 fn do_test_htlc_timeout(send_partial_mpp: bool) {
4050 // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
4051 // to avoid our counterparty failing the channel.
4052 let chanmon_cfgs = create_chanmon_cfgs(2);
4053 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4054 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4055 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4057 create_announced_chan_between_nodes(&nodes, 0, 1);
4059 let our_payment_hash = if send_partial_mpp {
4060 let (route, our_payment_hash, _, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[1], 100000);
4061 // Use the utility function send_payment_along_path to send the payment with MPP data which
4062 // indicates there are more HTLCs coming.
4063 let cur_height = CHAN_CONFIRM_DEPTH + 1; // route_payment calls send_payment, which adds 1 to the current height. So we do the same here to match.
4064 let payment_id = PaymentId([42; 32]);
4065 let session_privs = nodes[0].node.test_add_new_pending_payment(our_payment_hash, Some(payment_secret), payment_id, &route).unwrap();
4066 nodes[0].node.send_payment_along_path(&route.paths[0], &route.payment_params, &our_payment_hash, &Some(payment_secret), 200_000, cur_height, payment_id, &None, session_privs[0]).unwrap();
4067 check_added_monitors!(nodes[0], 1);
4068 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4069 assert_eq!(events.len(), 1);
4070 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
4071 // hop should *not* yet generate any PaymentClaimable event(s).
4072 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false, None);
4075 route_payment(&nodes[0], &[&nodes[1]], 100000).1
4078 let mut block = Block {
4079 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 },
4082 connect_block(&nodes[0], &block);
4083 connect_block(&nodes[1], &block);
4084 let block_count = TEST_FINAL_CLTV + CHAN_CONFIRM_DEPTH + 2 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS;
4085 for _ in CHAN_CONFIRM_DEPTH + 2..block_count {
4086 block.header.prev_blockhash = block.block_hash();
4087 connect_block(&nodes[0], &block);
4088 connect_block(&nodes[1], &block);
4091 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: our_payment_hash }]);
4093 check_added_monitors!(nodes[1], 1);
4094 let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4095 assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
4096 assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
4097 assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
4098 assert!(htlc_timeout_updates.update_fee.is_none());
4100 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
4101 commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
4102 // 100_000 msat as u64, followed by the height at which we failed back above
4103 let mut expected_failure_data = (100_000 as u64).to_be_bytes().to_vec();
4104 expected_failure_data.extend_from_slice(&(block_count - 1).to_be_bytes());
4105 expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
4109 fn test_htlc_timeout() {
4110 do_test_htlc_timeout(true);
4111 do_test_htlc_timeout(false);
4114 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
4115 // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
4116 let chanmon_cfgs = create_chanmon_cfgs(3);
4117 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4118 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4119 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4120 create_announced_chan_between_nodes(&nodes, 0, 1);
4121 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
4123 // Make sure all nodes are at the same starting height
4124 connect_blocks(&nodes[0], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
4125 connect_blocks(&nodes[1], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
4126 connect_blocks(&nodes[2], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
4128 // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
4129 let (route, first_payment_hash, _, first_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[2], 100000);
4131 nodes[1].node.send_payment(&route, first_payment_hash, &Some(first_payment_secret), PaymentId(first_payment_hash.0)).unwrap();
4133 assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
4134 check_added_monitors!(nodes[1], 1);
4136 // Now attempt to route a second payment, which should be placed in the holding cell
4137 let sending_node = if forwarded_htlc { &nodes[0] } else { &nodes[1] };
4138 let (route, second_payment_hash, _, second_payment_secret) = get_route_and_payment_hash!(sending_node, nodes[2], 100000);
4139 sending_node.node.send_payment(&route, second_payment_hash, &Some(second_payment_secret), PaymentId(second_payment_hash.0)).unwrap();
4141 check_added_monitors!(nodes[0], 1);
4142 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4143 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
4144 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4145 expect_pending_htlcs_forwardable!(nodes[1]);
4147 check_added_monitors!(nodes[1], 0);
4149 connect_blocks(&nodes[1], TEST_FINAL_CLTV - LATENCY_GRACE_PERIOD_BLOCKS);
4150 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4151 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4152 connect_blocks(&nodes[1], 1);
4155 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::NextHopChannel { node_id: Some(nodes[2].node.get_our_node_id()), channel_id: chan_2.2 }]);
4156 check_added_monitors!(nodes[1], 1);
4157 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
4158 assert_eq!(fail_commit.len(), 1);
4159 match fail_commit[0] {
4160 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
4161 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
4162 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
4164 _ => unreachable!(),
4166 expect_payment_failed_with_update!(nodes[0], second_payment_hash, false, chan_2.0.contents.short_channel_id, false);
4168 expect_payment_failed!(nodes[1], second_payment_hash, false);
4173 fn test_holding_cell_htlc_add_timeouts() {
4174 do_test_holding_cell_htlc_add_timeouts(false);
4175 do_test_holding_cell_htlc_add_timeouts(true);
4178 macro_rules! check_spendable_outputs {
4179 ($node: expr, $keysinterface: expr) => {
4181 let mut events = $node.chain_monitor.chain_monitor.get_and_clear_pending_events();
4182 let mut txn = Vec::new();
4183 let mut all_outputs = Vec::new();
4184 let secp_ctx = Secp256k1::new();
4185 for event in events.drain(..) {
4187 Event::SpendableOutputs { mut outputs } => {
4188 for outp in outputs.drain(..) {
4189 txn.push($keysinterface.backing.spend_spendable_outputs(&[&outp], Vec::new(), Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &secp_ctx).unwrap());
4190 all_outputs.push(outp);
4193 _ => panic!("Unexpected event"),
4196 if all_outputs.len() > 1 {
4197 if let Ok(tx) = $keysinterface.backing.spend_spendable_outputs(&all_outputs.iter().map(|a| a).collect::<Vec<_>>(), Vec::new(), Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &secp_ctx) {
4207 fn test_claim_sizeable_push_msat() {
4208 // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4209 let chanmon_cfgs = create_chanmon_cfgs(2);
4210 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4211 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4212 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4214 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, 98_000_000);
4215 nodes[1].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
4216 check_closed_broadcast!(nodes[1], true);
4217 check_added_monitors!(nodes[1], 1);
4218 check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed);
4219 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
4220 assert_eq!(node_txn.len(), 1);
4221 check_spends!(node_txn[0], chan.3);
4222 assert_eq!(node_txn[0].output.len(), 2); // We can't force trimming of to_remote output as channel_reserve_satoshis block us to do so at channel opening
4224 mine_transaction(&nodes[1], &node_txn[0]);
4225 connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
4227 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4228 assert_eq!(spend_txn.len(), 1);
4229 assert_eq!(spend_txn[0].input.len(), 1);
4230 check_spends!(spend_txn[0], node_txn[0]);
4231 assert_eq!(spend_txn[0].input[0].sequence.0, BREAKDOWN_TIMEOUT as u32);
4235 fn test_claim_on_remote_sizeable_push_msat() {
4236 // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4237 // to_remote output is encumbered by a P2WPKH
4238 let chanmon_cfgs = create_chanmon_cfgs(2);
4239 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4240 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4241 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4243 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, 98_000_000);
4244 nodes[0].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[1].node.get_our_node_id()).unwrap();
4245 check_closed_broadcast!(nodes[0], true);
4246 check_added_monitors!(nodes[0], 1);
4247 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
4249 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4250 assert_eq!(node_txn.len(), 1);
4251 check_spends!(node_txn[0], chan.3);
4252 assert_eq!(node_txn[0].output.len(), 2); // We can't force trimming of to_remote output as channel_reserve_satoshis block us to do so at channel opening
4254 mine_transaction(&nodes[1], &node_txn[0]);
4255 check_closed_broadcast!(nodes[1], true);
4256 check_added_monitors!(nodes[1], 1);
4257 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
4258 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4260 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4261 assert_eq!(spend_txn.len(), 1);
4262 check_spends!(spend_txn[0], node_txn[0]);
4266 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4267 // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4268 // to_remote output is encumbered by a P2WPKH
4270 let chanmon_cfgs = create_chanmon_cfgs(2);
4271 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4272 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4273 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4275 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000);
4276 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4277 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4278 assert_eq!(revoked_local_txn[0].input.len(), 1);
4279 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4281 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4282 mine_transaction(&nodes[1], &revoked_local_txn[0]);
4283 check_closed_broadcast!(nodes[1], true);
4284 check_added_monitors!(nodes[1], 1);
4285 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
4287 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
4288 mine_transaction(&nodes[1], &node_txn[0]);
4289 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4291 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4292 assert_eq!(spend_txn.len(), 3);
4293 check_spends!(spend_txn[0], revoked_local_txn[0]); // to_remote output on revoked remote commitment_tx
4294 check_spends!(spend_txn[1], node_txn[0]);
4295 check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[0]); // Both outputs
4299 fn test_static_spendable_outputs_preimage_tx() {
4300 let chanmon_cfgs = create_chanmon_cfgs(2);
4301 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4302 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4303 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4305 // Create some initial channels
4306 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
4308 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 3_000_000);
4310 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4311 assert_eq!(commitment_tx[0].input.len(), 1);
4312 assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4314 // Settle A's commitment tx on B's chain
4315 nodes[1].node.claim_funds(payment_preimage);
4316 expect_payment_claimed!(nodes[1], payment_hash, 3_000_000);
4317 check_added_monitors!(nodes[1], 1);
4318 mine_transaction(&nodes[1], &commitment_tx[0]);
4319 check_added_monitors!(nodes[1], 1);
4320 let events = nodes[1].node.get_and_clear_pending_msg_events();
4322 MessageSendEvent::UpdateHTLCs { .. } => {},
4323 _ => panic!("Unexpected event"),
4326 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4327 _ => panic!("Unexepected event"),
4330 // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4331 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelMonitor: preimage tx
4332 assert_eq!(node_txn.len(), 1);
4333 check_spends!(node_txn[0], commitment_tx[0]);
4334 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4336 mine_transaction(&nodes[1], &node_txn[0]);
4337 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
4338 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4340 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4341 assert_eq!(spend_txn.len(), 1);
4342 check_spends!(spend_txn[0], node_txn[0]);
4346 fn test_static_spendable_outputs_timeout_tx() {
4347 let chanmon_cfgs = create_chanmon_cfgs(2);
4348 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4349 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4350 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4352 // Create some initial channels
4353 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
4355 // Rebalance the network a bit by relaying one payment through all the channels ...
4356 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
4358 let (_, our_payment_hash, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
4360 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4361 assert_eq!(commitment_tx[0].input.len(), 1);
4362 assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4364 // Settle A's commitment tx on B' chain
4365 mine_transaction(&nodes[1], &commitment_tx[0]);
4366 check_added_monitors!(nodes[1], 1);
4367 let events = nodes[1].node.get_and_clear_pending_msg_events();
4369 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4370 _ => panic!("Unexpected event"),
4372 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
4374 // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
4375 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4376 assert_eq!(node_txn.len(), 1); // ChannelMonitor: timeout tx
4377 check_spends!(node_txn[0], commitment_tx[0].clone());
4378 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4380 mine_transaction(&nodes[1], &node_txn[0]);
4381 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
4382 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4383 expect_payment_failed!(nodes[1], our_payment_hash, false);
4385 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4386 assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote, timeout_tx.output
4387 check_spends!(spend_txn[0], commitment_tx[0]);
4388 check_spends!(spend_txn[1], node_txn[0]);
4389 check_spends!(spend_txn[2], node_txn[0], commitment_tx[0]); // All outputs
4393 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
4394 let chanmon_cfgs = create_chanmon_cfgs(2);
4395 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4396 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4397 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4399 // Create some initial channels
4400 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
4402 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4403 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4404 assert_eq!(revoked_local_txn[0].input.len(), 1);
4405 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4407 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4409 mine_transaction(&nodes[1], &revoked_local_txn[0]);
4410 check_closed_broadcast!(nodes[1], true);
4411 check_added_monitors!(nodes[1], 1);
4412 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
4414 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
4415 assert_eq!(node_txn.len(), 1);
4416 assert_eq!(node_txn[0].input.len(), 2);
4417 check_spends!(node_txn[0], revoked_local_txn[0]);
4419 mine_transaction(&nodes[1], &node_txn[0]);
4420 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4422 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4423 assert_eq!(spend_txn.len(), 1);
4424 check_spends!(spend_txn[0], node_txn[0]);
4428 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
4429 let mut chanmon_cfgs = create_chanmon_cfgs(2);
4430 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
4431 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4432 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4433 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4435 // Create some initial channels
4436 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
4438 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4439 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4440 assert_eq!(revoked_local_txn[0].input.len(), 1);
4441 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4443 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4445 // A will generate HTLC-Timeout from revoked commitment tx
4446 mine_transaction(&nodes[0], &revoked_local_txn[0]);
4447 check_closed_broadcast!(nodes[0], true);
4448 check_added_monitors!(nodes[0], 1);
4449 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
4450 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
4452 let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4453 assert_eq!(revoked_htlc_txn.len(), 1);
4454 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4455 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4456 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
4457 assert_ne!(revoked_htlc_txn[0].lock_time.0, 0); // HTLC-Timeout
4459 // B will generate justice tx from A's revoked commitment/HTLC tx
4460 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
4461 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] });
4462 check_closed_broadcast!(nodes[1], true);
4463 check_added_monitors!(nodes[1], 1);
4464 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
4466 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
4467 assert_eq!(node_txn.len(), 2); // ChannelMonitor: bogus justice tx, justice tx on revoked outputs
4468 // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
4469 // including the one already spent by revoked_htlc_txn[1]. That's OK, we'll spend with valid
4470 // transactions next...
4471 assert_eq!(node_txn[0].input.len(), 3);
4472 check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
4474 assert_eq!(node_txn[1].input.len(), 2);
4475 check_spends!(node_txn[1], revoked_local_txn[0], revoked_htlc_txn[0]);
4476 if node_txn[1].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
4477 assert_ne!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4479 assert_eq!(node_txn[1].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
4480 assert_ne!(node_txn[1].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4483 mine_transaction(&nodes[1], &node_txn[1]);
4484 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4486 // Check B's ChannelMonitor was able to generate the right spendable output descriptor
4487 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4488 assert_eq!(spend_txn.len(), 1);
4489 assert_eq!(spend_txn[0].input.len(), 1);
4490 check_spends!(spend_txn[0], node_txn[1]);
4494 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
4495 let mut chanmon_cfgs = create_chanmon_cfgs(2);
4496 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
4497 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4498 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4499 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4501 // Create some initial channels
4502 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
4504 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4505 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
4506 assert_eq!(revoked_local_txn[0].input.len(), 1);
4507 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4509 // The to-be-revoked commitment tx should have one HTLC and one to_remote output
4510 assert_eq!(revoked_local_txn[0].output.len(), 2);
4512 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4514 // B will generate HTLC-Success from revoked commitment tx
4515 mine_transaction(&nodes[1], &revoked_local_txn[0]);
4516 check_closed_broadcast!(nodes[1], true);
4517 check_added_monitors!(nodes[1], 1);
4518 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
4519 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
4521 assert_eq!(revoked_htlc_txn.len(), 1);
4522 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4523 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4524 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
4526 // Check that the unspent (of two) outputs on revoked_local_txn[0] is a P2WPKH:
4527 let unspent_local_txn_output = revoked_htlc_txn[0].input[0].previous_output.vout as usize ^ 1;
4528 assert_eq!(revoked_local_txn[0].output[unspent_local_txn_output].script_pubkey.len(), 2 + 20); // P2WPKH
4530 // A will generate justice tx from B's revoked commitment/HTLC tx
4531 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
4532 connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] });
4533 check_closed_broadcast!(nodes[0], true);
4534 check_added_monitors!(nodes[0], 1);
4535 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
4537 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
4538 assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success
4540 // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
4541 // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
4542 // transactions next...
4543 assert_eq!(node_txn[0].input.len(), 2);
4544 check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
4545 if node_txn[0].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
4546 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4548 assert_eq!(node_txn[0].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
4549 assert_eq!(node_txn[0].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4552 assert_eq!(node_txn[1].input.len(), 1);
4553 check_spends!(node_txn[1], revoked_htlc_txn[0]);
4555 mine_transaction(&nodes[0], &node_txn[1]);
4556 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
4558 // Note that nodes[0]'s tx_broadcaster is still locked, so if we get here the channelmonitor
4559 // didn't try to generate any new transactions.
4561 // Check A's ChannelMonitor was able to generate the right spendable output descriptor
4562 let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
4563 assert_eq!(spend_txn.len(), 3);
4564 assert_eq!(spend_txn[0].input.len(), 1);
4565 check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
4566 assert_ne!(spend_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4567 check_spends!(spend_txn[1], node_txn[1]); // spending justice tx output on the htlc success tx
4568 check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[1]); // Both outputs
4572 fn test_onchain_to_onchain_claim() {
4573 // Test that in case of channel closure, we detect the state of output and claim HTLC
4574 // on downstream peer's remote commitment tx.
4575 // First, have C claim an HTLC against its own latest commitment transaction.
4576 // Then, broadcast these to B, which should update the monitor downstream on the A<->B
4578 // Finally, check that B will claim the HTLC output if A's latest commitment transaction
4581 let chanmon_cfgs = create_chanmon_cfgs(3);
4582 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4583 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4584 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4586 // Create some initial channels
4587 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
4588 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
4590 // Ensure all nodes are at the same height
4591 let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
4592 connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
4593 connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
4594 connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
4596 // Rebalance the network a bit by relaying one payment through all the channels ...
4597 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
4598 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
4600 let (payment_preimage, payment_hash, _payment_secret) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3_000_000);
4601 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
4602 check_spends!(commitment_tx[0], chan_2.3);
4603 nodes[2].node.claim_funds(payment_preimage);
4604 expect_payment_claimed!(nodes[2], payment_hash, 3_000_000);
4605 check_added_monitors!(nodes[2], 1);
4606 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
4607 assert!(updates.update_add_htlcs.is_empty());
4608 assert!(updates.update_fail_htlcs.is_empty());
4609 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4610 assert!(updates.update_fail_malformed_htlcs.is_empty());
4612 mine_transaction(&nodes[2], &commitment_tx[0]);
4613 check_closed_broadcast!(nodes[2], true);
4614 check_added_monitors!(nodes[2], 1);
4615 check_closed_event!(nodes[2], 1, ClosureReason::CommitmentTxConfirmed);
4617 let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelMonitor: 1 (HTLC-Success tx)
4618 assert_eq!(c_txn.len(), 1);
4619 check_spends!(c_txn[0], commitment_tx[0]);
4620 assert_eq!(c_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4621 assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
4622 assert_eq!(c_txn[0].lock_time.0, 0); // Success tx
4624 // So we broadcast C's commitment tx and HTLC-Success on B's chain, we should successfully be able to extract preimage and update downstream monitor
4625 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42};
4626 connect_block(&nodes[1], &Block { header, txdata: vec![commitment_tx[0].clone(), c_txn[0].clone()]});
4627 check_added_monitors!(nodes[1], 1);
4628 let events = nodes[1].node.get_and_clear_pending_events();
4629 assert_eq!(events.len(), 2);
4631 Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => {}
4632 _ => panic!("Unexpected event"),
4635 Event::PaymentForwarded { fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id } => {
4636 assert_eq!(fee_earned_msat, Some(1000));
4637 assert_eq!(prev_channel_id, Some(chan_1.2));
4638 assert_eq!(claim_from_onchain_tx, true);
4639 assert_eq!(next_channel_id, Some(chan_2.2));
4641 _ => panic!("Unexpected event"),
4643 check_added_monitors!(nodes[1], 1);
4644 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
4645 assert_eq!(msg_events.len(), 3);
4646 let (nodes_2_event, msg_events) = remove_first_msg_event_to_node(&nodes[2].node.get_our_node_id(), &msg_events);
4647 let (nodes_0_event, msg_events) = remove_first_msg_event_to_node(&nodes[0].node.get_our_node_id(), &msg_events);
4649 match nodes_2_event {
4650 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
4651 _ => panic!("Unexpected event"),
4654 match nodes_0_event {
4655 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, .. } } => {
4656 assert!(update_add_htlcs.is_empty());
4657 assert!(update_fail_htlcs.is_empty());
4658 assert_eq!(update_fulfill_htlcs.len(), 1);
4659 assert!(update_fail_malformed_htlcs.is_empty());
4660 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
4662 _ => panic!("Unexpected event"),
4665 // Ensure that the last remaining message event is the BroadcastChannelUpdate msg for chan_2
4666 match msg_events[0] {
4667 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4668 _ => panic!("Unexpected event"),
4671 // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
4672 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4673 mine_transaction(&nodes[1], &commitment_tx[0]);
4674 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
4675 let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
4676 // ChannelMonitor: HTLC-Success tx
4677 assert_eq!(b_txn.len(), 1);
4678 check_spends!(b_txn[0], commitment_tx[0]);
4679 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4680 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
4681 assert_eq!(b_txn[0].lock_time.0, 0); // Success tx
4683 check_closed_broadcast!(nodes[1], true);
4684 check_added_monitors!(nodes[1], 1);
4688 fn test_duplicate_payment_hash_one_failure_one_success() {
4689 // Topology : A --> B --> C --> D
4690 // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
4691 // Note that because C will refuse to generate two payment secrets for the same payment hash,
4692 // we forward one of the payments onwards to D.
4693 let chanmon_cfgs = create_chanmon_cfgs(4);
4694 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4695 // When this test was written, the default base fee floated based on the HTLC count.
4696 // It is now fixed, so we simply set the fee to the expected value here.
4697 let mut config = test_default_channel_config();
4698 config.channel_config.forwarding_fee_base_msat = 196;
4699 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs,
4700 &[Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone())]);
4701 let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4703 create_announced_chan_between_nodes(&nodes, 0, 1);
4704 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
4705 create_announced_chan_between_nodes(&nodes, 2, 3);
4707 let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
4708 connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
4709 connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
4710 connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
4711 connect_blocks(&nodes[3], node_max_height - nodes[3].best_block_info().1);
4713 let (our_payment_preimage, duplicate_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 900_000);
4715 let payment_secret = nodes[3].node.create_inbound_payment_for_hash(duplicate_payment_hash, None, 7200, None).unwrap();
4716 // We reduce the final CLTV here by a somewhat arbitrary constant to keep it under the one-byte
4717 // script push size limit so that the below script length checks match
4718 // ACCEPTED_HTLC_SCRIPT_WEIGHT.
4719 let payment_params = PaymentParameters::from_node_id(nodes[3].node.get_our_node_id())
4720 .with_features(nodes[3].node.invoice_features());
4721 let (route, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[3], payment_params, 800_000, TEST_FINAL_CLTV - 40);
4722 send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2], &nodes[3]]], 800_000, duplicate_payment_hash, payment_secret);
4724 let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
4725 assert_eq!(commitment_txn[0].input.len(), 1);
4726 check_spends!(commitment_txn[0], chan_2.3);
4728 mine_transaction(&nodes[1], &commitment_txn[0]);
4729 check_closed_broadcast!(nodes[1], true);
4730 check_added_monitors!(nodes[1], 1);
4731 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
4732 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 40 + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
4734 let htlc_timeout_tx;
4735 { // Extract one of the two HTLC-Timeout transaction
4736 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4737 // ChannelMonitor: timeout tx * 2-or-3
4738 assert!(node_txn.len() == 2 || node_txn.len() == 3);
4740 check_spends!(node_txn[0], commitment_txn[0]);
4741 assert_eq!(node_txn[0].input.len(), 1);
4742 assert_eq!(node_txn[0].output.len(), 1);
4744 if node_txn.len() > 2 {
4745 check_spends!(node_txn[1], commitment_txn[0]);
4746 assert_eq!(node_txn[1].input.len(), 1);
4747 assert_eq!(node_txn[1].output.len(), 1);
4748 assert_eq!(node_txn[0].input[0].previous_output, node_txn[1].input[0].previous_output);
4750 check_spends!(node_txn[2], commitment_txn[0]);
4751 assert_eq!(node_txn[2].input.len(), 1);
4752 assert_eq!(node_txn[2].output.len(), 1);
4753 assert_ne!(node_txn[0].input[0].previous_output, node_txn[2].input[0].previous_output);
4755 check_spends!(node_txn[1], commitment_txn[0]);
4756 assert_eq!(node_txn[1].input.len(), 1);
4757 assert_eq!(node_txn[1].output.len(), 1);
4758 assert_ne!(node_txn[0].input[0].previous_output, node_txn[1].input[0].previous_output);
4761 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4762 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4763 // Assign htlc_timeout_tx to the forwarded HTLC (with value ~800 sats). The received HTLC
4764 // (with value 900 sats) will be claimed in the below `claim_funds` call.
4765 if node_txn.len() > 2 {
4766 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4767 htlc_timeout_tx = if node_txn[2].output[0].value < 900 { node_txn[2].clone() } else { node_txn[0].clone() };
4769 htlc_timeout_tx = if node_txn[0].output[0].value < 900 { node_txn[1].clone() } else { node_txn[0].clone() };
4773 nodes[2].node.claim_funds(our_payment_preimage);
4774 expect_payment_claimed!(nodes[2], duplicate_payment_hash, 900_000);
4776 mine_transaction(&nodes[2], &commitment_txn[0]);
4777 check_added_monitors!(nodes[2], 2);
4778 check_closed_event!(nodes[2], 1, ClosureReason::CommitmentTxConfirmed);
4779 let events = nodes[2].node.get_and_clear_pending_msg_events();
4781 MessageSendEvent::UpdateHTLCs { .. } => {},
4782 _ => panic!("Unexpected event"),
4785 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4786 _ => panic!("Unexepected event"),
4788 let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
4789 assert_eq!(htlc_success_txn.len(), 2); // ChannelMonitor: HTLC-Success txn (*2 due to 2-HTLC outputs)
4790 check_spends!(htlc_success_txn[0], commitment_txn[0]);
4791 check_spends!(htlc_success_txn[1], commitment_txn[0]);
4792 assert_eq!(htlc_success_txn[0].input.len(), 1);
4793 assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4794 assert_eq!(htlc_success_txn[1].input.len(), 1);
4795 assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4796 assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_success_txn[1].input[0].previous_output);
4797 assert_ne!(htlc_success_txn[1].input[0].previous_output, htlc_timeout_tx.input[0].previous_output);
4799 mine_transaction(&nodes[1], &htlc_timeout_tx);
4800 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4801 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::NextHopChannel { node_id: Some(nodes[2].node.get_our_node_id()), channel_id: chan_2.2 }]);
4802 let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4803 assert!(htlc_updates.update_add_htlcs.is_empty());
4804 assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
4805 let first_htlc_id = htlc_updates.update_fail_htlcs[0].htlc_id;
4806 assert!(htlc_updates.update_fulfill_htlcs.is_empty());
4807 assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
4808 check_added_monitors!(nodes[1], 1);
4810 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
4811 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4813 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
4815 expect_payment_failed_with_update!(nodes[0], duplicate_payment_hash, false, chan_2.0.contents.short_channel_id, true);
4817 // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
4818 mine_transaction(&nodes[1], &htlc_success_txn[1]);
4819 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(196), true, true);
4820 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4821 assert!(updates.update_add_htlcs.is_empty());
4822 assert!(updates.update_fail_htlcs.is_empty());
4823 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4824 assert_ne!(updates.update_fulfill_htlcs[0].htlc_id, first_htlc_id);
4825 assert!(updates.update_fail_malformed_htlcs.is_empty());
4826 check_added_monitors!(nodes[1], 1);
4828 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
4829 commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
4831 let events = nodes[0].node.get_and_clear_pending_events();
4833 Event::PaymentSent { ref payment_preimage, ref payment_hash, .. } => {
4834 assert_eq!(*payment_preimage, our_payment_preimage);
4835 assert_eq!(*payment_hash, duplicate_payment_hash);
4837 _ => panic!("Unexpected event"),
4842 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
4843 let chanmon_cfgs = create_chanmon_cfgs(2);
4844 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4845 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4846 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4848 // Create some initial channels
4849 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
4851 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 9_000_000);
4852 let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
4853 assert_eq!(local_txn.len(), 1);
4854 assert_eq!(local_txn[0].input.len(), 1);
4855 check_spends!(local_txn[0], chan_1.3);
4857 // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
4858 nodes[1].node.claim_funds(payment_preimage);
4859 expect_payment_claimed!(nodes[1], payment_hash, 9_000_000);
4860 check_added_monitors!(nodes[1], 1);
4862 mine_transaction(&nodes[1], &local_txn[0]);
4863 check_added_monitors!(nodes[1], 1);
4864 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
4865 let events = nodes[1].node.get_and_clear_pending_msg_events();
4867 MessageSendEvent::UpdateHTLCs { .. } => {},
4868 _ => panic!("Unexpected event"),
4871 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4872 _ => panic!("Unexepected event"),
4875 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4876 assert_eq!(node_txn.len(), 1);
4877 assert_eq!(node_txn[0].input.len(), 1);
4878 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4879 check_spends!(node_txn[0], local_txn[0]);
4883 mine_transaction(&nodes[1], &node_tx);
4884 connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
4886 // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
4887 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4888 assert_eq!(spend_txn.len(), 1);
4889 assert_eq!(spend_txn[0].input.len(), 1);
4890 check_spends!(spend_txn[0], node_tx);
4891 assert_eq!(spend_txn[0].input[0].sequence.0, BREAKDOWN_TIMEOUT as u32);
4894 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
4895 // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
4896 // unrevoked commitment transaction.
4897 // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
4898 // a remote RAA before they could be failed backwards (and combinations thereof).
4899 // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
4900 // use the same payment hashes.
4901 // Thus, we use a six-node network:
4906 // And test where C fails back to A/B when D announces its latest commitment transaction
4907 let chanmon_cfgs = create_chanmon_cfgs(6);
4908 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
4909 // When this test was written, the default base fee floated based on the HTLC count.
4910 // It is now fixed, so we simply set the fee to the expected value here.
4911 let mut config = test_default_channel_config();
4912 config.channel_config.forwarding_fee_base_msat = 196;
4913 let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs,
4914 &[Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone())]);
4915 let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
4917 let _chan_0_2 = create_announced_chan_between_nodes(&nodes, 0, 2);
4918 let _chan_1_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
4919 let chan_2_3 = create_announced_chan_between_nodes(&nodes, 2, 3);
4920 let chan_3_4 = create_announced_chan_between_nodes(&nodes, 3, 4);
4921 let chan_3_5 = create_announced_chan_between_nodes(&nodes, 3, 5);
4923 // Rebalance and check output sanity...
4924 send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000);
4925 send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000);
4926 assert_eq!(get_local_commitment_txn!(nodes[3], chan_2_3.2)[0].output.len(), 2);
4928 let ds_dust_limit = nodes[3].node.per_peer_state.read().unwrap().get(&nodes[2].node.get_our_node_id())
4929 .unwrap().lock().unwrap().channel_by_id.get(&chan_2_3.2).unwrap().holder_dust_limit_satoshis;
4931 let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], ds_dust_limit*1000); // not added < dust limit + HTLC tx fee
4933 let (_, payment_hash_2, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], ds_dust_limit*1000); // not added < dust limit + HTLC tx fee
4934 let (route, _, _, _) = get_route_and_payment_hash!(nodes[1], nodes[5], ds_dust_limit*1000);
4936 send_along_route_with_secret(&nodes[1], route.clone(), &[&[&nodes[2], &nodes[3], &nodes[5]]], ds_dust_limit*1000, payment_hash_1, nodes[5].node.create_inbound_payment_for_hash(payment_hash_1, None, 7200, None).unwrap()); // not added < dust limit + HTLC tx fee
4938 send_along_route_with_secret(&nodes[1], route, &[&[&nodes[2], &nodes[3], &nodes[5]]], ds_dust_limit*1000, payment_hash_2, nodes[5].node.create_inbound_payment_for_hash(payment_hash_2, None, 7200, None).unwrap()); // not added < dust limit + HTLC tx fee
4940 let (_, payment_hash_3, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4942 let (_, payment_hash_4, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4943 let (route, _, _, _) = get_route_and_payment_hash!(nodes[1], nodes[5], 1000000);
4945 send_along_route_with_secret(&nodes[1], route.clone(), &[&[&nodes[2], &nodes[3], &nodes[5]]], 1000000, payment_hash_3, nodes[5].node.create_inbound_payment_for_hash(payment_hash_3, None, 7200, None).unwrap());
4947 send_along_route_with_secret(&nodes[1], route, &[&[&nodes[2], &nodes[3], &nodes[5]]], 1000000, payment_hash_4, nodes[5].node.create_inbound_payment_for_hash(payment_hash_4, None, 7200, None).unwrap());
4950 let (_, payment_hash_5, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4952 let (route, _, _, _) = get_route_and_payment_hash!(nodes[1], nodes[5], ds_dust_limit*1000);
4953 send_along_route_with_secret(&nodes[1], route, &[&[&nodes[2], &nodes[3], &nodes[5]]], ds_dust_limit*1000, payment_hash_5, nodes[5].node.create_inbound_payment_for_hash(payment_hash_5, None, 7200, None).unwrap()); // not added < dust limit + HTLC tx fee
4956 let (_, payment_hash_6, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], ds_dust_limit*1000); // not added < dust limit + HTLC tx fee
4958 let (route, _, _, _) = get_route_and_payment_hash!(nodes[1], nodes[5], 1000000);
4959 send_along_route_with_secret(&nodes[1], route, &[&[&nodes[2], &nodes[3], &nodes[5]]], 1000000, payment_hash_6, nodes[5].node.create_inbound_payment_for_hash(payment_hash_6, None, 7200, None).unwrap());
4961 // Double-check that six of the new HTLC were added
4962 // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
4963 // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
4964 assert_eq!(get_local_commitment_txn!(nodes[3], chan_2_3.2).len(), 1);
4965 assert_eq!(get_local_commitment_txn!(nodes[3], chan_2_3.2)[0].output.len(), 8);
4967 // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
4968 // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
4969 nodes[4].node.fail_htlc_backwards(&payment_hash_1);
4970 nodes[4].node.fail_htlc_backwards(&payment_hash_3);
4971 nodes[4].node.fail_htlc_backwards(&payment_hash_5);
4972 nodes[4].node.fail_htlc_backwards(&payment_hash_6);
4973 check_added_monitors!(nodes[4], 0);
4975 let failed_destinations = vec![
4976 HTLCDestination::FailedPayment { payment_hash: payment_hash_1 },
4977 HTLCDestination::FailedPayment { payment_hash: payment_hash_3 },
4978 HTLCDestination::FailedPayment { payment_hash: payment_hash_5 },
4979 HTLCDestination::FailedPayment { payment_hash: payment_hash_6 },
4981 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[4], failed_destinations);
4982 check_added_monitors!(nodes[4], 1);
4984 let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
4985 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
4986 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
4987 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
4988 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
4989 commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
4991 // Fail 3rd below-dust and 7th above-dust HTLCs
4992 nodes[5].node.fail_htlc_backwards(&payment_hash_2);
4993 nodes[5].node.fail_htlc_backwards(&payment_hash_4);
4994 check_added_monitors!(nodes[5], 0);
4996 let failed_destinations_2 = vec![
4997 HTLCDestination::FailedPayment { payment_hash: payment_hash_2 },
4998 HTLCDestination::FailedPayment { payment_hash: payment_hash_4 },
5000 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[5], failed_destinations_2);
5001 check_added_monitors!(nodes[5], 1);
5003 let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5004 nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5005 nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5006 commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5008 let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan_2_3.2);
5010 // After 4 and 2 removes respectively above in nodes[4] and nodes[5], nodes[3] should receive 6 PaymentForwardedFailed events
5011 let failed_destinations_3 = vec![
5012 HTLCDestination::NextHopChannel { node_id: Some(nodes[4].node.get_our_node_id()), channel_id: chan_3_4.2 },
5013 HTLCDestination::NextHopChannel { node_id: Some(nodes[4].node.get_our_node_id()), channel_id: chan_3_4.2 },
5014 HTLCDestination::NextHopChannel { node_id: Some(nodes[4].node.get_our_node_id()), channel_id: chan_3_4.2 },
5015 HTLCDestination::NextHopChannel { node_id: Some(nodes[4].node.get_our_node_id()), channel_id: chan_3_4.2 },
5016 HTLCDestination::NextHopChannel { node_id: Some(nodes[5].node.get_our_node_id()), channel_id: chan_3_5.2 },
5017 HTLCDestination::NextHopChannel { node_id: Some(nodes[5].node.get_our_node_id()), channel_id: chan_3_5.2 },
5019 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[3], failed_destinations_3);
5020 check_added_monitors!(nodes[3], 1);
5021 let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5022 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5023 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5024 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5025 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5026 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5027 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5028 if deliver_last_raa {
5029 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5031 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5034 // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5035 // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5036 // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5037 // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5039 // We now broadcast the latest commitment transaction, which *should* result in failures for
5040 // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5041 // the non-broadcast above-dust HTLCs.
5043 // Alternatively, we may broadcast the previous commitment transaction, which should only
5044 // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5045 let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan_2_3.2);
5047 if announce_latest {
5048 mine_transaction(&nodes[2], &ds_last_commitment_tx[0]);
5050 mine_transaction(&nodes[2], &ds_prev_commitment_tx[0]);
5052 let events = nodes[2].node.get_and_clear_pending_events();
5053 let close_event = if deliver_last_raa {
5054 assert_eq!(events.len(), 2 + 6);
5055 events.last().clone().unwrap()
5057 assert_eq!(events.len(), 1);
5058 events.last().clone().unwrap()
5061 Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => {}
5062 _ => panic!("Unexpected event"),
5065 connect_blocks(&nodes[2], ANTI_REORG_DELAY - 1);
5066 check_closed_broadcast!(nodes[2], true);
5067 if deliver_last_raa {
5068 expect_pending_htlcs_forwardable_from_events!(nodes[2], events[0..1], true);
5070 let expected_destinations: Vec<HTLCDestination> = repeat(HTLCDestination::NextHopChannel { node_id: Some(nodes[3].node.get_our_node_id()), channel_id: chan_2_3.2 }).take(3).collect();
5071 expect_htlc_handling_failed_destinations!(nodes[2].node.get_and_clear_pending_events(), expected_destinations);
5073 let expected_destinations: Vec<HTLCDestination> = if announce_latest {
5074 repeat(HTLCDestination::NextHopChannel { node_id: Some(nodes[3].node.get_our_node_id()), channel_id: chan_2_3.2 }).take(9).collect()
5076 repeat(HTLCDestination::NextHopChannel { node_id: Some(nodes[3].node.get_our_node_id()), channel_id: chan_2_3.2 }).take(6).collect()
5079 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], expected_destinations);
5081 check_added_monitors!(nodes[2], 3);
5083 let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5084 assert_eq!(cs_msgs.len(), 2);
5085 let mut a_done = false;
5086 for msg in cs_msgs {
5088 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5089 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5090 // should be failed-backwards here.
5091 let target = if *node_id == nodes[0].node.get_our_node_id() {
5092 // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5093 for htlc in &updates.update_fail_htlcs {
5094 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 6 || if announce_latest { htlc.htlc_id == 3 || htlc.htlc_id == 5 } else { false });
5096 assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5101 // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5102 for htlc in &updates.update_fail_htlcs {
5103 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5105 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5106 assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5109 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5110 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5111 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5112 if announce_latest {
5113 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5114 if *node_id == nodes[0].node.get_our_node_id() {
5115 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5118 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5120 _ => panic!("Unexpected event"),
5124 let as_events = nodes[0].node.get_and_clear_pending_events();
5125 assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
5126 let mut as_failds = HashSet::new();
5127 let mut as_updates = 0;
5128 for event in as_events.iter() {
5129 if let &Event::PaymentPathFailed { ref payment_hash, ref payment_failed_permanently, ref network_update, .. } = event {
5130 assert!(as_failds.insert(*payment_hash));
5131 if *payment_hash != payment_hash_2 {
5132 assert_eq!(*payment_failed_permanently, deliver_last_raa);
5134 assert!(!payment_failed_permanently);
5136 if network_update.is_some() {
5139 } else { panic!("Unexpected event"); }
5141 assert!(as_failds.contains(&payment_hash_1));
5142 assert!(as_failds.contains(&payment_hash_2));
5143 if announce_latest {
5144 assert!(as_failds.contains(&payment_hash_3));
5145 assert!(as_failds.contains(&payment_hash_5));
5147 assert!(as_failds.contains(&payment_hash_6));
5149 let bs_events = nodes[1].node.get_and_clear_pending_events();
5150 assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
5151 let mut bs_failds = HashSet::new();
5152 let mut bs_updates = 0;
5153 for event in bs_events.iter() {
5154 if let &Event::PaymentPathFailed { ref payment_hash, ref payment_failed_permanently, ref network_update, .. } = event {
5155 assert!(bs_failds.insert(*payment_hash));
5156 if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5157 assert_eq!(*payment_failed_permanently, deliver_last_raa);
5159 assert!(!payment_failed_permanently);
5161 if network_update.is_some() {
5164 } else { panic!("Unexpected event"); }
5166 assert!(bs_failds.contains(&payment_hash_1));
5167 assert!(bs_failds.contains(&payment_hash_2));
5168 if announce_latest {
5169 assert!(bs_failds.contains(&payment_hash_4));
5171 assert!(bs_failds.contains(&payment_hash_5));
5173 // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5174 // get a NetworkUpdate. A should have gotten 4 HTLCs which were failed-back due to
5175 // unknown-preimage-etc, B should have gotten 2. Thus, in the
5176 // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2 NetworkUpdates.
5177 assert_eq!(as_updates, if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5178 assert_eq!(bs_updates, if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5182 fn test_fail_backwards_latest_remote_announce_a() {
5183 do_test_fail_backwards_unrevoked_remote_announce(false, true);
5187 fn test_fail_backwards_latest_remote_announce_b() {
5188 do_test_fail_backwards_unrevoked_remote_announce(true, true);
5192 fn test_fail_backwards_previous_remote_announce() {
5193 do_test_fail_backwards_unrevoked_remote_announce(false, false);
5194 // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5195 // tested for in test_commitment_revoked_fail_backward_exhaustive()
5199 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5200 let chanmon_cfgs = create_chanmon_cfgs(2);
5201 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5202 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5203 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5205 // Create some initial channels
5206 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
5208 let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5209 let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5210 assert_eq!(local_txn[0].input.len(), 1);
5211 check_spends!(local_txn[0], chan_1.3);
5213 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5214 mine_transaction(&nodes[0], &local_txn[0]);
5215 check_closed_broadcast!(nodes[0], true);
5216 check_added_monitors!(nodes[0], 1);
5217 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
5218 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5220 let htlc_timeout = {
5221 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5222 assert_eq!(node_txn.len(), 1);
5223 assert_eq!(node_txn[0].input.len(), 1);
5224 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5225 check_spends!(node_txn[0], local_txn[0]);
5229 mine_transaction(&nodes[0], &htlc_timeout);
5230 connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5231 expect_payment_failed!(nodes[0], our_payment_hash, false);
5233 // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5234 let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5235 assert_eq!(spend_txn.len(), 3);
5236 check_spends!(spend_txn[0], local_txn[0]);
5237 assert_eq!(spend_txn[1].input.len(), 1);
5238 check_spends!(spend_txn[1], htlc_timeout);
5239 assert_eq!(spend_txn[1].input[0].sequence.0, BREAKDOWN_TIMEOUT as u32);
5240 assert_eq!(spend_txn[2].input.len(), 2);
5241 check_spends!(spend_txn[2], local_txn[0], htlc_timeout);
5242 assert!(spend_txn[2].input[0].sequence.0 == BREAKDOWN_TIMEOUT as u32 ||
5243 spend_txn[2].input[1].sequence.0 == BREAKDOWN_TIMEOUT as u32);
5247 fn test_key_derivation_params() {
5248 // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with a key
5249 // manager rotation to test that `channel_keys_id` returned in
5250 // [`SpendableOutputDescriptor::DelayedPaymentOutput`] let us re-derive the channel key set to
5251 // then derive a `delayed_payment_key`.
5253 let chanmon_cfgs = create_chanmon_cfgs(3);
5255 // We manually create the node configuration to backup the seed.
5256 let seed = [42; 32];
5257 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5258 let chain_monitor = test_utils::TestChainMonitor::new(Some(&chanmon_cfgs[0].chain_source), &chanmon_cfgs[0].tx_broadcaster, &chanmon_cfgs[0].logger, &chanmon_cfgs[0].fee_estimator, &chanmon_cfgs[0].persister, &keys_manager);
5259 let network_graph = Arc::new(NetworkGraph::new(chanmon_cfgs[0].chain_source.genesis_hash, &chanmon_cfgs[0].logger));
5260 let router = test_utils::TestRouter::new(network_graph.clone());
5261 let node = NodeCfg { chain_source: &chanmon_cfgs[0].chain_source, logger: &chanmon_cfgs[0].logger, tx_broadcaster: &chanmon_cfgs[0].tx_broadcaster, fee_estimator: &chanmon_cfgs[0].fee_estimator, router, chain_monitor, keys_manager: &keys_manager, network_graph, node_seed: seed, override_init_features: alloc::rc::Rc::new(core::cell::RefCell::new(None)) };
5262 let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5263 node_cfgs.remove(0);
5264 node_cfgs.insert(0, node);
5266 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5267 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5269 // Create some initial channels
5270 // Create a dummy channel to advance index by one and thus test re-derivation correctness
5272 let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2);
5273 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
5274 assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5276 // Ensure all nodes are at the same height
5277 let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5278 connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5279 connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5280 connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5282 let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5283 let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5284 let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5285 assert_eq!(local_txn_1[0].input.len(), 1);
5286 check_spends!(local_txn_1[0], chan_1.3);
5288 // We check funding pubkey are unique
5289 let (from_0_funding_key_0, from_0_funding_key_1) = (PublicKey::from_slice(&local_txn_0[0].input[0].witness.to_vec()[3][2..35]), PublicKey::from_slice(&local_txn_0[0].input[0].witness.to_vec()[3][36..69]));
5290 let (from_1_funding_key_0, from_1_funding_key_1) = (PublicKey::from_slice(&local_txn_1[0].input[0].witness.to_vec()[3][2..35]), PublicKey::from_slice(&local_txn_1[0].input[0].witness.to_vec()[3][36..69]));
5291 if from_0_funding_key_0 == from_1_funding_key_0
5292 || from_0_funding_key_0 == from_1_funding_key_1
5293 || from_0_funding_key_1 == from_1_funding_key_0
5294 || from_0_funding_key_1 == from_1_funding_key_1 {
5295 panic!("Funding pubkeys aren't unique");
5298 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5299 mine_transaction(&nodes[0], &local_txn_1[0]);
5300 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5301 check_closed_broadcast!(nodes[0], true);
5302 check_added_monitors!(nodes[0], 1);
5303 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
5305 let htlc_timeout = {
5306 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5307 assert_eq!(node_txn.len(), 1);
5308 assert_eq!(node_txn[0].input.len(), 1);
5309 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5310 check_spends!(node_txn[0], local_txn_1[0]);
5314 mine_transaction(&nodes[0], &htlc_timeout);
5315 connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5316 expect_payment_failed!(nodes[0], our_payment_hash, false);
5318 // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5319 let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5320 let spend_txn = check_spendable_outputs!(nodes[0], new_keys_manager);
5321 assert_eq!(spend_txn.len(), 3);
5322 check_spends!(spend_txn[0], local_txn_1[0]);
5323 assert_eq!(spend_txn[1].input.len(), 1);
5324 check_spends!(spend_txn[1], htlc_timeout);
5325 assert_eq!(spend_txn[1].input[0].sequence.0, BREAKDOWN_TIMEOUT as u32);
5326 assert_eq!(spend_txn[2].input.len(), 2);
5327 check_spends!(spend_txn[2], local_txn_1[0], htlc_timeout);
5328 assert!(spend_txn[2].input[0].sequence.0 == BREAKDOWN_TIMEOUT as u32 ||
5329 spend_txn[2].input[1].sequence.0 == BREAKDOWN_TIMEOUT as u32);
5333 fn test_static_output_closing_tx() {
5334 let chanmon_cfgs = create_chanmon_cfgs(2);
5335 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5336 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5337 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5339 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
5341 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5342 let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5344 mine_transaction(&nodes[0], &closing_tx);
5345 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
5346 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5348 let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5349 assert_eq!(spend_txn.len(), 1);
5350 check_spends!(spend_txn[0], closing_tx);
5352 mine_transaction(&nodes[1], &closing_tx);
5353 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
5354 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5356 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5357 assert_eq!(spend_txn.len(), 1);
5358 check_spends!(spend_txn[0], closing_tx);
5361 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5362 let chanmon_cfgs = create_chanmon_cfgs(2);
5363 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5364 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5365 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5366 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
5368 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3_000_000 });
5370 // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5371 // present in B's local commitment transaction, but none of A's commitment transactions.
5372 nodes[1].node.claim_funds(payment_preimage);
5373 check_added_monitors!(nodes[1], 1);
5374 expect_payment_claimed!(nodes[1], payment_hash, if use_dust { 50000 } else { 3_000_000 });
5376 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5377 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5378 expect_payment_sent_without_paths!(nodes[0], payment_preimage);
5380 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5381 check_added_monitors!(nodes[0], 1);
5382 let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5383 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5384 check_added_monitors!(nodes[1], 1);
5386 let starting_block = nodes[1].best_block_info();
5387 let mut block = Block {
5388 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 },
5391 for _ in starting_block.1 + 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + starting_block.1 + 2 {
5392 connect_block(&nodes[1], &block);
5393 block.header.prev_blockhash = block.block_hash();
5395 test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5396 check_closed_broadcast!(nodes[1], true);
5397 check_added_monitors!(nodes[1], 1);
5398 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
5401 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5402 let chanmon_cfgs = create_chanmon_cfgs(2);
5403 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5404 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5405 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5406 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
5408 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], if use_dust { 50000 } else { 3000000 });
5409 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
5410 check_added_monitors!(nodes[0], 1);
5412 let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5414 // As far as A is concerned, the HTLC is now present only in the latest remote commitment
5415 // transaction, however it is not in A's latest local commitment, so we can just broadcast that
5416 // to "time out" the HTLC.
5418 let starting_block = nodes[1].best_block_info();
5419 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
5421 for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + starting_block.1 + 2 {
5422 connect_block(&nodes[0], &Block { header, txdata: Vec::new()});
5423 header.prev_blockhash = header.block_hash();
5425 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5426 check_closed_broadcast!(nodes[0], true);
5427 check_added_monitors!(nodes[0], 1);
5428 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
5431 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
5432 let chanmon_cfgs = create_chanmon_cfgs(3);
5433 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5434 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5435 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5436 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
5438 // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
5439 // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
5440 // Also optionally test that we *don't* fail the channel in case the commitment transaction was
5441 // actually revoked.
5442 let htlc_value = if use_dust { 50000 } else { 3000000 };
5443 let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
5444 nodes[1].node.fail_htlc_backwards(&our_payment_hash);
5445 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: our_payment_hash }]);
5446 check_added_monitors!(nodes[1], 1);
5448 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5449 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
5450 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5451 check_added_monitors!(nodes[0], 1);
5452 let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5453 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5454 check_added_monitors!(nodes[1], 1);
5455 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
5456 check_added_monitors!(nodes[1], 1);
5457 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
5459 if check_revoke_no_close {
5460 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
5461 check_added_monitors!(nodes[0], 1);
5464 let starting_block = nodes[1].best_block_info();
5465 let mut block = Block {
5466 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 },
5469 for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 2 {
5470 connect_block(&nodes[0], &block);
5471 block.header.prev_blockhash = block.block_hash();
5473 if !check_revoke_no_close {
5474 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5475 check_closed_broadcast!(nodes[0], true);
5476 check_added_monitors!(nodes[0], 1);
5477 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
5479 expect_payment_failed!(nodes[0], our_payment_hash, true);
5483 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
5484 // There are only a few cases to test here:
5485 // * its not really normative behavior, but we test that below-dust HTLCs "included" in
5486 // broadcastable commitment transactions result in channel closure,
5487 // * its included in an unrevoked-but-previous remote commitment transaction,
5488 // * its included in the latest remote or local commitment transactions.
5489 // We test each of the three possible commitment transactions individually and use both dust and
5491 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
5492 // assume they are handled the same across all six cases, as both outbound and inbound failures are
5493 // tested for at least one of the cases in other tests.
5495 fn htlc_claim_single_commitment_only_a() {
5496 do_htlc_claim_local_commitment_only(true);
5497 do_htlc_claim_local_commitment_only(false);
5499 do_htlc_claim_current_remote_commitment_only(true);
5500 do_htlc_claim_current_remote_commitment_only(false);
5504 fn htlc_claim_single_commitment_only_b() {
5505 do_htlc_claim_previous_remote_commitment_only(true, false);
5506 do_htlc_claim_previous_remote_commitment_only(false, false);
5507 do_htlc_claim_previous_remote_commitment_only(true, true);
5508 do_htlc_claim_previous_remote_commitment_only(false, true);
5513 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
5514 let chanmon_cfgs = create_chanmon_cfgs(2);
5515 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5516 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5517 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5518 // Force duplicate randomness for every get-random call
5519 for node in nodes.iter() {
5520 *node.keys_manager.override_random_bytes.lock().unwrap() = Some([0; 32]);
5523 // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
5524 let channel_value_satoshis=10000;
5525 let push_msat=10001;
5526 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
5527 let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5528 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &node0_to_1_send_open_channel);
5529 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
5531 // Create a second channel with the same random values. This used to panic due to a colliding
5532 // channel_id, but now panics due to a colliding outbound SCID alias.
5533 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5537 fn bolt2_open_channel_sending_node_checks_part2() {
5538 let chanmon_cfgs = create_chanmon_cfgs(2);
5539 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5540 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5541 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5543 // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
5544 let channel_value_satoshis=2^24;
5545 let push_msat=10001;
5546 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5548 // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
5549 let channel_value_satoshis=10000;
5550 // Test when push_msat is equal to 1000 * funding_satoshis.
5551 let push_msat=1000*channel_value_satoshis+1;
5552 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5554 // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
5555 let channel_value_satoshis=10000;
5556 let push_msat=10001;
5557 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_ok()); //Create a valid channel
5558 let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5559 assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
5561 // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
5562 // Only the least-significant bit of channel_flags is currently defined resulting in channel_flags only having one of two possible states 0 or 1
5563 assert!(node0_to_1_send_open_channel.channel_flags<=1);
5565 // BOLT #2 spec: Sending node should set to_self_delay sufficient to ensure the sender can irreversibly spend a commitment transaction output, in case of misbehaviour by the receiver.
5566 assert!(BREAKDOWN_TIMEOUT>0);
5567 assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
5569 // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
5570 let chain_hash=genesis_block(Network::Testnet).header.block_hash();
5571 assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
5573 // BOLT #2 spec: Sending node must set funding_pubkey, revocation_basepoint, htlc_basepoint, payment_basepoint, and delayed_payment_basepoint to valid DER-encoded, compressed, secp256k1 pubkeys.
5574 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
5575 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
5576 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
5577 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
5578 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
5582 fn bolt2_open_channel_sane_dust_limit() {
5583 let chanmon_cfgs = create_chanmon_cfgs(2);
5584 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5585 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5586 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5588 let channel_value_satoshis=1000000;
5589 let push_msat=10001;
5590 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
5591 let mut node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5592 node0_to_1_send_open_channel.dust_limit_satoshis = 547;
5593 node0_to_1_send_open_channel.channel_reserve_satoshis = 100001;
5595 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &node0_to_1_send_open_channel);
5596 let events = nodes[1].node.get_and_clear_pending_msg_events();
5597 let err_msg = match events[0] {
5598 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
5601 _ => panic!("Unexpected event"),
5603 assert_eq!(err_msg.data, "dust_limit_satoshis (547) is greater than the implementation limit (546)");
5606 // Test that if we fail to send an HTLC that is being freed from the holding cell, and the HTLC
5607 // originated from our node, its failure is surfaced to the user. We trigger this failure to
5608 // free the HTLC by increasing our fee while the HTLC is in the holding cell such that the HTLC
5609 // is no longer affordable once it's freed.
5611 fn test_fail_holding_cell_htlc_upon_free() {
5612 let chanmon_cfgs = create_chanmon_cfgs(2);
5613 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5614 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5615 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5616 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
5618 // First nodes[0] generates an update_fee, setting the channel's
5619 // pending_update_fee.
5621 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
5622 *feerate_lock += 20;
5624 nodes[0].node.timer_tick_occurred();
5625 check_added_monitors!(nodes[0], 1);
5627 let events = nodes[0].node.get_and_clear_pending_msg_events();
5628 assert_eq!(events.len(), 1);
5629 let (update_msg, commitment_signed) = match events[0] {
5630 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
5631 (update_fee.as_ref(), commitment_signed)
5633 _ => panic!("Unexpected event"),
5636 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
5638 let mut chan_stat = get_channel_value_stat!(nodes[0], nodes[1], chan.2);
5639 let channel_reserve = chan_stat.channel_reserve_msat;
5640 let feerate = get_feerate!(nodes[0], nodes[1], chan.2);
5641 let opt_anchors = get_opt_anchors!(nodes[0], nodes[1], chan.2);
5643 // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
5644 let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1, opt_anchors);
5645 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], max_can_send);
5647 // Send a payment which passes reserve checks but gets stuck in the holding cell.
5648 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
5649 chan_stat = get_channel_value_stat!(nodes[0], nodes[1], chan.2);
5650 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
5652 // Flush the pending fee update.
5653 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
5654 let (as_revoke_and_ack, _) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5655 check_added_monitors!(nodes[1], 1);
5656 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
5657 check_added_monitors!(nodes[0], 1);
5659 // Upon receipt of the RAA, there will be an attempt to resend the holding cell
5660 // HTLC, but now that the fee has been raised the payment will now fail, causing
5661 // us to surface its failure to the user.
5662 chan_stat = get_channel_value_stat!(nodes[0], nodes[1], chan.2);
5663 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
5664 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), format!("Freeing holding cell with 1 HTLC updates in channel {}", hex::encode(chan.2)), 1);
5665 let failure_log = format!("Failed to send HTLC with payment_hash {} due to Cannot send value that would put our balance under counterparty-announced channel reserve value ({}) in channel {}",
5666 hex::encode(our_payment_hash.0), chan_stat.channel_reserve_msat, hex::encode(chan.2));
5667 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
5669 // Check that the payment failed to be sent out.
5670 let events = nodes[0].node.get_and_clear_pending_events();
5671 assert_eq!(events.len(), 1);
5673 &Event::PaymentPathFailed { ref payment_id, ref payment_hash, ref payment_failed_permanently, ref network_update, ref all_paths_failed, ref short_channel_id, .. } => {
5674 assert_eq!(PaymentId(our_payment_hash.0), *payment_id.as_ref().unwrap());
5675 assert_eq!(our_payment_hash.clone(), *payment_hash);
5676 assert_eq!(*payment_failed_permanently, false);
5677 assert_eq!(*all_paths_failed, true);
5678 assert_eq!(*network_update, None);
5679 assert_eq!(*short_channel_id, Some(route.paths[0][0].short_channel_id));
5681 _ => panic!("Unexpected event"),
5685 // Test that if multiple HTLCs are released from the holding cell and one is
5686 // valid but the other is no longer valid upon release, the valid HTLC can be
5687 // successfully completed while the other one fails as expected.
5689 fn test_free_and_fail_holding_cell_htlcs() {
5690 let chanmon_cfgs = create_chanmon_cfgs(2);
5691 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5692 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5693 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5694 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
5696 // First nodes[0] generates an update_fee, setting the channel's
5697 // pending_update_fee.
5699 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
5700 *feerate_lock += 200;
5702 nodes[0].node.timer_tick_occurred();
5703 check_added_monitors!(nodes[0], 1);
5705 let events = nodes[0].node.get_and_clear_pending_msg_events();
5706 assert_eq!(events.len(), 1);
5707 let (update_msg, commitment_signed) = match events[0] {
5708 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
5709 (update_fee.as_ref(), commitment_signed)
5711 _ => panic!("Unexpected event"),
5714 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
5716 let mut chan_stat = get_channel_value_stat!(nodes[0], nodes[1], chan.2);
5717 let channel_reserve = chan_stat.channel_reserve_msat;
5718 let feerate = get_feerate!(nodes[0], nodes[1], chan.2);
5719 let opt_anchors = get_opt_anchors!(nodes[0], nodes[1], chan.2);
5721 // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
5723 let amt_2 = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 2 + 1, opt_anchors) - amt_1;
5724 let (route_1, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], amt_1);
5725 let (route_2, payment_hash_2, _, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], amt_2);
5727 // Send 2 payments which pass reserve checks but get stuck in the holding cell.
5728 nodes[0].node.send_payment(&route_1, payment_hash_1, &Some(payment_secret_1), PaymentId(payment_hash_1.0)).unwrap();
5729 chan_stat = get_channel_value_stat!(nodes[0], nodes[1], chan.2);
5730 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1);
5731 let payment_id_2 = PaymentId(nodes[0].keys_manager.get_secure_random_bytes());
5732 nodes[0].node.send_payment(&route_2, payment_hash_2, &Some(payment_secret_2), payment_id_2).unwrap();
5733 chan_stat = get_channel_value_stat!(nodes[0], nodes[1], chan.2);
5734 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1 + amt_2);
5736 // Flush the pending fee update.
5737 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
5738 let (revoke_and_ack, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5739 check_added_monitors!(nodes[1], 1);
5740 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_and_ack);
5741 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
5742 check_added_monitors!(nodes[0], 2);
5744 // Upon receipt of the RAA, there will be an attempt to resend the holding cell HTLCs,
5745 // but now that the fee has been raised the second payment will now fail, causing us
5746 // to surface its failure to the user. The first payment should succeed.
5747 chan_stat = get_channel_value_stat!(nodes[0], nodes[1], chan.2);
5748 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
5749 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), format!("Freeing holding cell with 2 HTLC updates in channel {}", hex::encode(chan.2)), 1);
5750 let failure_log = format!("Failed to send HTLC with payment_hash {} due to Cannot send value that would put our balance under counterparty-announced channel reserve value ({}) in channel {}",
5751 hex::encode(payment_hash_2.0), chan_stat.channel_reserve_msat, hex::encode(chan.2));
5752 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
5754 // Check that the second payment failed to be sent out.
5755 let events = nodes[0].node.get_and_clear_pending_events();
5756 assert_eq!(events.len(), 1);
5758 &Event::PaymentPathFailed { ref payment_id, ref payment_hash, ref payment_failed_permanently, ref network_update, ref all_paths_failed, ref short_channel_id, .. } => {
5759 assert_eq!(payment_id_2, *payment_id.as_ref().unwrap());
5760 assert_eq!(payment_hash_2.clone(), *payment_hash);
5761 assert_eq!(*payment_failed_permanently, false);
5762 assert_eq!(*all_paths_failed, true);
5763 assert_eq!(*network_update, None);
5764 assert_eq!(*short_channel_id, Some(route_2.paths[0][0].short_channel_id));
5766 _ => panic!("Unexpected event"),
5769 // Complete the first payment and the RAA from the fee update.
5770 let (payment_event, send_raa_event) = {
5771 let mut msgs = nodes[0].node.get_and_clear_pending_msg_events();
5772 assert_eq!(msgs.len(), 2);
5773 (SendEvent::from_event(msgs.remove(0)), msgs.remove(0))
5775 let raa = match send_raa_event {
5776 MessageSendEvent::SendRevokeAndACK { msg, .. } => msg,
5777 _ => panic!("Unexpected event"),
5779 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
5780 check_added_monitors!(nodes[1], 1);
5781 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
5782 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
5783 let events = nodes[1].node.get_and_clear_pending_events();
5784 assert_eq!(events.len(), 1);
5786 Event::PendingHTLCsForwardable { .. } => {},
5787 _ => panic!("Unexpected event"),
5789 nodes[1].node.process_pending_htlc_forwards();
5790 let events = nodes[1].node.get_and_clear_pending_events();
5791 assert_eq!(events.len(), 1);
5793 Event::PaymentClaimable { .. } => {},
5794 _ => panic!("Unexpected event"),
5796 nodes[1].node.claim_funds(payment_preimage_1);
5797 check_added_monitors!(nodes[1], 1);
5798 expect_payment_claimed!(nodes[1], payment_hash_1, amt_1);
5800 let update_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5801 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msgs.update_fulfill_htlcs[0]);
5802 commitment_signed_dance!(nodes[0], nodes[1], update_msgs.commitment_signed, false, true);
5803 expect_payment_sent!(nodes[0], payment_preimage_1);
5806 // Test that if we fail to forward an HTLC that is being freed from the holding cell that the
5807 // HTLC is failed backwards. We trigger this failure to forward the freed HTLC by increasing
5808 // our fee while the HTLC is in the holding cell such that the HTLC is no longer affordable
5811 fn test_fail_holding_cell_htlc_upon_free_multihop() {
5812 let chanmon_cfgs = create_chanmon_cfgs(3);
5813 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5814 // When this test was written, the default base fee floated based on the HTLC count.
5815 // It is now fixed, so we simply set the fee to the expected value here.
5816 let mut config = test_default_channel_config();
5817 config.channel_config.forwarding_fee_base_msat = 196;
5818 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config.clone()), Some(config.clone()), Some(config.clone())]);
5819 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5820 let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
5821 let chan_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000);
5823 // First nodes[1] generates an update_fee, setting the channel's
5824 // pending_update_fee.
5826 let mut feerate_lock = chanmon_cfgs[1].fee_estimator.sat_per_kw.lock().unwrap();
5827 *feerate_lock += 20;
5829 nodes[1].node.timer_tick_occurred();
5830 check_added_monitors!(nodes[1], 1);
5832 let events = nodes[1].node.get_and_clear_pending_msg_events();
5833 assert_eq!(events.len(), 1);
5834 let (update_msg, commitment_signed) = match events[0] {
5835 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
5836 (update_fee.as_ref(), commitment_signed)
5838 _ => panic!("Unexpected event"),
5841 nodes[2].node.handle_update_fee(&nodes[1].node.get_our_node_id(), update_msg.unwrap());
5843 let mut chan_stat = get_channel_value_stat!(nodes[0], nodes[1], chan_0_1.2);
5844 let channel_reserve = chan_stat.channel_reserve_msat;
5845 let feerate = get_feerate!(nodes[0], nodes[1], chan_0_1.2);
5846 let opt_anchors = get_opt_anchors!(nodes[0], nodes[1], chan_0_1.2);
5848 // Send a payment which passes reserve checks but gets stuck in the holding cell.
5850 let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
5851 let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1, opt_anchors) - total_routing_fee_msat;
5852 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], max_can_send);
5853 let payment_event = {
5854 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
5855 check_added_monitors!(nodes[0], 1);
5857 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5858 assert_eq!(events.len(), 1);
5860 SendEvent::from_event(events.remove(0))
5862 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
5863 check_added_monitors!(nodes[1], 0);
5864 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
5865 expect_pending_htlcs_forwardable!(nodes[1]);
5867 chan_stat = get_channel_value_stat!(nodes[1], nodes[2], chan_1_2.2);
5868 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
5870 // Flush the pending fee update.
5871 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
5872 let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5873 check_added_monitors!(nodes[2], 1);
5874 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &raa);
5875 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &commitment_signed);
5876 check_added_monitors!(nodes[1], 2);
5878 // A final RAA message is generated to finalize the fee update.
5879 let events = nodes[1].node.get_and_clear_pending_msg_events();
5880 assert_eq!(events.len(), 1);
5882 let raa_msg = match &events[0] {
5883 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => {
5886 _ => panic!("Unexpected event"),
5889 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_msg);
5890 check_added_monitors!(nodes[2], 1);
5891 assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
5893 // nodes[1]'s ChannelManager will now signal that we have HTLC forwards to process.
5894 let process_htlc_forwards_event = nodes[1].node.get_and_clear_pending_events();
5895 assert_eq!(process_htlc_forwards_event.len(), 2);
5896 match &process_htlc_forwards_event[0] {
5897 &Event::PendingHTLCsForwardable { .. } => {},
5898 _ => panic!("Unexpected event"),
5901 // In response, we call ChannelManager's process_pending_htlc_forwards
5902 nodes[1].node.process_pending_htlc_forwards();
5903 check_added_monitors!(nodes[1], 1);
5905 // This causes the HTLC to be failed backwards.
5906 let fail_event = nodes[1].node.get_and_clear_pending_msg_events();
5907 assert_eq!(fail_event.len(), 1);
5908 let (fail_msg, commitment_signed) = match &fail_event[0] {
5909 &MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
5910 assert_eq!(updates.update_add_htlcs.len(), 0);
5911 assert_eq!(updates.update_fulfill_htlcs.len(), 0);
5912 assert_eq!(updates.update_fail_malformed_htlcs.len(), 0);
5913 assert_eq!(updates.update_fail_htlcs.len(), 1);
5914 (updates.update_fail_htlcs[0].clone(), updates.commitment_signed.clone())
5916 _ => panic!("Unexpected event"),
5919 // Pass the failure messages back to nodes[0].
5920 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
5921 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
5923 // Complete the HTLC failure+removal process.
5924 let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5925 check_added_monitors!(nodes[0], 1);
5926 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
5927 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
5928 check_added_monitors!(nodes[1], 2);
5929 let final_raa_event = nodes[1].node.get_and_clear_pending_msg_events();
5930 assert_eq!(final_raa_event.len(), 1);
5931 let raa = match &final_raa_event[0] {
5932 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => msg.clone(),
5933 _ => panic!("Unexpected event"),
5935 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
5936 expect_payment_failed_with_update!(nodes[0], our_payment_hash, false, chan_1_2.0.contents.short_channel_id, false);
5937 check_added_monitors!(nodes[0], 1);
5940 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
5941 // BOLT 2 Requirement: MUST NOT offer amount_msat it cannot pay for in the remote commitment transaction at the current feerate_per_kw (see "Updating Fees") while maintaining its channel reserve.
5942 //TODO: I don't believe this is explicitly enforced when sending an HTLC but as the Fee aspect of the BOLT specs is in flux leaving this as a TODO.
5945 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
5946 //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
5947 let chanmon_cfgs = create_chanmon_cfgs(2);
5948 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5949 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5950 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5951 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
5953 let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100000);
5954 route.paths[0][0].fee_msat = 100;
5956 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)), true, APIError::ChannelUnavailable { ref err },
5957 assert!(regex::Regex::new(r"Cannot send less than their minimum HTLC value \(\d+\)").unwrap().is_match(err)));
5958 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5959 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
5963 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
5964 //BOLT2 Requirement: MUST offer amount_msat greater than 0.
5965 let chanmon_cfgs = create_chanmon_cfgs(2);
5966 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5967 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5968 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5969 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
5971 let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100000);
5972 route.paths[0][0].fee_msat = 0;
5973 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)), true, APIError::ChannelUnavailable { ref err },
5974 assert_eq!(err, "Cannot send 0-msat HTLC"));
5976 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5977 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
5981 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
5982 //BOLT2 Requirement: MUST offer amount_msat greater than 0.
5983 let chanmon_cfgs = create_chanmon_cfgs(2);
5984 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5985 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5986 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5987 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
5989 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100000);
5990 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
5991 check_added_monitors!(nodes[0], 1);
5992 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5993 updates.update_add_htlcs[0].amount_msat = 0;
5995 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5996 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
5997 check_closed_broadcast!(nodes[1], true).unwrap();
5998 check_added_monitors!(nodes[1], 1);
5999 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "Remote side tried to send a 0-msat HTLC".to_string() });
6003 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6004 //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6005 //It is enforced when constructing a route.
6006 let chanmon_cfgs = create_chanmon_cfgs(2);
6007 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6008 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6009 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6010 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0);
6012 let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id())
6013 .with_features(nodes[1].node.invoice_features());
6014 let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], payment_params, 100000000, 0);
6015 route.paths[0].last_mut().unwrap().cltv_expiry_delta = 500000001;
6016 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)), true, APIError::InvalidRoute { ref err },
6017 assert_eq!(err, &"Channel CLTV overflowed?"));
6021 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6022 //BOLT 2 Requirement: if result would be offering more than the remote's max_accepted_htlcs HTLCs, in the remote commitment transaction: MUST NOT add an HTLC.
6023 //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6024 //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
6025 let chanmon_cfgs = create_chanmon_cfgs(2);
6026 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6027 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6028 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6029 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0);
6030 let max_accepted_htlcs = nodes[1].node.per_peer_state.read().unwrap().get(&nodes[0].node.get_our_node_id())
6031 .unwrap().lock().unwrap().channel_by_id.get(&chan.2).unwrap().counterparty_max_accepted_htlcs as u64;
6033 for i in 0..max_accepted_htlcs {
6034 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100000);
6035 let payment_event = {
6036 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6037 check_added_monitors!(nodes[0], 1);
6039 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6040 assert_eq!(events.len(), 1);
6041 if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6042 assert_eq!(htlcs[0].htlc_id, i);
6046 SendEvent::from_event(events.remove(0))
6048 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6049 check_added_monitors!(nodes[1], 0);
6050 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6052 expect_pending_htlcs_forwardable!(nodes[1]);
6053 expect_payment_claimable!(nodes[1], our_payment_hash, our_payment_secret, 100000);
6055 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100000);
6056 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)), true, APIError::ChannelUnavailable { ref err },
6057 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
6059 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6060 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
6064 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6065 //BOLT 2 Requirement: if the sum of total offered HTLCs would exceed the remote's max_htlc_value_in_flight_msat: MUST NOT add an HTLC.
6066 let chanmon_cfgs = create_chanmon_cfgs(2);
6067 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6068 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6069 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6070 let channel_value = 100000;
6071 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0);
6072 let max_in_flight = get_channel_value_stat!(nodes[0], nodes[1], chan.2).counterparty_max_htlc_value_in_flight_msat;
6074 send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight);
6076 let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], max_in_flight);
6077 // Manually create a route over our max in flight (which our router normally automatically
6079 route.paths[0][0].fee_msat = max_in_flight + 1;
6080 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)), true, APIError::ChannelUnavailable { ref err },
6081 assert!(regex::Regex::new(r"Cannot send value that would put us over the max HTLC value in flight our peer will accept \(\d+\)").unwrap().is_match(err)));
6083 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6084 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over the max HTLC value in flight our peer will accept".to_string(), 1);
6086 send_payment(&nodes[0], &[&nodes[1]], max_in_flight);
6089 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6091 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6092 //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
6093 let chanmon_cfgs = create_chanmon_cfgs(2);
6094 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6095 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6096 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6097 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
6098 let htlc_minimum_msat: u64;
6100 let per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
6101 let chan_lock = per_peer_state.get(&nodes[1].node.get_our_node_id()).unwrap().lock().unwrap();
6102 let channel = chan_lock.channel_by_id.get(&chan.2).unwrap();
6103 htlc_minimum_msat = channel.get_holder_htlc_minimum_msat();
6106 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], htlc_minimum_msat);
6107 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6108 check_added_monitors!(nodes[0], 1);
6109 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6110 updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6111 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6112 assert!(nodes[1].node.list_channels().is_empty());
6113 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6114 assert!(regex::Regex::new(r"Remote side tried to send less than our minimum HTLC value\. Lower limit: \(\d+\)\. Actual: \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6115 check_added_monitors!(nodes[1], 1);
6116 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: err_msg.data });
6120 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6121 //BOLT2 Requirement: receiving an amount_msat that the sending node cannot afford at the current feerate_per_kw (while maintaining its channel reserve): SHOULD fail the channel
6122 let chanmon_cfgs = create_chanmon_cfgs(2);
6123 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6124 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6125 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6126 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
6128 let chan_stat = get_channel_value_stat!(nodes[0], nodes[1], chan.2);
6129 let channel_reserve = chan_stat.channel_reserve_msat;
6130 let feerate = get_feerate!(nodes[0], nodes[1], chan.2);
6131 let opt_anchors = get_opt_anchors!(nodes[0], nodes[1], chan.2);
6132 // The 2* and +1 are for the fee spike reserve.
6133 let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1, opt_anchors);
6135 let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6136 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], max_can_send);
6137 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6138 check_added_monitors!(nodes[0], 1);
6139 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6141 // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6142 // at this time channel-initiatee receivers are not required to enforce that senders
6143 // respect the fee_spike_reserve.
6144 updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
6145 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6147 assert!(nodes[1].node.list_channels().is_empty());
6148 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6149 assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
6150 check_added_monitors!(nodes[1], 1);
6151 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: err_msg.data });
6155 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
6156 //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
6157 //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
6158 let chanmon_cfgs = create_chanmon_cfgs(2);
6159 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6160 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6161 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6162 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
6164 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 3999999);
6165 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
6166 let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
6167 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
6168 let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &Some(our_payment_secret), cur_height, &None).unwrap();
6169 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
6171 let mut msg = msgs::UpdateAddHTLC {
6175 payment_hash: our_payment_hash,
6176 cltv_expiry: htlc_cltv,
6177 onion_routing_packet: onion_packet.clone(),
6180 for i in 0..super::channel::OUR_MAX_HTLCS {
6181 msg.htlc_id = i as u64;
6182 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6184 msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
6185 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6187 assert!(nodes[1].node.list_channels().is_empty());
6188 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6189 assert!(regex::Regex::new(r"Remote tried to push more than our max accepted HTLCs \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6190 check_added_monitors!(nodes[1], 1);
6191 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: err_msg.data });
6195 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
6196 //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
6197 let chanmon_cfgs = create_chanmon_cfgs(2);
6198 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6199 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6200 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6201 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000);
6203 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
6204 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6205 check_added_monitors!(nodes[0], 1);
6206 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6207 updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], nodes[0], chan.2).counterparty_max_htlc_value_in_flight_msat + 1;
6208 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6210 assert!(nodes[1].node.list_channels().is_empty());
6211 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6212 assert!(regex::Regex::new("Remote HTLC add would put them over our max HTLC value").unwrap().is_match(err_msg.data.as_str()));
6213 check_added_monitors!(nodes[1], 1);
6214 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: err_msg.data });
6218 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6219 //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6220 let chanmon_cfgs = create_chanmon_cfgs(2);
6221 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6222 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6223 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6225 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
6226 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
6227 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6228 check_added_monitors!(nodes[0], 1);
6229 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6230 updates.update_add_htlcs[0].cltv_expiry = 500000000;
6231 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6233 assert!(nodes[1].node.list_channels().is_empty());
6234 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6235 assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6236 check_added_monitors!(nodes[1], 1);
6237 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: err_msg.data });
6241 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6242 //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6243 // We test this by first testing that that repeated HTLCs pass commitment signature checks
6244 // after disconnect and that non-sequential htlc_ids result in a channel failure.
6245 let chanmon_cfgs = create_chanmon_cfgs(2);
6246 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6247 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6248 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6250 create_announced_chan_between_nodes(&nodes, 0, 1);
6251 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
6252 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6253 check_added_monitors!(nodes[0], 1);
6254 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6255 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6257 //Disconnect and Reconnect
6258 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6259 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6260 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: nodes[1].node.init_features(), remote_network_address: None }).unwrap();
6261 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6262 assert_eq!(reestablish_1.len(), 1);
6263 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: nodes[0].node.init_features(), remote_network_address: None }).unwrap();
6264 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6265 assert_eq!(reestablish_2.len(), 1);
6266 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6267 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6268 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6269 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6272 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6273 assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6274 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6275 check_added_monitors!(nodes[1], 1);
6276 let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6278 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6280 assert!(nodes[1].node.list_channels().is_empty());
6281 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6282 assert!(regex::Regex::new(r"Remote skipped HTLC ID \(skipped ID: \d+\)").unwrap().is_match(err_msg.data.as_str()));
6283 check_added_monitors!(nodes[1], 1);
6284 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: err_msg.data });
6288 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6289 //BOLT 2 Requirement: until the corresponding HTLC is irrevocably committed in both sides' commitment transactions: MUST NOT send an update_fulfill_htlc, update_fail_htlc, or update_fail_malformed_htlc.
6291 let chanmon_cfgs = create_chanmon_cfgs(2);
6292 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6293 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6294 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6295 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
6296 let (route, our_payment_hash, our_payment_preimage, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
6297 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6299 check_added_monitors!(nodes[0], 1);
6300 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6301 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6303 let update_msg = msgs::UpdateFulfillHTLC{
6306 payment_preimage: our_payment_preimage,
6309 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6311 assert!(nodes[0].node.list_channels().is_empty());
6312 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6313 assert!(regex::Regex::new(r"Remote tried to fulfill/fail HTLC \(\d+\) before it had been committed").unwrap().is_match(err_msg.data.as_str()));
6314 check_added_monitors!(nodes[0], 1);
6315 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: err_msg.data });
6319 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6320 //BOLT 2 Requirement: until the corresponding HTLC is irrevocably committed in both sides' commitment transactions: MUST NOT send an update_fulfill_htlc, update_fail_htlc, or update_fail_malformed_htlc.
6322 let chanmon_cfgs = create_chanmon_cfgs(2);
6323 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6324 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6325 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6326 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
6328 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
6329 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6330 check_added_monitors!(nodes[0], 1);
6331 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6332 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6334 let update_msg = msgs::UpdateFailHTLC{
6337 reason: msgs::OnionErrorPacket { data: Vec::new()},
6340 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6342 assert!(nodes[0].node.list_channels().is_empty());
6343 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6344 assert!(regex::Regex::new(r"Remote tried to fulfill/fail HTLC \(\d+\) before it had been committed").unwrap().is_match(err_msg.data.as_str()));
6345 check_added_monitors!(nodes[0], 1);
6346 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: err_msg.data });
6350 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6351 //BOLT 2 Requirement: until the corresponding HTLC is irrevocably committed in both sides' commitment transactions: MUST NOT send an update_fulfill_htlc, update_fail_htlc, or update_fail_malformed_htlc.
6353 let chanmon_cfgs = create_chanmon_cfgs(2);
6354 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6355 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6356 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6357 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
6359 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
6360 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6361 check_added_monitors!(nodes[0], 1);
6362 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6363 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6364 let update_msg = msgs::UpdateFailMalformedHTLC{
6367 sha256_of_onion: [1; 32],
6368 failure_code: 0x8000,
6371 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6373 assert!(nodes[0].node.list_channels().is_empty());
6374 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6375 assert!(regex::Regex::new(r"Remote tried to fulfill/fail HTLC \(\d+\) before it had been committed").unwrap().is_match(err_msg.data.as_str()));
6376 check_added_monitors!(nodes[0], 1);
6377 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: err_msg.data });
6381 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
6382 //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
6384 let chanmon_cfgs = create_chanmon_cfgs(2);
6385 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6386 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6387 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6388 create_announced_chan_between_nodes(&nodes, 0, 1);
6390 let (our_payment_preimage, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 100_000);
6392 nodes[1].node.claim_funds(our_payment_preimage);
6393 check_added_monitors!(nodes[1], 1);
6394 expect_payment_claimed!(nodes[1], our_payment_hash, 100_000);
6396 let events = nodes[1].node.get_and_clear_pending_msg_events();
6397 assert_eq!(events.len(), 1);
6398 let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6400 MessageSendEvent::UpdateHTLCs { 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, .. } } => {
6401 assert!(update_add_htlcs.is_empty());
6402 assert_eq!(update_fulfill_htlcs.len(), 1);
6403 assert!(update_fail_htlcs.is_empty());
6404 assert!(update_fail_malformed_htlcs.is_empty());
6405 assert!(update_fee.is_none());
6406 update_fulfill_htlcs[0].clone()
6408 _ => panic!("Unexpected event"),
6412 update_fulfill_msg.htlc_id = 1;
6414 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6416 assert!(nodes[0].node.list_channels().is_empty());
6417 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6418 assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
6419 check_added_monitors!(nodes[0], 1);
6420 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: err_msg.data });
6424 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
6425 //BOLT 2 Requirement: A receiving node: if the payment_preimage value in update_fulfill_htlc doesn't SHA256 hash to the corresponding HTLC payment_hash MUST fail the channel.
6427 let chanmon_cfgs = create_chanmon_cfgs(2);
6428 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6429 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6430 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6431 create_announced_chan_between_nodes(&nodes, 0, 1);
6433 let (our_payment_preimage, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 100_000);
6435 nodes[1].node.claim_funds(our_payment_preimage);
6436 check_added_monitors!(nodes[1], 1);
6437 expect_payment_claimed!(nodes[1], our_payment_hash, 100_000);
6439 let events = nodes[1].node.get_and_clear_pending_msg_events();
6440 assert_eq!(events.len(), 1);
6441 let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6443 MessageSendEvent::UpdateHTLCs { 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, .. } } => {
6444 assert!(update_add_htlcs.is_empty());
6445 assert_eq!(update_fulfill_htlcs.len(), 1);
6446 assert!(update_fail_htlcs.is_empty());
6447 assert!(update_fail_malformed_htlcs.is_empty());
6448 assert!(update_fee.is_none());
6449 update_fulfill_htlcs[0].clone()
6451 _ => panic!("Unexpected event"),
6455 update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
6457 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6459 assert!(nodes[0].node.list_channels().is_empty());
6460 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6461 assert!(regex::Regex::new(r"Remote tried to fulfill HTLC \(\d+\) with an incorrect preimage").unwrap().is_match(err_msg.data.as_str()));
6462 check_added_monitors!(nodes[0], 1);
6463 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: err_msg.data });
6467 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
6468 //BOLT 2 Requirement: A receiving node: if the BADONION bit in failure_code is not set for update_fail_malformed_htlc MUST fail the channel.
6470 let chanmon_cfgs = create_chanmon_cfgs(2);
6471 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6472 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6473 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6474 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000);
6476 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
6477 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6478 check_added_monitors!(nodes[0], 1);
6480 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6481 updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6483 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6484 check_added_monitors!(nodes[1], 0);
6485 commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
6487 let events = nodes[1].node.get_and_clear_pending_msg_events();
6489 let mut update_msg: msgs::UpdateFailMalformedHTLC = {
6491 MessageSendEvent::UpdateHTLCs { 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, .. } } => {
6492 assert!(update_add_htlcs.is_empty());
6493 assert!(update_fulfill_htlcs.is_empty());
6494 assert!(update_fail_htlcs.is_empty());
6495 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6496 assert!(update_fee.is_none());
6497 update_fail_malformed_htlcs[0].clone()
6499 _ => panic!("Unexpected event"),
6502 update_msg.failure_code &= !0x8000;
6503 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6505 assert!(nodes[0].node.list_channels().is_empty());
6506 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6507 assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
6508 check_added_monitors!(nodes[0], 1);
6509 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: err_msg.data });
6513 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
6514 //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
6515 // * MUST return an error in the update_fail_htlc sent to the link which originally sent the HTLC, using the failure_code given and setting the data to sha256_of_onion.
6517 let chanmon_cfgs = create_chanmon_cfgs(3);
6518 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6519 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6520 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6521 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000);
6522 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000);
6524 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 100000);
6527 let mut payment_event = {
6528 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6529 check_added_monitors!(nodes[0], 1);
6530 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6531 assert_eq!(events.len(), 1);
6532 SendEvent::from_event(events.remove(0))
6534 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6535 check_added_monitors!(nodes[1], 0);
6536 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6537 expect_pending_htlcs_forwardable!(nodes[1]);
6538 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
6539 assert_eq!(events_2.len(), 1);
6540 check_added_monitors!(nodes[1], 1);
6541 payment_event = SendEvent::from_event(events_2.remove(0));
6542 assert_eq!(payment_event.msgs.len(), 1);
6545 payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6546 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
6547 check_added_monitors!(nodes[2], 0);
6548 commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
6550 let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
6551 assert_eq!(events_3.len(), 1);
6552 let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
6554 MessageSendEvent::UpdateHTLCs { 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 } } => {
6555 assert!(update_add_htlcs.is_empty());
6556 assert!(update_fulfill_htlcs.is_empty());
6557 assert!(update_fail_htlcs.is_empty());
6558 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6559 assert!(update_fee.is_none());
6560 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
6562 _ => panic!("Unexpected event"),
6566 nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
6568 check_added_monitors!(nodes[1], 0);
6569 commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
6570 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::NextHopChannel { node_id: Some(nodes[2].node.get_our_node_id()), channel_id: chan_2.2 }]);
6571 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
6572 assert_eq!(events_4.len(), 1);
6574 //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
6576 MessageSendEvent::UpdateHTLCs { 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, .. } } => {
6577 assert!(update_add_htlcs.is_empty());
6578 assert!(update_fulfill_htlcs.is_empty());
6579 assert_eq!(update_fail_htlcs.len(), 1);
6580 assert!(update_fail_malformed_htlcs.is_empty());
6581 assert!(update_fee.is_none());
6583 _ => panic!("Unexpected event"),
6586 check_added_monitors!(nodes[1], 1);
6590 fn test_channel_failed_after_message_with_badonion_node_perm_bits_set() {
6591 let chanmon_cfgs = create_chanmon_cfgs(3);
6592 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6593 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6594 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6595 create_announced_chan_between_nodes(&nodes, 0, 1);
6596 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
6598 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 100_000);
6601 let mut payment_event = {
6602 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6603 check_added_monitors!(nodes[0], 1);
6604 SendEvent::from_node(&nodes[0])
6607 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6608 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6609 expect_pending_htlcs_forwardable!(nodes[1]);
6610 check_added_monitors!(nodes[1], 1);
6611 payment_event = SendEvent::from_node(&nodes[1]);
6612 assert_eq!(payment_event.msgs.len(), 1);
6615 payment_event.msgs[0].onion_routing_packet.version = 1; // Trigger an invalid_onion_version error
6616 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
6617 check_added_monitors!(nodes[2], 0);
6618 commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
6620 let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
6621 assert_eq!(events_3.len(), 1);
6623 MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6624 let mut update_msg = updates.update_fail_malformed_htlcs[0].clone();
6625 // Set the NODE bit (BADONION and PERM already set in invalid_onion_version error)
6626 update_msg.failure_code |= 0x2000;
6628 nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg);
6629 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true);
6631 _ => panic!("Unexpected event"),
6634 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1],
6635 vec![HTLCDestination::NextHopChannel {
6636 node_id: Some(nodes[2].node.get_our_node_id()), channel_id: chan_2.2 }]);
6637 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
6638 assert_eq!(events_4.len(), 1);
6639 check_added_monitors!(nodes[1], 1);
6642 MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6643 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
6644 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, false, true);
6646 _ => panic!("Unexpected event"),
6649 let events_5 = nodes[0].node.get_and_clear_pending_events();
6650 assert_eq!(events_5.len(), 1);
6652 // Expect a PaymentPathFailed event with a ChannelFailure network update for the channel between
6653 // the node originating the error to its next hop.
6655 Event::PaymentPathFailed { network_update:
6656 Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent }), error_code, ..
6658 assert_eq!(short_channel_id, chan_2.0.contents.short_channel_id);
6659 assert!(is_permanent);
6660 assert_eq!(error_code, Some(0x8000|0x4000|0x2000|4));
6662 _ => panic!("Unexpected event"),
6665 // TODO: Test actual removal of channel from NetworkGraph when it's implemented.
6668 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
6669 // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
6670 // We can have at most two valid local commitment tx, so both cases must be covered, and both txs must be checked to get them all as
6671 // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
6673 let mut chanmon_cfgs = create_chanmon_cfgs(2);
6674 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
6675 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6676 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6677 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6678 let chan =create_announced_chan_between_nodes(&nodes, 0, 1);
6680 let bs_dust_limit = nodes[1].node.per_peer_state.read().unwrap().get(&nodes[0].node.get_our_node_id())
6681 .unwrap().lock().unwrap().channel_by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
6683 // We route 2 dust-HTLCs between A and B
6684 let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6685 let (_, payment_hash_2, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6686 route_payment(&nodes[0], &[&nodes[1]], 1000000);
6688 // Cache one local commitment tx as previous
6689 let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6691 // Fail one HTLC to prune it in the will-be-latest-local commitment tx
6692 nodes[1].node.fail_htlc_backwards(&payment_hash_2);
6693 check_added_monitors!(nodes[1], 0);
6694 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash_2 }]);
6695 check_added_monitors!(nodes[1], 1);
6697 let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6698 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
6699 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
6700 check_added_monitors!(nodes[0], 1);
6702 // Cache one local commitment tx as lastest
6703 let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6705 let events = nodes[0].node.get_and_clear_pending_msg_events();
6707 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
6708 assert_eq!(node_id, nodes[1].node.get_our_node_id());
6710 _ => panic!("Unexpected event"),
6713 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
6714 assert_eq!(node_id, nodes[1].node.get_our_node_id());
6716 _ => panic!("Unexpected event"),
6719 assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
6720 // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
6721 if announce_latest {
6722 mine_transaction(&nodes[0], &as_last_commitment_tx[0]);
6724 mine_transaction(&nodes[0], &as_prev_commitment_tx[0]);
6727 check_closed_broadcast!(nodes[0], true);
6728 check_added_monitors!(nodes[0], 1);
6729 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
6731 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6732 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
6733 let events = nodes[0].node.get_and_clear_pending_events();
6734 // Only 2 PaymentPathFailed events should show up, over-dust HTLC has to be failed by timeout tx
6735 assert_eq!(events.len(), 2);
6736 let mut first_failed = false;
6737 for event in events {
6739 Event::PaymentPathFailed { payment_hash, .. } => {
6740 if payment_hash == payment_hash_1 {
6741 assert!(!first_failed);
6742 first_failed = true;
6744 assert_eq!(payment_hash, payment_hash_2);
6747 _ => panic!("Unexpected event"),
6753 fn test_failure_delay_dust_htlc_local_commitment() {
6754 do_test_failure_delay_dust_htlc_local_commitment(true);
6755 do_test_failure_delay_dust_htlc_local_commitment(false);
6758 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
6759 // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
6760 // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
6761 // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
6762 // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
6763 // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
6764 // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
6766 let chanmon_cfgs = create_chanmon_cfgs(3);
6767 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6768 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6769 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6770 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
6772 let bs_dust_limit = nodes[1].node.per_peer_state.read().unwrap().get(&nodes[0].node.get_our_node_id())
6773 .unwrap().lock().unwrap().channel_by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
6775 let (_payment_preimage_1, dust_hash, _payment_secret_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6776 let (_payment_preimage_2, non_dust_hash, _payment_secret_2) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
6778 let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6779 let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
6781 // We revoked bs_commitment_tx
6783 let (payment_preimage_3, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
6784 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
6787 let mut timeout_tx = Vec::new();
6789 // We fail dust-HTLC 1 by broadcast of local commitment tx
6790 mine_transaction(&nodes[0], &as_commitment_tx[0]);
6791 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
6792 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
6793 expect_payment_failed!(nodes[0], dust_hash, false);
6795 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS - ANTI_REORG_DELAY);
6796 check_closed_broadcast!(nodes[0], true);
6797 check_added_monitors!(nodes[0], 1);
6798 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6799 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
6800 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
6801 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
6802 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6803 mine_transaction(&nodes[0], &timeout_tx[0]);
6804 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
6805 expect_payment_failed!(nodes[0], non_dust_hash, false);
6807 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
6808 mine_transaction(&nodes[0], &bs_commitment_tx[0]);
6809 check_closed_broadcast!(nodes[0], true);
6810 check_added_monitors!(nodes[0], 1);
6811 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
6812 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6814 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
6815 timeout_tx = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().drain(..)
6816 .filter(|tx| tx.input[0].previous_output.txid == bs_commitment_tx[0].txid()).collect();
6817 check_spends!(timeout_tx[0], bs_commitment_tx[0]);
6818 // For both a revoked or non-revoked commitment transaction, after ANTI_REORG_DELAY the
6819 // dust HTLC should have been failed.
6820 expect_payment_failed!(nodes[0], dust_hash, false);
6823 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
6825 assert_eq!(timeout_tx[0].lock_time.0, 0);
6827 // We fail non-dust-HTLC 2 by broadcast of local timeout/revocation-claim tx
6828 mine_transaction(&nodes[0], &timeout_tx[0]);
6829 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6830 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
6831 expect_payment_failed!(nodes[0], non_dust_hash, false);
6836 fn test_sweep_outbound_htlc_failure_update() {
6837 do_test_sweep_outbound_htlc_failure_update(false, true);
6838 do_test_sweep_outbound_htlc_failure_update(false, false);
6839 do_test_sweep_outbound_htlc_failure_update(true, false);
6843 fn test_user_configurable_csv_delay() {
6844 // We test our channel constructors yield errors when we pass them absurd csv delay
6846 let mut low_our_to_self_config = UserConfig::default();
6847 low_our_to_self_config.channel_handshake_config.our_to_self_delay = 6;
6848 let mut high_their_to_self_config = UserConfig::default();
6849 high_their_to_self_config.channel_handshake_limits.their_to_self_delay = 100;
6850 let user_cfgs = [Some(high_their_to_self_config.clone()), None];
6851 let chanmon_cfgs = create_chanmon_cfgs(2);
6852 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6853 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
6854 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6856 // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
6857 if let Err(error) = Channel::new_outbound(&LowerBoundedFeeEstimator::new(&test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) }),
6858 &nodes[0].keys_manager, &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), &nodes[1].node.init_features(), 1000000, 1000000, 0,
6859 &low_our_to_self_config, 0, 42)
6862 APIError::APIMisuseError { err } => { assert!(regex::Regex::new(r"Configured with an unreasonable our_to_self_delay \(\d+\) putting user funds at risks").unwrap().is_match(err.as_str())); },
6863 _ => panic!("Unexpected event"),
6865 } else { assert!(false) }
6867 // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
6868 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
6869 let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
6870 open_channel.to_self_delay = 200;
6871 if let Err(error) = Channel::new_from_req(&LowerBoundedFeeEstimator::new(&test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) }),
6872 &nodes[0].keys_manager, &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), &nodes[0].node.channel_type_features(), &nodes[1].node.init_features(), &open_channel, 0,
6873 &low_our_to_self_config, 0, &nodes[0].logger, 42)
6876 ChannelError::Close(err) => { assert!(regex::Regex::new(r"Configured with an unreasonable our_to_self_delay \(\d+\) putting user funds at risks").unwrap().is_match(err.as_str())); },
6877 _ => panic!("Unexpected event"),
6879 } else { assert!(false); }
6881 // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
6882 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
6883 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id()));
6884 let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
6885 accept_channel.to_self_delay = 200;
6886 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
6888 if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
6890 &ErrorAction::SendErrorMessage { ref msg } => {
6891 assert!(regex::Regex::new(r"They wanted our payments to be delayed by a needlessly long period\. Upper limit: \d+\. Actual: \d+").unwrap().is_match(msg.data.as_str()));
6892 reason_msg = msg.data.clone();
6896 } else { panic!(); }
6897 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: reason_msg });
6899 // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
6900 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
6901 let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
6902 open_channel.to_self_delay = 200;
6903 if let Err(error) = Channel::new_from_req(&LowerBoundedFeeEstimator::new(&test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) }),
6904 &nodes[0].keys_manager, &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), &nodes[0].node.channel_type_features(), &nodes[1].node.init_features(), &open_channel, 0,
6905 &high_their_to_self_config, 0, &nodes[0].logger, 42)
6908 ChannelError::Close(err) => { assert!(regex::Regex::new(r"They wanted our payments to be delayed by a needlessly long period\. Upper limit: \d+\. Actual: \d+").unwrap().is_match(err.as_str())); },
6909 _ => panic!("Unexpected event"),
6911 } else { assert!(false); }
6915 fn test_check_htlc_underpaying() {
6916 // Send payment through A -> B but A is maliciously
6917 // sending a probe payment (i.e less than expected value0
6918 // to B, B should refuse payment.
6920 let chanmon_cfgs = create_chanmon_cfgs(2);
6921 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6922 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6923 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6925 // Create some initial channels
6926 create_announced_chan_between_nodes(&nodes, 0, 1);
6928 let scorer = test_utils::TestScorer::with_penalty(0);
6929 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
6930 let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id()).with_features(nodes[1].node.invoice_features());
6931 let route = get_route(&nodes[0].node.get_our_node_id(), &payment_params, &nodes[0].network_graph.read_only(), None, 10_000, TEST_FINAL_CLTV, nodes[0].logger, &scorer, &random_seed_bytes).unwrap();
6932 let (_, our_payment_hash, _) = get_payment_preimage_hash!(nodes[0]);
6933 let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(our_payment_hash, Some(100_000), 7200, None).unwrap();
6934 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6935 check_added_monitors!(nodes[0], 1);
6937 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6938 assert_eq!(events.len(), 1);
6939 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
6940 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6941 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6943 // Note that we first have to wait a random delay before processing the receipt of the HTLC,
6944 // and then will wait a second random delay before failing the HTLC back:
6945 expect_pending_htlcs_forwardable!(nodes[1]);
6946 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: our_payment_hash }]);
6948 // Node 3 is expecting payment of 100_000 but received 10_000,
6949 // it should fail htlc like we didn't know the preimage.
6950 nodes[1].node.process_pending_htlc_forwards();
6952 let events = nodes[1].node.get_and_clear_pending_msg_events();
6953 assert_eq!(events.len(), 1);
6954 let (update_fail_htlc, commitment_signed) = match events[0] {
6955 MessageSendEvent::UpdateHTLCs { 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 } } => {
6956 assert!(update_add_htlcs.is_empty());
6957 assert!(update_fulfill_htlcs.is_empty());
6958 assert_eq!(update_fail_htlcs.len(), 1);
6959 assert!(update_fail_malformed_htlcs.is_empty());
6960 assert!(update_fee.is_none());
6961 (update_fail_htlcs[0].clone(), commitment_signed)
6963 _ => panic!("Unexpected event"),
6965 check_added_monitors!(nodes[1], 1);
6967 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
6968 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
6970 // 10_000 msat as u64, followed by a height of CHAN_CONFIRM_DEPTH as u32
6971 let mut expected_failure_data = (10_000 as u64).to_be_bytes().to_vec();
6972 expected_failure_data.extend_from_slice(&CHAN_CONFIRM_DEPTH.to_be_bytes());
6973 expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000|15, &expected_failure_data[..]);
6977 fn test_announce_disable_channels() {
6978 // Create 2 channels between A and B. Disconnect B. Call timer_tick_occurred and check for generated
6979 // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
6981 let chanmon_cfgs = create_chanmon_cfgs(2);
6982 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6983 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6984 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6986 create_announced_chan_between_nodes(&nodes, 0, 1);
6987 create_announced_chan_between_nodes(&nodes, 1, 0);
6988 create_announced_chan_between_nodes(&nodes, 0, 1);
6991 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6992 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6994 nodes[0].node.timer_tick_occurred(); // Enabled -> DisabledStaged
6995 nodes[0].node.timer_tick_occurred(); // DisabledStaged -> Disabled
6996 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
6997 assert_eq!(msg_events.len(), 3);
6998 let mut chans_disabled = HashMap::new();
6999 for e in msg_events {
7001 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7002 assert_eq!(msg.contents.flags & (1<<1), 1<<1); // The "channel disabled" bit should be set
7003 // Check that each channel gets updated exactly once
7004 if chans_disabled.insert(msg.contents.short_channel_id, msg.contents.timestamp).is_some() {
7005 panic!("Generated ChannelUpdate for wrong chan!");
7008 _ => panic!("Unexpected event"),
7012 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: nodes[1].node.init_features(), remote_network_address: None }).unwrap();
7013 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7014 assert_eq!(reestablish_1.len(), 3);
7015 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: nodes[0].node.init_features(), remote_network_address: None }).unwrap();
7016 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7017 assert_eq!(reestablish_2.len(), 3);
7019 // Reestablish chan_1
7020 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7021 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7022 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7023 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7024 // Reestablish chan_2
7025 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
7026 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7027 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
7028 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7029 // Reestablish chan_3
7030 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
7031 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7032 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
7033 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7035 nodes[0].node.timer_tick_occurred();
7036 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7037 nodes[0].node.timer_tick_occurred();
7038 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7039 assert_eq!(msg_events.len(), 3);
7040 for e in msg_events {
7042 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7043 assert_eq!(msg.contents.flags & (1<<1), 0); // The "channel disabled" bit should be off
7044 match chans_disabled.remove(&msg.contents.short_channel_id) {
7045 // Each update should have a higher timestamp than the previous one, replacing
7047 Some(prev_timestamp) => assert!(msg.contents.timestamp > prev_timestamp),
7048 None => panic!("Generated ChannelUpdate for wrong chan!"),
7051 _ => panic!("Unexpected event"),
7054 // Check that each channel gets updated exactly once
7055 assert!(chans_disabled.is_empty());
7059 fn test_bump_penalty_txn_on_revoked_commitment() {
7060 // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
7061 // we're able to claim outputs on revoked commitment transaction before timelocks expiration
7063 let chanmon_cfgs = create_chanmon_cfgs(2);
7064 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7065 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7066 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7068 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000);
7070 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7071 let payment_params = PaymentParameters::from_node_id(nodes[0].node.get_our_node_id())
7072 .with_features(nodes[0].node.invoice_features());
7073 let (route,_, _, _) = get_route_and_payment_hash!(nodes[1], nodes[0], payment_params, 3000000, 30);
7074 send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
7076 let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
7077 // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7078 assert_eq!(revoked_txn[0].output.len(), 4);
7079 assert_eq!(revoked_txn[0].input.len(), 1);
7080 assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
7081 let revoked_txid = revoked_txn[0].txid();
7083 let mut penalty_sum = 0;
7084 for outp in revoked_txn[0].output.iter() {
7085 if outp.script_pubkey.is_v0_p2wsh() {
7086 penalty_sum += outp.value;
7090 // Connect blocks to change height_timer range to see if we use right soonest_timelock
7091 let header_114 = connect_blocks(&nodes[1], 14);
7093 // Actually revoke tx by claiming a HTLC
7094 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7095 let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
7096 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_txn[0].clone()] });
7097 check_added_monitors!(nodes[1], 1);
7099 // One or more justice tx should have been broadcast, check it
7103 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7104 assert_eq!(node_txn.len(), 1); // justice tx (broadcasted from ChannelMonitor)
7105 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7106 assert_eq!(node_txn[0].output.len(), 1);
7107 check_spends!(node_txn[0], revoked_txn[0]);
7108 let fee_1 = penalty_sum - node_txn[0].output[0].value;
7109 feerate_1 = fee_1 * 1000 / node_txn[0].weight() as u64;
7110 penalty_1 = node_txn[0].txid();
7114 // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
7115 connect_blocks(&nodes[1], 15);
7116 let mut penalty_2 = penalty_1;
7117 let mut feerate_2 = 0;
7119 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7120 assert_eq!(node_txn.len(), 1);
7121 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7122 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7123 assert_eq!(node_txn[0].output.len(), 1);
7124 check_spends!(node_txn[0], revoked_txn[0]);
7125 penalty_2 = node_txn[0].txid();
7126 // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7127 assert_ne!(penalty_2, penalty_1);
7128 let fee_2 = penalty_sum - node_txn[0].output[0].value;
7129 feerate_2 = fee_2 * 1000 / node_txn[0].weight() as u64;
7130 // Verify 25% bump heuristic
7131 assert!(feerate_2 * 100 >= feerate_1 * 125);
7135 assert_ne!(feerate_2, 0);
7137 // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
7138 connect_blocks(&nodes[1], 1);
7140 let mut feerate_3 = 0;
7142 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7143 assert_eq!(node_txn.len(), 1);
7144 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7145 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7146 assert_eq!(node_txn[0].output.len(), 1);
7147 check_spends!(node_txn[0], revoked_txn[0]);
7148 penalty_3 = node_txn[0].txid();
7149 // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7150 assert_ne!(penalty_3, penalty_2);
7151 let fee_3 = penalty_sum - node_txn[0].output[0].value;
7152 feerate_3 = fee_3 * 1000 / node_txn[0].weight() as u64;
7153 // Verify 25% bump heuristic
7154 assert!(feerate_3 * 100 >= feerate_2 * 125);
7158 assert_ne!(feerate_3, 0);
7160 nodes[1].node.get_and_clear_pending_events();
7161 nodes[1].node.get_and_clear_pending_msg_events();
7165 fn test_bump_penalty_txn_on_revoked_htlcs() {
7166 // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
7167 // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
7169 let mut chanmon_cfgs = create_chanmon_cfgs(2);
7170 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
7171 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7172 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7173 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7175 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000);
7176 // Lock HTLC in both directions (using a slightly lower CLTV delay to provide timely RBF bumps)
7177 let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id()).with_features(nodes[1].node.invoice_features());
7178 let scorer = test_utils::TestScorer::with_penalty(0);
7179 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
7180 let route = get_route(&nodes[0].node.get_our_node_id(), &payment_params, &nodes[0].network_graph.read_only(), None,
7181 3_000_000, 50, nodes[0].logger, &scorer, &random_seed_bytes).unwrap();
7182 let payment_preimage = send_along_route(&nodes[0], route, &[&nodes[1]], 3_000_000).0;
7183 let payment_params = PaymentParameters::from_node_id(nodes[0].node.get_our_node_id()).with_features(nodes[0].node.invoice_features());
7184 let route = get_route(&nodes[1].node.get_our_node_id(), &payment_params, &nodes[1].network_graph.read_only(), None,
7185 3_000_000, 50, nodes[0].logger, &scorer, &random_seed_bytes).unwrap();
7186 send_along_route(&nodes[1], route, &[&nodes[0]], 3_000_000);
7188 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7189 assert_eq!(revoked_local_txn[0].input.len(), 1);
7190 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7192 // Revoke local commitment tx
7193 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7195 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
7196 // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
7197 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] });
7198 check_closed_broadcast!(nodes[1], true);
7199 check_added_monitors!(nodes[1], 1);
7200 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
7201 connect_blocks(&nodes[1], 49); // Confirm blocks until the HTLC expires (note CLTV was explicitly 50 above)
7203 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
7204 assert_eq!(revoked_htlc_txn.len(), 2);
7206 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7207 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7208 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7210 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7211 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7212 assert_eq!(revoked_htlc_txn[1].output.len(), 1);
7213 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7215 // Broadcast set of revoked txn on A
7216 let hash_128 = connect_blocks(&nodes[0], 40);
7217 let header_11 = BlockHeader { version: 0x20000000, prev_blockhash: hash_128, merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
7218 connect_block(&nodes[0], &Block { header: header_11, txdata: vec![revoked_local_txn[0].clone()] });
7219 let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_11.block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
7220 connect_block(&nodes[0], &Block { header: header_129, txdata: vec![revoked_htlc_txn[0].clone(), revoked_htlc_txn[1].clone()] });
7221 let events = nodes[0].node.get_and_clear_pending_events();
7222 expect_pending_htlcs_forwardable_from_events!(nodes[0], events[0..1], true);
7223 match events.last().unwrap() {
7224 Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => {}
7225 _ => panic!("Unexpected event"),
7231 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7232 assert_eq!(node_txn.len(), 4); // 3 penalty txn on revoked commitment tx + 1 penalty tnx on revoked HTLC txn
7233 // Verify claim tx are spending revoked HTLC txn
7235 // node_txn 0-2 each spend a separate revoked output from revoked_local_txn[0]
7236 // Note that node_txn[0] and node_txn[1] are bogus - they double spend the revoked_htlc_txn
7237 // which are included in the same block (they are broadcasted because we scan the
7238 // transactions linearly and generate claims as we go, they likely should be removed in the
7240 assert_eq!(node_txn[0].input.len(), 1);
7241 check_spends!(node_txn[0], revoked_local_txn[0]);
7242 assert_eq!(node_txn[1].input.len(), 1);
7243 check_spends!(node_txn[1], revoked_local_txn[0]);
7244 assert_eq!(node_txn[2].input.len(), 1);
7245 check_spends!(node_txn[2], revoked_local_txn[0]);
7247 // Each of the three justice transactions claim a separate (single) output of the three
7248 // available, which we check here:
7249 assert_ne!(node_txn[0].input[0].previous_output, node_txn[1].input[0].previous_output);
7250 assert_ne!(node_txn[0].input[0].previous_output, node_txn[2].input[0].previous_output);
7251 assert_ne!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
7253 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
7254 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
7256 // node_txn[3] spends the revoked outputs from the revoked_htlc_txn (which only have one
7257 // output, checked above).
7258 assert_eq!(node_txn[3].input.len(), 2);
7259 assert_eq!(node_txn[3].output.len(), 1);
7260 check_spends!(node_txn[3], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7262 first = node_txn[3].txid();
7263 // Store both feerates for later comparison
7264 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[3].output[0].value;
7265 feerate_1 = fee_1 * 1000 / node_txn[3].weight() as u64;
7266 penalty_txn = vec![node_txn[2].clone()];
7270 // Connect one more block to see if bumped penalty are issued for HTLC txn
7271 let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
7272 connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
7273 let header_131 = BlockHeader { version: 0x20000000, prev_blockhash: header_130.block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
7274 connect_block(&nodes[0], &Block { header: header_131, txdata: Vec::new() });
7276 // Few more blocks to confirm penalty txn
7277 connect_blocks(&nodes[0], 4);
7278 assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
7279 let header_144 = connect_blocks(&nodes[0], 9);
7281 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7282 assert_eq!(node_txn.len(), 1);
7284 assert_eq!(node_txn[0].input.len(), 2);
7285 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7286 // Verify bumped tx is different and 25% bump heuristic
7287 assert_ne!(first, node_txn[0].txid());
7288 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[0].output[0].value;
7289 let feerate_2 = fee_2 * 1000 / node_txn[0].weight() as u64;
7290 assert!(feerate_2 * 100 > feerate_1 * 125);
7291 let txn = vec![node_txn[0].clone()];
7295 // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
7296 let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
7297 connect_block(&nodes[0], &Block { header: header_145, txdata: node_txn });
7298 connect_blocks(&nodes[0], 20);
7300 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7301 // We verify than no new transaction has been broadcast because previously
7302 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
7303 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
7304 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
7305 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
7306 // up bumped justice generation.
7307 assert_eq!(node_txn.len(), 0);
7310 check_closed_broadcast!(nodes[0], true);
7311 check_added_monitors!(nodes[0], 1);
7315 fn test_bump_penalty_txn_on_remote_commitment() {
7316 // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
7317 // we're able to claim outputs on remote commitment transaction before timelocks expiration
7320 // Provide preimage for one
7321 // Check aggregation
7323 let chanmon_cfgs = create_chanmon_cfgs(2);
7324 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7325 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7326 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7328 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000);
7329 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 3_000_000);
7330 route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
7332 // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7333 let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
7334 assert_eq!(remote_txn[0].output.len(), 4);
7335 assert_eq!(remote_txn[0].input.len(), 1);
7336 assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
7338 // Claim a HTLC without revocation (provide B monitor with preimage)
7339 nodes[1].node.claim_funds(payment_preimage);
7340 expect_payment_claimed!(nodes[1], payment_hash, 3_000_000);
7341 mine_transaction(&nodes[1], &remote_txn[0]);
7342 check_added_monitors!(nodes[1], 2);
7343 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
7345 // One or more claim tx should have been broadcast, check it
7349 let feerate_timeout;
7350 let feerate_preimage;
7352 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7353 // 3 transactions including:
7354 // preimage and timeout sweeps from remote commitment + preimage sweep bump
7355 assert_eq!(node_txn.len(), 3);
7356 assert_eq!(node_txn[0].input.len(), 1);
7357 assert_eq!(node_txn[1].input.len(), 1);
7358 assert_eq!(node_txn[2].input.len(), 1);
7359 check_spends!(node_txn[0], remote_txn[0]);
7360 check_spends!(node_txn[1], remote_txn[0]);
7361 check_spends!(node_txn[2], remote_txn[0]);
7363 preimage = node_txn[0].txid();
7364 let index = node_txn[0].input[0].previous_output.vout;
7365 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7366 feerate_preimage = fee * 1000 / node_txn[0].weight() as u64;
7368 let (preimage_bump_tx, timeout_tx) = if node_txn[2].input[0].previous_output == node_txn[0].input[0].previous_output {
7369 (node_txn[2].clone(), node_txn[1].clone())
7371 (node_txn[1].clone(), node_txn[2].clone())
7374 preimage_bump = preimage_bump_tx;
7375 check_spends!(preimage_bump, remote_txn[0]);
7376 assert_eq!(node_txn[0].input[0].previous_output, preimage_bump.input[0].previous_output);
7378 timeout = timeout_tx.txid();
7379 let index = timeout_tx.input[0].previous_output.vout;
7380 let fee = remote_txn[0].output[index as usize].value - timeout_tx.output[0].value;
7381 feerate_timeout = fee * 1000 / timeout_tx.weight() as u64;
7385 assert_ne!(feerate_timeout, 0);
7386 assert_ne!(feerate_preimage, 0);
7388 // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
7389 connect_blocks(&nodes[1], 15);
7391 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7392 assert_eq!(node_txn.len(), 1);
7393 assert_eq!(node_txn[0].input.len(), 1);
7394 assert_eq!(preimage_bump.input.len(), 1);
7395 check_spends!(node_txn[0], remote_txn[0]);
7396 check_spends!(preimage_bump, remote_txn[0]);
7398 let index = preimage_bump.input[0].previous_output.vout;
7399 let fee = remote_txn[0].output[index as usize].value - preimage_bump.output[0].value;
7400 let new_feerate = fee * 1000 / preimage_bump.weight() as u64;
7401 assert!(new_feerate * 100 > feerate_timeout * 125);
7402 assert_ne!(timeout, preimage_bump.txid());
7404 let index = node_txn[0].input[0].previous_output.vout;
7405 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7406 let new_feerate = fee * 1000 / node_txn[0].weight() as u64;
7407 assert!(new_feerate * 100 > feerate_preimage * 125);
7408 assert_ne!(preimage, node_txn[0].txid());
7413 nodes[1].node.get_and_clear_pending_events();
7414 nodes[1].node.get_and_clear_pending_msg_events();
7418 fn test_counterparty_raa_skip_no_crash() {
7419 // Previously, if our counterparty sent two RAAs in a row without us having provided a
7420 // commitment transaction, we would have happily carried on and provided them the next
7421 // commitment transaction based on one RAA forward. This would probably eventually have led to
7422 // channel closure, but it would not have resulted in funds loss. Still, our
7423 // EnforcingSigner would have panicked as it doesn't like jumps into the future. Here, we
7424 // check simply that the channel is closed in response to such an RAA, but don't check whether
7425 // we decide to punish our counterparty for revoking their funds (as we don't currently
7427 let chanmon_cfgs = create_chanmon_cfgs(2);
7428 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7429 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7430 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7431 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
7433 let per_commitment_secret;
7434 let next_per_commitment_point;
7436 let per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
7437 let mut guard = per_peer_state.get(&nodes[1].node.get_our_node_id()).unwrap().lock().unwrap();
7438 let keys = guard.channel_by_id.get_mut(&channel_id).unwrap().get_signer();
7440 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
7442 // Make signer believe we got a counterparty signature, so that it allows the revocation
7443 keys.get_enforcement_state().last_holder_commitment -= 1;
7444 per_commitment_secret = keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER);
7446 // Must revoke without gaps
7447 keys.get_enforcement_state().last_holder_commitment -= 1;
7448 keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 1);
7450 keys.get_enforcement_state().last_holder_commitment -= 1;
7451 next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
7452 &SecretKey::from_slice(&keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
7455 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
7456 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
7457 assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
7458 check_added_monitors!(nodes[1], 1);
7459 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "Received an unexpected revoke_and_ack".to_string() });
7463 fn test_bump_txn_sanitize_tracking_maps() {
7464 // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
7465 // verify we clean then right after expiration of ANTI_REORG_DELAY.
7467 let chanmon_cfgs = create_chanmon_cfgs(2);
7468 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7469 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7470 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7472 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000);
7473 // Lock HTLC in both directions
7474 let (payment_preimage_1, _, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000);
7475 let (_, payment_hash_2, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000);
7477 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7478 assert_eq!(revoked_local_txn[0].input.len(), 1);
7479 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7481 // Revoke local commitment tx
7482 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
7484 // Broadcast set of revoked txn on A
7485 connect_blocks(&nodes[0], TEST_FINAL_CLTV + 2 - CHAN_CONFIRM_DEPTH);
7486 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[0], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash_2 }]);
7487 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 0);
7489 mine_transaction(&nodes[0], &revoked_local_txn[0]);
7490 check_closed_broadcast!(nodes[0], true);
7491 check_added_monitors!(nodes[0], 1);
7492 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
7494 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7495 assert_eq!(node_txn.len(), 3); //ChannelMonitor: justice txn * 3
7496 check_spends!(node_txn[0], revoked_local_txn[0]);
7497 check_spends!(node_txn[1], revoked_local_txn[0]);
7498 check_spends!(node_txn[2], revoked_local_txn[0]);
7499 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
7503 let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
7504 connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
7505 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7507 let monitor = nodes[0].chain_monitor.chain_monitor.get_monitor(OutPoint { txid: chan.3.txid(), index: 0 }).unwrap();
7508 assert!(monitor.inner.lock().unwrap().onchain_tx_handler.pending_claim_requests.is_empty());
7509 assert!(monitor.inner.lock().unwrap().onchain_tx_handler.claimable_outpoints.is_empty());
7514 fn test_pending_claimed_htlc_no_balance_underflow() {
7515 // Tests that if we have a pending outbound HTLC as well as a claimed-but-not-fully-removed
7516 // HTLC we will not underflow when we call `Channel::get_balance_msat()`.
7517 let chanmon_cfgs = create_chanmon_cfgs(2);
7518 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7519 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7520 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7521 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, 0);
7523 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 1_010_000);
7524 nodes[1].node.claim_funds(payment_preimage);
7525 expect_payment_claimed!(nodes[1], payment_hash, 1_010_000);
7526 check_added_monitors!(nodes[1], 1);
7527 let fulfill_ev = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7529 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &fulfill_ev.update_fulfill_htlcs[0]);
7530 expect_payment_sent_without_paths!(nodes[0], payment_preimage);
7531 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &fulfill_ev.commitment_signed);
7532 check_added_monitors!(nodes[0], 1);
7533 let (_raa, _cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7535 // At this point nodes[1] has received 1,010k msat (10k msat more than their reserve) and can
7536 // send an HTLC back (though it will go in the holding cell). Send an HTLC back and check we
7537 // can get our balance.
7539 // Get a route from nodes[1] to nodes[0] by getting a route going the other way and then flip
7540 // the public key of the only hop. This works around ChannelDetails not showing the
7541 // almost-claimed HTLC as available balance.
7542 let (mut route, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[1], 10_000);
7543 route.payment_params = None; // This is all wrong, but unnecessary
7544 route.paths[0][0].pubkey = nodes[0].node.get_our_node_id();
7545 let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[0]);
7546 nodes[1].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
7548 assert_eq!(nodes[1].node.list_channels()[0].balance_msat, 1_000_000);
7552 fn test_channel_conf_timeout() {
7553 // Tests that, for inbound channels, we give up on them if the funding transaction does not
7554 // confirm within 2016 blocks, as recommended by BOLT 2.
7555 let chanmon_cfgs = create_chanmon_cfgs(2);
7556 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7557 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7558 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7560 let _funding_tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 1_000_000, 100_000);
7562 // The outbound node should wait forever for confirmation:
7563 // This matches `channel::FUNDING_CONF_DEADLINE_BLOCKS` and BOLT 2's suggested timeout, thus is
7564 // copied here instead of directly referencing the constant.
7565 connect_blocks(&nodes[0], 2016);
7566 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7568 // The inbound node should fail the channel after exactly 2016 blocks
7569 connect_blocks(&nodes[1], 2015);
7570 check_added_monitors!(nodes[1], 0);
7571 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7573 connect_blocks(&nodes[1], 1);
7574 check_added_monitors!(nodes[1], 1);
7575 check_closed_event!(nodes[1], 1, ClosureReason::FundingTimedOut);
7576 let close_ev = nodes[1].node.get_and_clear_pending_msg_events();
7577 assert_eq!(close_ev.len(), 1);
7579 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, ref node_id } => {
7580 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
7581 assert_eq!(msg.data, "Channel closed because funding transaction failed to confirm within 2016 blocks");
7583 _ => panic!("Unexpected event"),
7588 fn test_override_channel_config() {
7589 let chanmon_cfgs = create_chanmon_cfgs(2);
7590 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7591 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7592 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7594 // Node0 initiates a channel to node1 using the override config.
7595 let mut override_config = UserConfig::default();
7596 override_config.channel_handshake_config.our_to_self_delay = 200;
7598 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
7600 // Assert the channel created by node0 is using the override config.
7601 let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7602 assert_eq!(res.channel_flags, 0);
7603 assert_eq!(res.to_self_delay, 200);
7607 fn test_override_0msat_htlc_minimum() {
7608 let mut zero_config = UserConfig::default();
7609 zero_config.channel_handshake_config.our_htlc_minimum_msat = 0;
7610 let chanmon_cfgs = create_chanmon_cfgs(2);
7611 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7612 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
7613 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7615 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
7616 let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7617 assert_eq!(res.htlc_minimum_msat, 1);
7619 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &res);
7620 let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7621 assert_eq!(res.htlc_minimum_msat, 1);
7625 fn test_channel_update_has_correct_htlc_maximum_msat() {
7626 // Tests that the `ChannelUpdate` message has the correct values for `htlc_maximum_msat` set.
7627 // Bolt 7 specifies that if present `htlc_maximum_msat`:
7628 // 1. MUST be set to less than or equal to the channel capacity. In LDK, this is capped to
7629 // 90% of the `channel_value`.
7630 // 2. MUST be set to less than or equal to the `max_htlc_value_in_flight_msat` received from the peer.
7632 let mut config_30_percent = UserConfig::default();
7633 config_30_percent.channel_handshake_config.announced_channel = true;
7634 config_30_percent.channel_handshake_config.max_inbound_htlc_value_in_flight_percent_of_channel = 30;
7635 let mut config_50_percent = UserConfig::default();
7636 config_50_percent.channel_handshake_config.announced_channel = true;
7637 config_50_percent.channel_handshake_config.max_inbound_htlc_value_in_flight_percent_of_channel = 50;
7638 let mut config_95_percent = UserConfig::default();
7639 config_95_percent.channel_handshake_config.announced_channel = true;
7640 config_95_percent.channel_handshake_config.max_inbound_htlc_value_in_flight_percent_of_channel = 95;
7641 let mut config_100_percent = UserConfig::default();
7642 config_100_percent.channel_handshake_config.announced_channel = true;
7643 config_100_percent.channel_handshake_config.max_inbound_htlc_value_in_flight_percent_of_channel = 100;
7645 let chanmon_cfgs = create_chanmon_cfgs(4);
7646 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
7647 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[Some(config_30_percent), Some(config_50_percent), Some(config_95_percent), Some(config_100_percent)]);
7648 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
7650 let channel_value_satoshis = 100000;
7651 let channel_value_msat = channel_value_satoshis * 1000;
7652 let channel_value_30_percent_msat = (channel_value_msat as f64 * 0.3) as u64;
7653 let channel_value_50_percent_msat = (channel_value_msat as f64 * 0.5) as u64;
7654 let channel_value_90_percent_msat = (channel_value_msat as f64 * 0.9) as u64;
7656 let (node_0_chan_update, node_1_chan_update, _, _) = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value_satoshis, 10001);
7657 let (node_2_chan_update, node_3_chan_update, _, _) = create_announced_chan_between_nodes_with_value(&nodes, 2, 3, channel_value_satoshis, 10001);
7659 // Assert that `node[0]`'s `ChannelUpdate` is capped at 50 percent of the `channel_value`, as
7660 // that's the value of `node[1]`'s `holder_max_htlc_value_in_flight_msat`.
7661 assert_eq!(node_0_chan_update.contents.htlc_maximum_msat, channel_value_50_percent_msat);
7662 // Assert that `node[1]`'s `ChannelUpdate` is capped at 30 percent of the `channel_value`, as
7663 // that's the value of `node[0]`'s `holder_max_htlc_value_in_flight_msat`.
7664 assert_eq!(node_1_chan_update.contents.htlc_maximum_msat, channel_value_30_percent_msat);
7666 // Assert that `node[2]`'s `ChannelUpdate` is capped at 90 percent of the `channel_value`, as
7667 // the value of `node[3]`'s `holder_max_htlc_value_in_flight_msat` (100%), exceeds 90% of the
7669 assert_eq!(node_2_chan_update.contents.htlc_maximum_msat, channel_value_90_percent_msat);
7670 // Assert that `node[3]`'s `ChannelUpdate` is capped at 90 percent of the `channel_value`, as
7671 // the value of `node[2]`'s `holder_max_htlc_value_in_flight_msat` (95%), exceeds 90% of the
7673 assert_eq!(node_3_chan_update.contents.htlc_maximum_msat, channel_value_90_percent_msat);
7677 fn test_manually_accept_inbound_channel_request() {
7678 let mut manually_accept_conf = UserConfig::default();
7679 manually_accept_conf.manually_accept_inbound_channels = true;
7680 let chanmon_cfgs = create_chanmon_cfgs(2);
7681 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7682 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(manually_accept_conf.clone())]);
7683 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7685 let temp_channel_id = nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, Some(manually_accept_conf)).unwrap();
7686 let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7688 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &res);
7690 // Assert that `nodes[1]` has no `MessageSendEvent::SendAcceptChannel` in `msg_events` before
7691 // accepting the inbound channel request.
7692 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
7694 let events = nodes[1].node.get_and_clear_pending_events();
7696 Event::OpenChannelRequest { temporary_channel_id, .. } => {
7697 nodes[1].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 23).unwrap();
7699 _ => panic!("Unexpected event"),
7702 let accept_msg_ev = nodes[1].node.get_and_clear_pending_msg_events();
7703 assert_eq!(accept_msg_ev.len(), 1);
7705 match accept_msg_ev[0] {
7706 MessageSendEvent::SendAcceptChannel { ref node_id, .. } => {
7707 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
7709 _ => panic!("Unexpected event"),
7712 nodes[1].node.force_close_broadcasting_latest_txn(&temp_channel_id, &nodes[0].node.get_our_node_id()).unwrap();
7714 let close_msg_ev = nodes[1].node.get_and_clear_pending_msg_events();
7715 assert_eq!(close_msg_ev.len(), 1);
7717 let events = nodes[1].node.get_and_clear_pending_events();
7719 Event::ChannelClosed { user_channel_id, .. } => {
7720 assert_eq!(user_channel_id, 23);
7722 _ => panic!("Unexpected event"),
7727 fn test_manually_reject_inbound_channel_request() {
7728 let mut manually_accept_conf = UserConfig::default();
7729 manually_accept_conf.manually_accept_inbound_channels = true;
7730 let chanmon_cfgs = create_chanmon_cfgs(2);
7731 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7732 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(manually_accept_conf.clone())]);
7733 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7735 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, Some(manually_accept_conf)).unwrap();
7736 let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7738 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &res);
7740 // Assert that `nodes[1]` has no `MessageSendEvent::SendAcceptChannel` in `msg_events` before
7741 // rejecting the inbound channel request.
7742 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
7744 let events = nodes[1].node.get_and_clear_pending_events();
7746 Event::OpenChannelRequest { temporary_channel_id, .. } => {
7747 nodes[1].node.force_close_broadcasting_latest_txn(&temporary_channel_id, &nodes[0].node.get_our_node_id()).unwrap();
7749 _ => panic!("Unexpected event"),
7752 let close_msg_ev = nodes[1].node.get_and_clear_pending_msg_events();
7753 assert_eq!(close_msg_ev.len(), 1);
7755 match close_msg_ev[0] {
7756 MessageSendEvent::HandleError { ref node_id, .. } => {
7757 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
7759 _ => panic!("Unexpected event"),
7761 check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed);
7765 fn test_reject_funding_before_inbound_channel_accepted() {
7766 // This tests that when `UserConfig::manually_accept_inbound_channels` is set to true, inbound
7767 // channels must to be manually accepted through `ChannelManager::accept_inbound_channel` by
7768 // the node operator before the counterparty sends a `FundingCreated` message. If a
7769 // `FundingCreated` message is received before the channel is accepted, it should be rejected
7770 // and the channel should be closed.
7771 let mut manually_accept_conf = UserConfig::default();
7772 manually_accept_conf.manually_accept_inbound_channels = true;
7773 let chanmon_cfgs = create_chanmon_cfgs(2);
7774 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7775 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(manually_accept_conf.clone())]);
7776 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7778 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, Some(manually_accept_conf)).unwrap();
7779 let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7780 let temp_channel_id = res.temporary_channel_id;
7782 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &res);
7784 // Assert that `nodes[1]` has no `MessageSendEvent::SendAcceptChannel` in the `msg_events`.
7785 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
7787 // Clear the `Event::OpenChannelRequest` event without responding to the request.
7788 nodes[1].node.get_and_clear_pending_events();
7790 // Get the `AcceptChannel` message of `nodes[1]` without calling
7791 // `ChannelManager::accept_inbound_channel`, which generates a
7792 // `MessageSendEvent::SendAcceptChannel` event. The message is passed to `nodes[0]`
7793 // `handle_accept_channel`, which is required in order for `create_funding_transaction` to
7794 // succeed when `nodes[0]` is passed to it.
7795 let accept_chan_msg = {
7796 let mut node_1_per_peer_lock;
7797 let mut node_1_peer_state_lock;
7798 let channel = get_channel_ref!(&nodes[1], nodes[0], node_1_per_peer_lock, node_1_peer_state_lock, temp_channel_id);
7799 channel.get_accept_channel_message()
7801 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_chan_msg);
7803 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100000, 42);
7805 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).unwrap();
7806 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
7808 // The `funding_created_msg` should be rejected by `nodes[1]` as it hasn't accepted the channel
7809 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
7811 let close_msg_ev = nodes[1].node.get_and_clear_pending_msg_events();
7812 assert_eq!(close_msg_ev.len(), 1);
7814 let expected_err = "FundingCreated message received before the channel was accepted";
7815 match close_msg_ev[0] {
7816 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, ref node_id, } => {
7817 assert_eq!(msg.channel_id, temp_channel_id);
7818 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
7819 assert_eq!(msg.data, expected_err);
7821 _ => panic!("Unexpected event"),
7824 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: expected_err.to_string() });
7828 fn test_can_not_accept_inbound_channel_twice() {
7829 let mut manually_accept_conf = UserConfig::default();
7830 manually_accept_conf.manually_accept_inbound_channels = true;
7831 let chanmon_cfgs = create_chanmon_cfgs(2);
7832 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7833 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(manually_accept_conf.clone())]);
7834 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7836 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, Some(manually_accept_conf)).unwrap();
7837 let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7839 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &res);
7841 // Assert that `nodes[1]` has no `MessageSendEvent::SendAcceptChannel` in `msg_events` before
7842 // accepting the inbound channel request.
7843 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
7845 let events = nodes[1].node.get_and_clear_pending_events();
7847 Event::OpenChannelRequest { temporary_channel_id, .. } => {
7848 nodes[1].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0).unwrap();
7849 let api_res = nodes[1].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0);
7851 Err(APIError::APIMisuseError { err }) => {
7852 assert_eq!(err, "The channel isn't currently awaiting to be accepted.");
7854 Ok(_) => panic!("Channel shouldn't be possible to be accepted twice"),
7855 Err(_) => panic!("Unexpected Error"),
7858 _ => panic!("Unexpected event"),
7861 // Ensure that the channel wasn't closed after attempting to accept it twice.
7862 let accept_msg_ev = nodes[1].node.get_and_clear_pending_msg_events();
7863 assert_eq!(accept_msg_ev.len(), 1);
7865 match accept_msg_ev[0] {
7866 MessageSendEvent::SendAcceptChannel { ref node_id, .. } => {
7867 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
7869 _ => panic!("Unexpected event"),
7874 fn test_can_not_accept_unknown_inbound_channel() {
7875 let chanmon_cfg = create_chanmon_cfgs(2);
7876 let node_cfg = create_node_cfgs(2, &chanmon_cfg);
7877 let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[None, None]);
7878 let nodes = create_network(2, &node_cfg, &node_chanmgr);
7880 let unknown_channel_id = [0; 32];
7881 let api_res = nodes[0].node.accept_inbound_channel(&unknown_channel_id, &nodes[1].node.get_our_node_id(), 0);
7883 Err(APIError::ChannelUnavailable { err }) => {
7884 assert_eq!(err, format!("Channel with id {} not found for the passed counterparty node_id {}", log_bytes!(unknown_channel_id), nodes[1].node.get_our_node_id()));
7886 Ok(_) => panic!("It shouldn't be possible to accept an unkown channel"),
7887 Err(_) => panic!("Unexpected Error"),
7892 fn test_simple_mpp() {
7893 // Simple test of sending a multi-path payment.
7894 let chanmon_cfgs = create_chanmon_cfgs(4);
7895 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
7896 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
7897 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
7899 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1).0.contents.short_channel_id;
7900 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2).0.contents.short_channel_id;
7901 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3).0.contents.short_channel_id;
7902 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3).0.contents.short_channel_id;
7904 let (mut route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
7905 let path = route.paths[0].clone();
7906 route.paths.push(path);
7907 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
7908 route.paths[0][0].short_channel_id = chan_1_id;
7909 route.paths[0][1].short_channel_id = chan_3_id;
7910 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
7911 route.paths[1][0].short_channel_id = chan_2_id;
7912 route.paths[1][1].short_channel_id = chan_4_id;
7913 send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, payment_secret);
7914 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
7918 fn test_preimage_storage() {
7919 // Simple test of payment preimage storage allowing no client-side storage to claim payments
7920 let chanmon_cfgs = create_chanmon_cfgs(2);
7921 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7922 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7923 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7925 create_announced_chan_between_nodes(&nodes, 0, 1).0.contents.short_channel_id;
7928 let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 7200, None).unwrap();
7929 let (route, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[1], 100_000);
7930 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
7931 check_added_monitors!(nodes[0], 1);
7932 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7933 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
7934 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7935 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7937 // Note that after leaving the above scope we have no knowledge of any arguments or return
7938 // values from previous calls.
7939 expect_pending_htlcs_forwardable!(nodes[1]);
7940 let events = nodes[1].node.get_and_clear_pending_events();
7941 assert_eq!(events.len(), 1);
7943 Event::PaymentClaimable { ref purpose, .. } => {
7945 PaymentPurpose::InvoicePayment { payment_preimage, .. } => {
7946 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage.unwrap());
7948 _ => panic!("expected PaymentPurpose::InvoicePayment")
7951 _ => panic!("Unexpected event"),
7956 #[allow(deprecated)]
7957 fn test_secret_timeout() {
7958 // Simple test of payment secret storage time outs. After
7959 // `create_inbound_payment(_for_hash)_legacy` is removed, this test will be removed as well.
7960 let chanmon_cfgs = create_chanmon_cfgs(2);
7961 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7962 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7963 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7965 create_announced_chan_between_nodes(&nodes, 0, 1).0.contents.short_channel_id;
7967 let (payment_hash, payment_secret_1) = nodes[1].node.create_inbound_payment_legacy(Some(100_000), 2).unwrap();
7969 // We should fail to register the same payment hash twice, at least until we've connected a
7970 // block with time 7200 + CHAN_CONFIRM_DEPTH + 1.
7971 if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash_legacy(payment_hash, Some(100_000), 2) {
7972 assert_eq!(err, "Duplicate payment hash");
7973 } else { panic!(); }
7975 let node_1_blocks = nodes[1].blocks.lock().unwrap();
7977 header: BlockHeader {
7979 prev_blockhash: node_1_blocks.last().unwrap().0.block_hash(),
7980 merkle_root: TxMerkleNode::all_zeros(),
7981 time: node_1_blocks.len() as u32 + 7200, bits: 42, nonce: 42 },
7985 connect_block(&nodes[1], &block);
7986 if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash_legacy(payment_hash, Some(100_000), 2) {
7987 assert_eq!(err, "Duplicate payment hash");
7988 } else { panic!(); }
7990 // If we then connect the second block, we should be able to register the same payment hash
7991 // again (this time getting a new payment secret).
7992 block.header.prev_blockhash = block.header.block_hash();
7993 block.header.time += 1;
7994 connect_block(&nodes[1], &block);
7995 let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash_legacy(payment_hash, Some(100_000), 2).unwrap();
7996 assert_ne!(payment_secret_1, our_payment_secret);
7999 let (route, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[1], 100_000);
8000 nodes[0].node.send_payment(&route, payment_hash, &Some(our_payment_secret), PaymentId(payment_hash.0)).unwrap();
8001 check_added_monitors!(nodes[0], 1);
8002 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8003 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8004 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8005 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8007 // Note that after leaving the above scope we have no knowledge of any arguments or return
8008 // values from previous calls.
8009 expect_pending_htlcs_forwardable!(nodes[1]);
8010 let events = nodes[1].node.get_and_clear_pending_events();
8011 assert_eq!(events.len(), 1);
8013 Event::PaymentClaimable { purpose: PaymentPurpose::InvoicePayment { payment_preimage, payment_secret }, .. } => {
8014 assert!(payment_preimage.is_none());
8015 assert_eq!(payment_secret, our_payment_secret);
8016 // We don't actually have the payment preimage with which to claim this payment!
8018 _ => panic!("Unexpected event"),
8023 fn test_bad_secret_hash() {
8024 // Simple test of unregistered payment hash/invalid payment secret handling
8025 let chanmon_cfgs = create_chanmon_cfgs(2);
8026 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8027 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8028 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8030 create_announced_chan_between_nodes(&nodes, 0, 1).0.contents.short_channel_id;
8032 let random_payment_hash = PaymentHash([42; 32]);
8033 let random_payment_secret = PaymentSecret([43; 32]);
8034 let (our_payment_hash, our_payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 2, None).unwrap();
8035 let (route, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[1], 100_000);
8037 // All the below cases should end up being handled exactly identically, so we macro the
8038 // resulting events.
8039 macro_rules! handle_unknown_invalid_payment_data {
8040 ($payment_hash: expr) => {
8041 check_added_monitors!(nodes[0], 1);
8042 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8043 let payment_event = SendEvent::from_event(events.pop().unwrap());
8044 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8045 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8047 // We have to forward pending HTLCs once to process the receipt of the HTLC and then
8048 // again to process the pending backwards-failure of the HTLC
8049 expect_pending_htlcs_forwardable!(nodes[1]);
8050 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment{ payment_hash: $payment_hash }]);
8051 check_added_monitors!(nodes[1], 1);
8053 // We should fail the payment back
8054 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
8055 match events.pop().unwrap() {
8056 MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate { update_fail_htlcs, commitment_signed, .. } } => {
8057 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
8058 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false);
8060 _ => panic!("Unexpected event"),
8065 let expected_error_code = 0x4000|15; // incorrect_or_unknown_payment_details
8066 // Error data is the HTLC value (100,000) and current block height
8067 let expected_error_data = [0, 0, 0, 0, 0, 1, 0x86, 0xa0, 0, 0, 0, CHAN_CONFIRM_DEPTH as u8];
8069 // Send a payment with the right payment hash but the wrong payment secret
8070 nodes[0].node.send_payment(&route, our_payment_hash, &Some(random_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
8071 handle_unknown_invalid_payment_data!(our_payment_hash);
8072 expect_payment_failed!(nodes[0], our_payment_hash, true, expected_error_code, expected_error_data);
8074 // Send a payment with a random payment hash, but the right payment secret
8075 nodes[0].node.send_payment(&route, random_payment_hash, &Some(our_payment_secret), PaymentId(random_payment_hash.0)).unwrap();
8076 handle_unknown_invalid_payment_data!(random_payment_hash);
8077 expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8079 // Send a payment with a random payment hash and random payment secret
8080 nodes[0].node.send_payment(&route, random_payment_hash, &Some(random_payment_secret), PaymentId(random_payment_hash.0)).unwrap();
8081 handle_unknown_invalid_payment_data!(random_payment_hash);
8082 expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8086 fn test_update_err_monitor_lockdown() {
8087 // Our monitor will lock update of local commitment transaction if a broadcastion condition
8088 // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
8089 // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateStatus
8092 // This scenario may happen in a watchtower setup, where watchtower process a block height
8093 // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
8094 // commitment at same time.
8096 let chanmon_cfgs = create_chanmon_cfgs(2);
8097 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8098 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8099 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8101 // Create some initial channel
8102 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
8103 let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8105 // Rebalance the network to generate htlc in the two directions
8106 send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8108 // Route a HTLC from node 0 to node 1 (but don't settle)
8109 let (preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 9_000_000);
8111 // Copy ChainMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
8112 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8113 let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
8114 let persister = test_utils::TestPersister::new();
8116 let monitor = nodes[0].chain_monitor.chain_monitor.get_monitor(outpoint).unwrap();
8117 let mut w = test_utils::TestVecWriter(Vec::new());
8118 monitor.write(&mut w).unwrap();
8119 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8120 &mut io::Cursor::new(&w.0), (nodes[0].keys_manager, nodes[0].keys_manager)).unwrap().1;
8121 assert!(new_monitor == *monitor);
8122 let watchtower = test_utils::TestChainMonitor::new(Some(&chain_source), &chanmon_cfgs[0].tx_broadcaster, &logger, &chanmon_cfgs[0].fee_estimator, &persister, &node_cfgs[0].keys_manager);
8123 assert_eq!(watchtower.watch_channel(outpoint, new_monitor), ChannelMonitorUpdateStatus::Completed);
8126 let header = BlockHeader { version: 0x20000000, prev_blockhash: BlockHash::all_zeros(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
8127 let block = Block { header, txdata: vec![] };
8128 // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8129 // transaction lock time requirements here.
8130 chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize(200, (block.clone(), 0));
8131 watchtower.chain_monitor.block_connected(&block, 200);
8133 // Try to update ChannelMonitor
8134 nodes[1].node.claim_funds(preimage);
8135 check_added_monitors!(nodes[1], 1);
8136 expect_payment_claimed!(nodes[1], payment_hash, 9_000_000);
8138 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8139 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8140 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8142 let mut node_0_per_peer_lock;
8143 let mut node_0_peer_state_lock;
8144 let mut channel = get_channel_ref!(nodes[0], nodes[1], node_0_per_peer_lock, node_0_peer_state_lock, chan_1.2);
8145 if let Ok((_, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].logger) {
8146 assert_eq!(watchtower.chain_monitor.update_channel(outpoint, &update), ChannelMonitorUpdateStatus::PermanentFailure);
8147 assert_eq!(nodes[0].chain_monitor.update_channel(outpoint, &update), ChannelMonitorUpdateStatus::Completed);
8148 } else { assert!(false); }
8150 // Our local monitor is in-sync and hasn't processed yet timeout
8151 check_added_monitors!(nodes[0], 1);
8152 let events = nodes[0].node.get_and_clear_pending_events();
8153 assert_eq!(events.len(), 1);
8157 fn test_concurrent_monitor_claim() {
8158 // Watchtower A receives block, broadcasts state N, then channel receives new state N+1,
8159 // sending it to both watchtowers, Bob accepts N+1, then receives block and broadcasts
8160 // the latest state N+1, Alice rejects state N+1, but Bob has already broadcast it,
8161 // state N+1 confirms. Alice claims output from state N+1.
8163 let chanmon_cfgs = create_chanmon_cfgs(2);
8164 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8165 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8166 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8168 // Create some initial channel
8169 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
8170 let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8172 // Rebalance the network to generate htlc in the two directions
8173 send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8175 // Route a HTLC from node 0 to node 1 (but don't settle)
8176 route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8178 // Copy ChainMonitor to simulate watchtower Alice and update block height her ChannelMonitor timeout HTLC onchain
8179 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8180 let logger = test_utils::TestLogger::with_id(format!("node {}", "Alice"));
8181 let persister = test_utils::TestPersister::new();
8182 let watchtower_alice = {
8183 let monitor = nodes[0].chain_monitor.chain_monitor.get_monitor(outpoint).unwrap();
8184 let mut w = test_utils::TestVecWriter(Vec::new());
8185 monitor.write(&mut w).unwrap();
8186 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8187 &mut io::Cursor::new(&w.0), (nodes[0].keys_manager, nodes[0].keys_manager)).unwrap().1;
8188 assert!(new_monitor == *monitor);
8189 let watchtower = test_utils::TestChainMonitor::new(Some(&chain_source), &chanmon_cfgs[0].tx_broadcaster, &logger, &chanmon_cfgs[0].fee_estimator, &persister, &node_cfgs[0].keys_manager);
8190 assert_eq!(watchtower.watch_channel(outpoint, new_monitor), ChannelMonitorUpdateStatus::Completed);
8193 let header = BlockHeader { version: 0x20000000, prev_blockhash: BlockHash::all_zeros(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
8194 let block = Block { header, txdata: vec![] };
8195 // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8196 // transaction lock time requirements here.
8197 chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize((CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS) as usize, (block.clone(), 0));
8198 watchtower_alice.chain_monitor.block_connected(&block, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8200 // Watchtower Alice should have broadcast a commitment/HTLC-timeout
8202 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8203 assert_eq!(txn.len(), 2);
8207 // Copy ChainMonitor to simulate watchtower Bob and make it receive a commitment update first.
8208 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8209 let logger = test_utils::TestLogger::with_id(format!("node {}", "Bob"));
8210 let persister = test_utils::TestPersister::new();
8211 let watchtower_bob = {
8212 let monitor = nodes[0].chain_monitor.chain_monitor.get_monitor(outpoint).unwrap();
8213 let mut w = test_utils::TestVecWriter(Vec::new());
8214 monitor.write(&mut w).unwrap();
8215 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8216 &mut io::Cursor::new(&w.0), (nodes[0].keys_manager, nodes[0].keys_manager)).unwrap().1;
8217 assert!(new_monitor == *monitor);
8218 let watchtower = test_utils::TestChainMonitor::new(Some(&chain_source), &chanmon_cfgs[0].tx_broadcaster, &logger, &chanmon_cfgs[0].fee_estimator, &persister, &node_cfgs[0].keys_manager);
8219 assert_eq!(watchtower.watch_channel(outpoint, new_monitor), ChannelMonitorUpdateStatus::Completed);
8222 let header = BlockHeader { version: 0x20000000, prev_blockhash: BlockHash::all_zeros(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
8223 watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8225 // Route another payment to generate another update with still previous HTLC pending
8226 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 3000000);
8228 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
8230 check_added_monitors!(nodes[1], 1);
8232 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8233 assert_eq!(updates.update_add_htlcs.len(), 1);
8234 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &updates.update_add_htlcs[0]);
8236 let mut node_0_per_peer_lock;
8237 let mut node_0_peer_state_lock;
8238 let mut channel = get_channel_ref!(nodes[0], nodes[1], node_0_per_peer_lock, node_0_peer_state_lock, chan_1.2);
8239 if let Ok((_, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].logger) {
8240 // Watchtower Alice should already have seen the block and reject the update
8241 assert_eq!(watchtower_alice.chain_monitor.update_channel(outpoint, &update), ChannelMonitorUpdateStatus::PermanentFailure);
8242 assert_eq!(watchtower_bob.chain_monitor.update_channel(outpoint, &update), ChannelMonitorUpdateStatus::Completed);
8243 assert_eq!(nodes[0].chain_monitor.update_channel(outpoint, &update), ChannelMonitorUpdateStatus::Completed);
8244 } else { assert!(false); }
8246 // Our local monitor is in-sync and hasn't processed yet timeout
8247 check_added_monitors!(nodes[0], 1);
8249 //// Provide one more block to watchtower Bob, expect broadcast of commitment and HTLC-Timeout
8250 let header = BlockHeader { version: 0x20000000, prev_blockhash: BlockHash::all_zeros(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
8251 watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8253 // Watchtower Bob should have broadcast a commitment/HTLC-timeout
8256 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8257 assert_eq!(txn.len(), 2);
8258 bob_state_y = txn[0].clone();
8262 // We confirm Bob's state Y on Alice, she should broadcast a HTLC-timeout
8263 let header = BlockHeader { version: 0x20000000, prev_blockhash: BlockHash::all_zeros(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
8264 watchtower_alice.chain_monitor.block_connected(&Block { header, txdata: vec![bob_state_y.clone()] }, CHAN_CONFIRM_DEPTH + 2 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8266 let htlc_txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8267 assert_eq!(htlc_txn.len(), 1);
8268 check_spends!(htlc_txn[0], bob_state_y);
8273 fn test_pre_lockin_no_chan_closed_update() {
8274 // Test that if a peer closes a channel in response to a funding_created message we don't
8275 // generate a channel update (as the channel cannot appear on chain without a funding_signed
8278 // Doing so would imply a channel monitor update before the initial channel monitor
8279 // registration, violating our API guarantees.
8281 // Previously, full_stack_target managed to hit this case by opening then closing a channel,
8282 // then opening a second channel with the same funding output as the first (which is not
8283 // rejected because the first channel does not exist in the ChannelManager) and closing it
8284 // before receiving funding_signed.
8285 let chanmon_cfgs = create_chanmon_cfgs(2);
8286 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8287 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8288 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8290 // Create an initial channel
8291 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8292 let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8293 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_chan_msg);
8294 let accept_chan_msg = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8295 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_chan_msg);
8297 // Move the first channel through the funding flow...
8298 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100000, 42);
8300 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).unwrap();
8301 check_added_monitors!(nodes[0], 0);
8303 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8304 let channel_id = crate::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
8305 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id, data: "Hi".to_owned() });
8306 assert!(nodes[0].chain_monitor.added_monitors.lock().unwrap().is_empty());
8307 check_closed_event!(nodes[0], 2, ClosureReason::CounterpartyForceClosed { peer_msg: "Hi".to_string() }, true);
8311 fn test_htlc_no_detection() {
8312 // This test is a mutation to underscore the detection logic bug we had
8313 // before #653. HTLC value routed is above the remaining balance, thus
8314 // inverting HTLC and `to_remote` output. HTLC will come second and
8315 // it wouldn't be seen by pre-#653 detection as we were enumerate()'ing
8316 // on a watched outputs vector (Vec<TxOut>) thus implicitly relying on
8317 // outputs order detection for correct spending children filtring.
8319 let chanmon_cfgs = create_chanmon_cfgs(2);
8320 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8321 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8322 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8324 // Create some initial channels
8325 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001);
8327 send_payment(&nodes[0], &vec!(&nodes[1])[..], 1_000_000);
8328 let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 2_000_000);
8329 let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
8330 assert_eq!(local_txn[0].input.len(), 1);
8331 assert_eq!(local_txn[0].output.len(), 3);
8332 check_spends!(local_txn[0], chan_1.3);
8334 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
8335 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
8336 connect_block(&nodes[0], &Block { header, txdata: vec![local_txn[0].clone()] });
8337 // We deliberately connect the local tx twice as this should provoke a failure calling
8338 // this test before #653 fix.
8339 chain::Listen::block_connected(&nodes[0].chain_monitor.chain_monitor, &Block { header, txdata: vec![local_txn[0].clone()] }, nodes[0].best_block_info().1 + 1);
8340 check_closed_broadcast!(nodes[0], true);
8341 check_added_monitors!(nodes[0], 1);
8342 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
8343 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1);
8345 let htlc_timeout = {
8346 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8347 assert_eq!(node_txn.len(), 1);
8348 assert_eq!(node_txn[0].input.len(), 1);
8349 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8350 check_spends!(node_txn[0], local_txn[0]);
8354 let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
8355 connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] });
8356 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8357 expect_payment_failed!(nodes[0], our_payment_hash, false);
8360 fn do_test_onchain_htlc_settlement_after_close(broadcast_alice: bool, go_onchain_before_fulfill: bool) {
8361 // If we route an HTLC, then learn the HTLC's preimage after the upstream channel has been
8362 // force-closed, we must claim that HTLC on-chain. (Given an HTLC forwarded from Alice --> Bob -->
8363 // Carol, Alice would be the upstream node, and Carol the downstream.)
8365 // Steps of the test:
8366 // 1) Alice sends a HTLC to Carol through Bob.
8367 // 2) Carol doesn't settle the HTLC.
8368 // 3) If broadcast_alice is true, Alice force-closes her channel with Bob. Else Bob force closes.
8369 // Steps 4 and 5 may be reordered depending on go_onchain_before_fulfill.
8370 // 4) Bob sees the Alice's commitment on his chain or vice versa. An offered output is present
8371 // but can't be claimed as Bob doesn't have yet knowledge of the preimage.
8372 // 5) Carol release the preimage to Bob off-chain.
8373 // 6) Bob claims the offered output on the broadcasted commitment.
8374 let chanmon_cfgs = create_chanmon_cfgs(3);
8375 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8376 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8377 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8379 // Create some initial channels
8380 let chan_ab = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001);
8381 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 10001);
8383 // Steps (1) and (2):
8384 // Send an HTLC Alice --> Bob --> Carol, but Carol doesn't settle the HTLC back.
8385 let (payment_preimage, payment_hash, _payment_secret) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3_000_000);
8387 // Check that Alice's commitment transaction now contains an output for this HTLC.
8388 let alice_txn = get_local_commitment_txn!(nodes[0], chan_ab.2);
8389 check_spends!(alice_txn[0], chan_ab.3);
8390 assert_eq!(alice_txn[0].output.len(), 2);
8391 check_spends!(alice_txn[1], alice_txn[0]); // 2nd transaction is a non-final HTLC-timeout
8392 assert_eq!(alice_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8393 assert_eq!(alice_txn.len(), 2);
8395 // Steps (3) and (4):
8396 // If `go_onchain_before_fufill`, broadcast the relevant commitment transaction and check that Bob
8397 // responds by (1) broadcasting a channel update and (2) adding a new ChannelMonitor.
8398 let mut force_closing_node = 0; // Alice force-closes
8399 let mut counterparty_node = 1; // Bob if Alice force-closes
8402 if !broadcast_alice {
8403 force_closing_node = 1;
8404 counterparty_node = 0;
8406 nodes[force_closing_node].node.force_close_broadcasting_latest_txn(&chan_ab.2, &nodes[counterparty_node].node.get_our_node_id()).unwrap();
8407 check_closed_broadcast!(nodes[force_closing_node], true);
8408 check_added_monitors!(nodes[force_closing_node], 1);
8409 check_closed_event!(nodes[force_closing_node], 1, ClosureReason::HolderForceClosed);
8410 if go_onchain_before_fulfill {
8411 let txn_to_broadcast = match broadcast_alice {
8412 true => alice_txn.clone(),
8413 false => get_local_commitment_txn!(nodes[1], chan_ab.2)
8415 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42};
8416 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8417 if broadcast_alice {
8418 check_closed_broadcast!(nodes[1], true);
8419 check_added_monitors!(nodes[1], 1);
8420 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
8425 // Carol then claims the funds and sends an update_fulfill message to Bob, and they go through the
8426 // process of removing the HTLC from their commitment transactions.
8427 nodes[2].node.claim_funds(payment_preimage);
8428 check_added_monitors!(nodes[2], 1);
8429 expect_payment_claimed!(nodes[2], payment_hash, 3_000_000);
8431 let carol_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
8432 assert!(carol_updates.update_add_htlcs.is_empty());
8433 assert!(carol_updates.update_fail_htlcs.is_empty());
8434 assert!(carol_updates.update_fail_malformed_htlcs.is_empty());
8435 assert!(carol_updates.update_fee.is_none());
8436 assert_eq!(carol_updates.update_fulfill_htlcs.len(), 1);
8438 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &carol_updates.update_fulfill_htlcs[0]);
8439 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], if go_onchain_before_fulfill || force_closing_node == 1 { None } else { Some(1000) }, false, false);
8440 // If Alice broadcasted but Bob doesn't know yet, here he prepares to tell her about the preimage.
8441 if !go_onchain_before_fulfill && broadcast_alice {
8442 let events = nodes[1].node.get_and_clear_pending_msg_events();
8443 assert_eq!(events.len(), 1);
8445 MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
8446 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
8448 _ => panic!("Unexpected event"),
8451 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &carol_updates.commitment_signed);
8452 // One monitor update for the preimage to update the Bob<->Alice channel, one monitor update
8453 // Carol<->Bob's updated commitment transaction info.
8454 check_added_monitors!(nodes[1], 2);
8456 let events = nodes[1].node.get_and_clear_pending_msg_events();
8457 assert_eq!(events.len(), 2);
8458 let bob_revocation = match events[0] {
8459 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8460 assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8463 _ => panic!("Unexpected event"),
8465 let bob_updates = match events[1] {
8466 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
8467 assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8470 _ => panic!("Unexpected event"),
8473 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bob_revocation);
8474 check_added_monitors!(nodes[2], 1);
8475 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bob_updates.commitment_signed);
8476 check_added_monitors!(nodes[2], 1);
8478 let events = nodes[2].node.get_and_clear_pending_msg_events();
8479 assert_eq!(events.len(), 1);
8480 let carol_revocation = match events[0] {
8481 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8482 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
8485 _ => panic!("Unexpected event"),
8487 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &carol_revocation);
8488 check_added_monitors!(nodes[1], 1);
8490 // If this test requires the force-closed channel to not be on-chain until after the fulfill,
8491 // here's where we put said channel's commitment tx on-chain.
8492 let mut txn_to_broadcast = alice_txn.clone();
8493 if !broadcast_alice { txn_to_broadcast = get_local_commitment_txn!(nodes[1], chan_ab.2); }
8494 if !go_onchain_before_fulfill {
8495 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42};
8496 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8497 // If Bob was the one to force-close, he will have already passed these checks earlier.
8498 if broadcast_alice {
8499 check_closed_broadcast!(nodes[1], true);
8500 check_added_monitors!(nodes[1], 1);
8501 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
8503 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8504 if broadcast_alice {
8505 assert_eq!(bob_txn.len(), 1);
8506 check_spends!(bob_txn[0], txn_to_broadcast[0]);
8508 assert_eq!(bob_txn.len(), 2);
8509 check_spends!(bob_txn[0], chan_ab.3);
8514 // Finally, check that Bob broadcasted a preimage-claiming transaction for the HTLC output on the
8515 // broadcasted commitment transaction.
8517 let script_weight = match broadcast_alice {
8518 true => OFFERED_HTLC_SCRIPT_WEIGHT,
8519 false => ACCEPTED_HTLC_SCRIPT_WEIGHT
8521 // If Alice force-closed, Bob only broadcasts a HTLC-output-claiming transaction. Otherwise,
8522 // Bob force-closed and broadcasts the commitment transaction along with a
8523 // HTLC-output-claiming transaction.
8524 let bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
8525 if broadcast_alice {
8526 assert_eq!(bob_txn.len(), 1);
8527 check_spends!(bob_txn[0], txn_to_broadcast[0]);
8528 assert_eq!(bob_txn[0].input[0].witness.last().unwrap().len(), script_weight);
8530 assert_eq!(bob_txn.len(), 2);
8531 check_spends!(bob_txn[1], txn_to_broadcast[0]);
8532 assert_eq!(bob_txn[1].input[0].witness.last().unwrap().len(), script_weight);
8538 fn test_onchain_htlc_settlement_after_close() {
8539 do_test_onchain_htlc_settlement_after_close(true, true);
8540 do_test_onchain_htlc_settlement_after_close(false, true); // Technically redundant, but may as well
8541 do_test_onchain_htlc_settlement_after_close(true, false);
8542 do_test_onchain_htlc_settlement_after_close(false, false);
8546 fn test_duplicate_temporary_channel_id_from_different_peers() {
8547 // Tests that we can accept two different `OpenChannel` requests with the same
8548 // `temporary_channel_id`, as long as they are from different peers.
8549 let chanmon_cfgs = create_chanmon_cfgs(3);
8550 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8551 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8552 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8554 // Create an first channel channel
8555 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8556 let mut open_chan_msg_chan_1_0 = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
8558 // Create an second channel
8559 nodes[2].node.create_channel(nodes[0].node.get_our_node_id(), 100000, 10001, 43, None).unwrap();
8560 let mut open_chan_msg_chan_2_0 = get_event_msg!(nodes[2], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
8562 // Modify the `OpenChannel` from `nodes[2]` to `nodes[0]` to ensure that it uses the same
8563 // `temporary_channel_id` as the `OpenChannel` from nodes[1] to nodes[0].
8564 open_chan_msg_chan_2_0.temporary_channel_id = open_chan_msg_chan_1_0.temporary_channel_id;
8566 // Assert that `nodes[0]` can accept both `OpenChannel` requests, even though they use the same
8567 // `temporary_channel_id` as they are from different peers.
8568 nodes[0].node.handle_open_channel(&nodes[1].node.get_our_node_id(), &open_chan_msg_chan_1_0);
8570 let events = nodes[0].node.get_and_clear_pending_msg_events();
8571 assert_eq!(events.len(), 1);
8573 MessageSendEvent::SendAcceptChannel { node_id, msg } => {
8574 assert_eq!(node_id, &nodes[1].node.get_our_node_id());
8575 assert_eq!(msg.temporary_channel_id, open_chan_msg_chan_1_0.temporary_channel_id);
8577 _ => panic!("Unexpected event"),
8581 nodes[0].node.handle_open_channel(&nodes[2].node.get_our_node_id(), &open_chan_msg_chan_2_0);
8583 let events = nodes[0].node.get_and_clear_pending_msg_events();
8584 assert_eq!(events.len(), 1);
8586 MessageSendEvent::SendAcceptChannel { node_id, msg } => {
8587 assert_eq!(node_id, &nodes[2].node.get_our_node_id());
8588 assert_eq!(msg.temporary_channel_id, open_chan_msg_chan_1_0.temporary_channel_id);
8590 _ => panic!("Unexpected event"),
8596 fn test_duplicate_chan_id() {
8597 // Test that if a given peer tries to open a channel with the same channel_id as one that is
8598 // already open we reject it and keep the old channel.
8600 // Previously, full_stack_target managed to figure out that if you tried to open two channels
8601 // with the same funding output (ie post-funding channel_id), we'd create a monitor update for
8602 // the existing channel when we detect the duplicate new channel, screwing up our monitor
8603 // updating logic for the existing channel.
8604 let chanmon_cfgs = create_chanmon_cfgs(2);
8605 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8606 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8607 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8609 // Create an initial channel
8610 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8611 let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8612 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_chan_msg);
8613 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id()));
8615 // Try to create a second channel with the same temporary_channel_id as the first and check
8616 // that it is rejected.
8617 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_chan_msg);
8619 let events = nodes[1].node.get_and_clear_pending_msg_events();
8620 assert_eq!(events.len(), 1);
8622 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8623 // Technically, at this point, nodes[1] would be justified in thinking both the
8624 // first (valid) and second (invalid) channels are closed, given they both have
8625 // the same non-temporary channel_id. However, currently we do not, so we just
8626 // move forward with it.
8627 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
8628 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8630 _ => panic!("Unexpected event"),
8634 // Move the first channel through the funding flow...
8635 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100000, 42);
8637 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).unwrap();
8638 check_added_monitors!(nodes[0], 0);
8640 let mut funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8641 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
8643 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
8644 assert_eq!(added_monitors.len(), 1);
8645 assert_eq!(added_monitors[0].0, funding_output);
8646 added_monitors.clear();
8648 let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
8650 let funding_outpoint = crate::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index };
8651 let channel_id = funding_outpoint.to_channel_id();
8653 // Now we have the first channel past funding_created (ie it has a txid-based channel_id, not a
8656 // First try to open a second channel with a temporary channel id equal to the txid-based one.
8657 // Technically this is allowed by the spec, but we don't support it and there's little reason
8658 // to. Still, it shouldn't cause any other issues.
8659 open_chan_msg.temporary_channel_id = channel_id;
8660 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_chan_msg);
8662 let events = nodes[1].node.get_and_clear_pending_msg_events();
8663 assert_eq!(events.len(), 1);
8665 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8666 // Technically, at this point, nodes[1] would be justified in thinking both
8667 // channels are closed, but currently we do not, so we just move forward with it.
8668 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
8669 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8671 _ => panic!("Unexpected event"),
8675 // Now try to create a second channel which has a duplicate funding output.
8676 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8677 let open_chan_2_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8678 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_chan_2_msg);
8679 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id()));
8680 create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100000, 42); // Get and check the FundingGenerationReady event
8682 let funding_created = {
8683 let per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
8684 let mut a_peer_state = per_peer_state.get(&nodes[1].node.get_our_node_id()).unwrap().lock().unwrap();
8685 // Once we call `get_outbound_funding_created` the channel has a duplicate channel_id as
8686 // another channel in the ChannelManager - an invalid state. Thus, we'd panic later when we
8687 // try to create another channel. Instead, we drop the channel entirely here (leaving the
8688 // channelmanager in a possibly nonsense state instead).
8689 let mut as_chan = a_peer_state.channel_by_id.remove(&open_chan_2_msg.temporary_channel_id).unwrap();
8690 let logger = test_utils::TestLogger::new();
8691 as_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).unwrap()
8693 check_added_monitors!(nodes[0], 0);
8694 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
8695 // At this point we'll try to add a duplicate channel monitor, which will be rejected, but
8696 // still needs to be cleared here.
8697 check_added_monitors!(nodes[1], 1);
8699 // ...still, nodes[1] will reject the duplicate channel.
8701 let events = nodes[1].node.get_and_clear_pending_msg_events();
8702 assert_eq!(events.len(), 1);
8704 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8705 // Technically, at this point, nodes[1] would be justified in thinking both
8706 // channels are closed, but currently we do not, so we just move forward with it.
8707 assert_eq!(msg.channel_id, channel_id);
8708 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8710 _ => panic!("Unexpected event"),
8714 // finally, finish creating the original channel and send a payment over it to make sure
8715 // everything is functional.
8716 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
8718 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
8719 assert_eq!(added_monitors.len(), 1);
8720 assert_eq!(added_monitors[0].0, funding_output);
8721 added_monitors.clear();
8724 let events_4 = nodes[0].node.get_and_clear_pending_events();
8725 assert_eq!(events_4.len(), 0);
8726 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
8727 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
8729 let (channel_ready, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
8730 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &channel_ready);
8731 update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
8733 send_payment(&nodes[0], &[&nodes[1]], 8000000);
8737 fn test_error_chans_closed() {
8738 // Test that we properly handle error messages, closing appropriate channels.
8740 // Prior to #787 we'd allow a peer to make us force-close a channel we had with a different
8741 // peer. The "real" fix for that is to index channels with peers_ids, however in the mean time
8742 // we can test various edge cases around it to ensure we don't regress.
8743 let chanmon_cfgs = create_chanmon_cfgs(3);
8744 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8745 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8746 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8748 // Create some initial channels
8749 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001);
8750 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001);
8751 let chan_3 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001);
8753 assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
8754 assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
8755 assert_eq!(nodes[2].node.list_usable_channels().len(), 1);
8757 // Closing a channel from a different peer has no effect
8758 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_3.2, data: "ERR".to_owned() });
8759 assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
8761 // Closing one channel doesn't impact others
8762 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_2.2, data: "ERR".to_owned() });
8763 check_added_monitors!(nodes[0], 1);
8764 check_closed_broadcast!(nodes[0], false);
8765 check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyForceClosed { peer_msg: "ERR".to_string() });
8766 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
8767 assert_eq!(nodes[0].node.list_usable_channels().len(), 2);
8768 assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_1.2 || nodes[0].node.list_usable_channels()[1].channel_id == chan_1.2);
8769 assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2 || nodes[0].node.list_usable_channels()[1].channel_id == chan_3.2);
8771 // A null channel ID should close all channels
8772 let _chan_4 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001);
8773 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: [0; 32], data: "ERR".to_owned() });
8774 check_added_monitors!(nodes[0], 2);
8775 check_closed_event!(nodes[0], 2, ClosureReason::CounterpartyForceClosed { peer_msg: "ERR".to_string() });
8776 let events = nodes[0].node.get_and_clear_pending_msg_events();
8777 assert_eq!(events.len(), 2);
8779 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
8780 assert_eq!(msg.contents.flags & 2, 2);
8782 _ => panic!("Unexpected event"),
8785 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
8786 assert_eq!(msg.contents.flags & 2, 2);
8788 _ => panic!("Unexpected event"),
8790 // Note that at this point users of a standard PeerHandler will end up calling
8791 // peer_disconnected with no_connection_possible set to false, duplicating the
8792 // close-all-channels logic. That's OK, we don't want to end up not force-closing channels for
8793 // users with their own peer handling logic. We duplicate the call here, however.
8794 assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
8795 assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
8797 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), true);
8798 assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
8799 assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
8803 fn test_invalid_funding_tx() {
8804 // Test that we properly handle invalid funding transactions sent to us from a peer.
8806 // Previously, all other major lightning implementations had failed to properly sanitize
8807 // funding transactions from their counterparties, leading to a multi-implementation critical
8808 // security vulnerability (though we always sanitized properly, we've previously had
8809 // un-released crashes in the sanitization process).
8811 // Further, if the funding transaction is consensus-valid, confirms, and is later spent, we'd
8812 // previously have crashed in `ChannelMonitor` even though we closed the channel as bogus and
8813 // gave up on it. We test this here by generating such a transaction.
8814 let chanmon_cfgs = create_chanmon_cfgs(2);
8815 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8816 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8817 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8819 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 10_000, 42, None).unwrap();
8820 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id()));
8821 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id()));
8823 let (temporary_channel_id, mut tx, _) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100_000, 42);
8825 // Create a witness program which can be spent by a 4-empty-stack-elements witness and which is
8826 // 136 bytes long. This matches our "accepted HTLC preimage spend" matching, previously causing
8827 // a panic as we'd try to extract a 32 byte preimage from a witness element without checking
8829 let mut wit_program: Vec<u8> = channelmonitor::deliberately_bogus_accepted_htlc_witness_program();
8830 let wit_program_script: Script = wit_program.into();
8831 for output in tx.output.iter_mut() {
8832 // Make the confirmed funding transaction have a bogus script_pubkey
8833 output.script_pubkey = Script::new_v0_p2wsh(&wit_program_script.wscript_hash());
8836 nodes[0].node.funding_transaction_generated_unchecked(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone(), 0).unwrap();
8837 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id()));
8838 check_added_monitors!(nodes[1], 1);
8840 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id()));
8841 check_added_monitors!(nodes[0], 1);
8843 let events_1 = nodes[0].node.get_and_clear_pending_events();
8844 assert_eq!(events_1.len(), 0);
8846 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
8847 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
8848 nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
8850 let expected_err = "funding tx had wrong script/value or output index";
8851 confirm_transaction_at(&nodes[1], &tx, 1);
8852 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: expected_err.to_string() });
8853 check_added_monitors!(nodes[1], 1);
8854 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
8855 assert_eq!(events_2.len(), 1);
8856 if let MessageSendEvent::HandleError { node_id, action } = &events_2[0] {
8857 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
8858 if let msgs::ErrorAction::SendErrorMessage { msg } = action {
8859 assert_eq!(msg.data, "Channel closed because of an exception: ".to_owned() + expected_err);
8860 } else { panic!(); }
8861 } else { panic!(); }
8862 assert_eq!(nodes[1].node.list_channels().len(), 0);
8864 // Now confirm a spend of the (bogus) funding transaction. As long as the witness is 5 elements
8865 // long the ChannelMonitor will try to read 32 bytes from the second-to-last element, panicing
8866 // as its not 32 bytes long.
8867 let mut spend_tx = Transaction {
8868 version: 2i32, lock_time: PackedLockTime::ZERO,
8869 input: tx.output.iter().enumerate().map(|(idx, _)| TxIn {
8870 previous_output: BitcoinOutPoint {
8874 script_sig: Script::new(),
8875 sequence: Sequence::ENABLE_RBF_NO_LOCKTIME,
8876 witness: Witness::from_vec(channelmonitor::deliberately_bogus_accepted_htlc_witness())
8878 output: vec![TxOut {
8880 script_pubkey: Script::new(),
8883 check_spends!(spend_tx, tx);
8884 mine_transaction(&nodes[1], &spend_tx);
8887 fn do_test_tx_confirmed_skipping_blocks_immediate_broadcast(test_height_before_timelock: bool) {
8888 // In the first version of the chain::Confirm interface, after a refactor was made to not
8889 // broadcast CSV-locked transactions until their CSV lock is up, we wouldn't reliably broadcast
8890 // transactions after a `transactions_confirmed` call. Specifically, if the chain, provided via
8891 // `best_block_updated` is at height N, and a transaction output which we wish to spend at
8892 // height N-1 (due to a CSV to height N-1) is provided at height N, we will not broadcast the
8893 // spending transaction until height N+1 (or greater). This was due to the way
8894 // `ChannelMonitor::transactions_confirmed` worked, only checking if we should broadcast a
8895 // spending transaction at the height the input transaction was confirmed at, not whether we
8896 // should broadcast a spending transaction at the current height.
8897 // A second, similar, issue involved failing HTLCs backwards - because we only provided the
8898 // height at which transactions were confirmed to `OnchainTx::update_claims_view`, it wasn't
8899 // aware that the anti-reorg-delay had, in fact, already expired, waiting to fail-backwards
8900 // until we learned about an additional block.
8902 // As an additional check, if `test_height_before_timelock` is set, we instead test that we
8903 // aren't broadcasting transactions too early (ie not broadcasting them at all).
8904 let chanmon_cfgs = create_chanmon_cfgs(3);
8905 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8906 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8907 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8908 *nodes[0].connect_style.borrow_mut() = ConnectStyle::BestBlockFirstSkippingBlocks;
8910 create_announced_chan_between_nodes(&nodes, 0, 1);
8911 let (chan_announce, _, channel_id, _) = create_announced_chan_between_nodes(&nodes, 1, 2);
8912 let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000);
8913 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
8914 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
8916 nodes[1].node.force_close_broadcasting_latest_txn(&channel_id, &nodes[2].node.get_our_node_id()).unwrap();
8917 check_closed_broadcast!(nodes[1], true);
8918 check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed);
8919 check_added_monitors!(nodes[1], 1);
8920 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
8921 assert_eq!(node_txn.len(), 1);
8923 let conf_height = nodes[1].best_block_info().1;
8924 if !test_height_before_timelock {
8925 connect_blocks(&nodes[1], 24 * 6);
8927 nodes[1].chain_monitor.chain_monitor.transactions_confirmed(
8928 &nodes[1].get_block_header(conf_height), &[(0, &node_txn[0])], conf_height);
8929 if test_height_before_timelock {
8930 // If we confirmed the close transaction, but timelocks have not yet expired, we should not
8931 // generate any events or broadcast any transactions
8932 assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
8933 assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
8935 // We should broadcast an HTLC transaction spending our funding transaction first
8936 let spending_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
8937 assert_eq!(spending_txn.len(), 2);
8938 assert_eq!(spending_txn[0], node_txn[0]);
8939 check_spends!(spending_txn[1], node_txn[0]);
8940 // We should also generate a SpendableOutputs event with the to_self output (as its
8942 let descriptor_spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
8943 assert_eq!(descriptor_spend_txn.len(), 1);
8945 // If we also discover that the HTLC-Timeout transaction was confirmed some time ago, we
8946 // should immediately fail-backwards the HTLC to the previous hop, without waiting for an
8947 // additional block built on top of the current chain.
8948 nodes[1].chain_monitor.chain_monitor.transactions_confirmed(
8949 &nodes[1].get_block_header(conf_height + 1), &[(0, &spending_txn[1])], conf_height + 1);
8950 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::NextHopChannel { node_id: Some(nodes[2].node.get_our_node_id()), channel_id: channel_id }]);
8951 check_added_monitors!(nodes[1], 1);
8953 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8954 assert!(updates.update_add_htlcs.is_empty());
8955 assert!(updates.update_fulfill_htlcs.is_empty());
8956 assert_eq!(updates.update_fail_htlcs.len(), 1);
8957 assert!(updates.update_fail_malformed_htlcs.is_empty());
8958 assert!(updates.update_fee.is_none());
8959 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
8960 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
8961 expect_payment_failed_with_update!(nodes[0], payment_hash, false, chan_announce.contents.short_channel_id, true);
8966 fn test_tx_confirmed_skipping_blocks_immediate_broadcast() {
8967 do_test_tx_confirmed_skipping_blocks_immediate_broadcast(false);
8968 do_test_tx_confirmed_skipping_blocks_immediate_broadcast(true);
8971 fn do_test_dup_htlc_second_rejected(test_for_second_fail_panic: bool) {
8972 let chanmon_cfgs = create_chanmon_cfgs(2);
8973 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8974 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8975 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8977 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001);
8979 let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id())
8980 .with_features(nodes[1].node.invoice_features());
8981 let route = get_route!(nodes[0], payment_params, 10_000, TEST_FINAL_CLTV).unwrap();
8983 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(&nodes[1]);
8986 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
8987 check_added_monitors!(nodes[0], 1);
8988 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8989 assert_eq!(events.len(), 1);
8990 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8991 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8992 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8994 expect_pending_htlcs_forwardable!(nodes[1]);
8995 expect_payment_claimable!(nodes[1], our_payment_hash, our_payment_secret, 10_000);
8998 // Note that we use a different PaymentId here to allow us to duplicativly pay
8999 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_secret.0)).unwrap();
9000 check_added_monitors!(nodes[0], 1);
9001 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9002 assert_eq!(events.len(), 1);
9003 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
9004 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
9005 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
9006 // At this point, nodes[1] would notice it has too much value for the payment. It will
9007 // assume the second is a privacy attack (no longer particularly relevant
9008 // post-payment_secrets) and fail back the new HTLC. Previously, it'd also have failed back
9009 // the first HTLC delivered above.
9012 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
9013 nodes[1].node.process_pending_htlc_forwards();
9015 if test_for_second_fail_panic {
9016 // Now we go fail back the first HTLC from the user end.
9017 nodes[1].node.fail_htlc_backwards(&our_payment_hash);
9019 let expected_destinations = vec![
9020 HTLCDestination::FailedPayment { payment_hash: our_payment_hash },
9021 HTLCDestination::FailedPayment { payment_hash: our_payment_hash },
9023 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], expected_destinations);
9024 nodes[1].node.process_pending_htlc_forwards();
9026 check_added_monitors!(nodes[1], 1);
9027 let fail_updates_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9028 assert_eq!(fail_updates_1.update_fail_htlcs.len(), 2);
9030 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_updates_1.update_fail_htlcs[0]);
9031 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_updates_1.update_fail_htlcs[1]);
9032 commitment_signed_dance!(nodes[0], nodes[1], fail_updates_1.commitment_signed, false);
9034 let failure_events = nodes[0].node.get_and_clear_pending_events();
9035 assert_eq!(failure_events.len(), 2);
9036 if let Event::PaymentPathFailed { .. } = failure_events[0] {} else { panic!(); }
9037 if let Event::PaymentPathFailed { .. } = failure_events[1] {} else { panic!(); }
9039 // Let the second HTLC fail and claim the first
9040 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: our_payment_hash }]);
9041 nodes[1].node.process_pending_htlc_forwards();
9043 check_added_monitors!(nodes[1], 1);
9044 let fail_updates_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9045 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_updates_1.update_fail_htlcs[0]);
9046 commitment_signed_dance!(nodes[0], nodes[1], fail_updates_1.commitment_signed, false);
9048 expect_payment_failed_conditions(&nodes[0], our_payment_hash, true, PaymentFailedConditions::new().mpp_parts_remain());
9050 claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage);
9055 fn test_dup_htlc_second_fail_panic() {
9056 // Previously, if we received two HTLCs back-to-back, where the second overran the expected
9057 // value for the payment, we'd fail back both HTLCs after generating a `PaymentClaimable` event.
9058 // Then, if the user failed the second payment, they'd hit a "tried to fail an already failed
9059 // HTLC" debug panic. This tests for this behavior, checking that only one HTLC is auto-failed.
9060 do_test_dup_htlc_second_rejected(true);
9064 fn test_dup_htlc_second_rejected() {
9065 // Test that if we receive a second HTLC for an MPP payment that overruns the payment amount we
9066 // simply reject the second HTLC but are still able to claim the first HTLC.
9067 do_test_dup_htlc_second_rejected(false);
9071 fn test_inconsistent_mpp_params() {
9072 // Test that if we recieve two HTLCs with different payment parameters we fail back the first
9073 // such HTLC and allow the second to stay.
9074 let chanmon_cfgs = create_chanmon_cfgs(4);
9075 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
9076 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
9077 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
9079 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, 0);
9080 create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100_000, 0);
9081 create_announced_chan_between_nodes_with_value(&nodes, 1, 3, 100_000, 0);
9082 let chan_2_3 =create_announced_chan_between_nodes_with_value(&nodes, 2, 3, 100_000, 0);
9084 let payment_params = PaymentParameters::from_node_id(nodes[3].node.get_our_node_id())
9085 .with_features(nodes[3].node.invoice_features());
9086 let mut route = get_route!(nodes[0], payment_params, 15_000_000, TEST_FINAL_CLTV).unwrap();
9087 assert_eq!(route.paths.len(), 2);
9088 route.paths.sort_by(|path_a, _| {
9089 // Sort the path so that the path through nodes[1] comes first
9090 if path_a[0].pubkey == nodes[1].node.get_our_node_id() {
9091 core::cmp::Ordering::Less } else { core::cmp::Ordering::Greater }
9093 let payment_params_opt = Some(payment_params);
9095 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(&nodes[3]);
9097 let cur_height = nodes[0].best_block_info().1;
9098 let payment_id = PaymentId([42; 32]);
9100 let session_privs = {
9101 // We create a fake route here so that we start with three pending HTLCs, which we'll
9102 // ultimately have, just not right away.
9103 let mut dup_route = route.clone();
9104 dup_route.paths.push(route.paths[1].clone());
9105 nodes[0].node.test_add_new_pending_payment(our_payment_hash, Some(our_payment_secret), payment_id, &dup_route).unwrap()
9108 nodes[0].node.send_payment_along_path(&route.paths[0], &payment_params_opt, &our_payment_hash, &Some(our_payment_secret), 15_000_000, cur_height, payment_id, &None, session_privs[0]).unwrap();
9109 check_added_monitors!(nodes[0], 1);
9111 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9112 assert_eq!(events.len(), 1);
9113 pass_along_path(&nodes[0], &[&nodes[1], &nodes[3]], 15_000_000, our_payment_hash, Some(our_payment_secret), events.pop().unwrap(), false, None);
9115 assert!(nodes[3].node.get_and_clear_pending_events().is_empty());
9118 nodes[0].node.send_payment_along_path(&route.paths[1], &payment_params_opt, &our_payment_hash, &Some(our_payment_secret), 14_000_000, cur_height, payment_id, &None, session_privs[1]).unwrap();
9119 check_added_monitors!(nodes[0], 1);
9121 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9122 assert_eq!(events.len(), 1);
9123 let payment_event = SendEvent::from_event(events.pop().unwrap());
9125 nodes[2].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
9126 commitment_signed_dance!(nodes[2], nodes[0], payment_event.commitment_msg, false);
9128 expect_pending_htlcs_forwardable!(nodes[2]);
9129 check_added_monitors!(nodes[2], 1);
9131 let mut events = nodes[2].node.get_and_clear_pending_msg_events();
9132 assert_eq!(events.len(), 1);
9133 let payment_event = SendEvent::from_event(events.pop().unwrap());
9135 nodes[3].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
9136 check_added_monitors!(nodes[3], 0);
9137 commitment_signed_dance!(nodes[3], nodes[2], payment_event.commitment_msg, true, true);
9139 // At this point, nodes[3] should notice the two HTLCs don't contain the same total payment
9140 // amount. It will assume the second is a privacy attack (no longer particularly relevant
9141 // post-payment_secrets) and fail back the new HTLC.
9143 expect_pending_htlcs_forwardable_ignore!(nodes[3]);
9144 nodes[3].node.process_pending_htlc_forwards();
9145 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[3], vec![HTLCDestination::FailedPayment { payment_hash: our_payment_hash }]);
9146 nodes[3].node.process_pending_htlc_forwards();
9148 check_added_monitors!(nodes[3], 1);
9150 let fail_updates_1 = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
9151 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &fail_updates_1.update_fail_htlcs[0]);
9152 commitment_signed_dance!(nodes[2], nodes[3], fail_updates_1.commitment_signed, false);
9154 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::NextHopChannel { node_id: Some(nodes[3].node.get_our_node_id()), channel_id: chan_2_3.2 }]);
9155 check_added_monitors!(nodes[2], 1);
9157 let fail_updates_2 = get_htlc_update_msgs!(nodes[2], nodes[0].node.get_our_node_id());
9158 nodes[0].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &fail_updates_2.update_fail_htlcs[0]);
9159 commitment_signed_dance!(nodes[0], nodes[2], fail_updates_2.commitment_signed, false);
9161 expect_payment_failed_conditions(&nodes[0], our_payment_hash, true, PaymentFailedConditions::new().mpp_parts_remain());
9163 nodes[0].node.send_payment_along_path(&route.paths[1], &payment_params_opt, &our_payment_hash, &Some(our_payment_secret), 15_000_000, cur_height, payment_id, &None, session_privs[2]).unwrap();
9164 check_added_monitors!(nodes[0], 1);
9166 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9167 assert_eq!(events.len(), 1);
9168 pass_along_path(&nodes[0], &[&nodes[2], &nodes[3]], 15_000_000, our_payment_hash, Some(our_payment_secret), events.pop().unwrap(), true, None);
9170 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, our_payment_preimage);
9174 fn test_keysend_payments_to_public_node() {
9175 let chanmon_cfgs = create_chanmon_cfgs(2);
9176 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9177 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9178 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9180 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001);
9181 let network_graph = nodes[0].network_graph.clone();
9182 let payer_pubkey = nodes[0].node.get_our_node_id();
9183 let payee_pubkey = nodes[1].node.get_our_node_id();
9184 let route_params = RouteParameters {
9185 payment_params: PaymentParameters::for_keysend(payee_pubkey),
9186 final_value_msat: 10000,
9187 final_cltv_expiry_delta: 40,
9189 let scorer = test_utils::TestScorer::with_penalty(0);
9190 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
9191 let route = find_route(&payer_pubkey, &route_params, &network_graph, None, nodes[0].logger, &scorer, &random_seed_bytes).unwrap();
9193 let test_preimage = PaymentPreimage([42; 32]);
9194 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(test_preimage), PaymentId(test_preimage.0)).unwrap();
9195 check_added_monitors!(nodes[0], 1);
9196 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9197 assert_eq!(events.len(), 1);
9198 let event = events.pop().unwrap();
9199 let path = vec![&nodes[1]];
9200 pass_along_path(&nodes[0], &path, 10000, payment_hash, None, event, true, Some(test_preimage));
9201 claim_payment(&nodes[0], &path, test_preimage);
9205 fn test_keysend_payments_to_private_node() {
9206 let chanmon_cfgs = create_chanmon_cfgs(2);
9207 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9208 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9209 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9211 let payer_pubkey = nodes[0].node.get_our_node_id();
9212 let payee_pubkey = nodes[1].node.get_our_node_id();
9213 nodes[0].node.peer_connected(&payee_pubkey, &msgs::Init { features: nodes[1].node.init_features(), remote_network_address: None }).unwrap();
9214 nodes[1].node.peer_connected(&payer_pubkey, &msgs::Init { features: nodes[0].node.init_features(), remote_network_address: None }).unwrap();
9216 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
9217 let route_params = RouteParameters {
9218 payment_params: PaymentParameters::for_keysend(payee_pubkey),
9219 final_value_msat: 10000,
9220 final_cltv_expiry_delta: 40,
9222 let network_graph = nodes[0].network_graph.clone();
9223 let first_hops = nodes[0].node.list_usable_channels();
9224 let scorer = test_utils::TestScorer::with_penalty(0);
9225 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
9226 let route = find_route(
9227 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
9228 nodes[0].logger, &scorer, &random_seed_bytes
9231 let test_preimage = PaymentPreimage([42; 32]);
9232 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(test_preimage), PaymentId(test_preimage.0)).unwrap();
9233 check_added_monitors!(nodes[0], 1);
9234 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9235 assert_eq!(events.len(), 1);
9236 let event = events.pop().unwrap();
9237 let path = vec![&nodes[1]];
9238 pass_along_path(&nodes[0], &path, 10000, payment_hash, None, event, true, Some(test_preimage));
9239 claim_payment(&nodes[0], &path, test_preimage);
9243 fn test_double_partial_claim() {
9244 // Test what happens if a node receives a payment, generates a PaymentClaimable event, the HTLCs
9245 // time out, the sender resends only some of the MPP parts, then the user processes the
9246 // PaymentClaimable event, ensuring they don't inadvertently claim only part of the full payment
9248 let chanmon_cfgs = create_chanmon_cfgs(4);
9249 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
9250 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
9251 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
9253 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, 0);
9254 create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100_000, 0);
9255 create_announced_chan_between_nodes_with_value(&nodes, 1, 3, 100_000, 0);
9256 create_announced_chan_between_nodes_with_value(&nodes, 2, 3, 100_000, 0);
9258 let (mut route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[3], 15_000_000);
9259 assert_eq!(route.paths.len(), 2);
9260 route.paths.sort_by(|path_a, _| {
9261 // Sort the path so that the path through nodes[1] comes first
9262 if path_a[0].pubkey == nodes[1].node.get_our_node_id() {
9263 core::cmp::Ordering::Less } else { core::cmp::Ordering::Greater }
9266 send_along_route_with_secret(&nodes[0], route.clone(), &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 15_000_000, payment_hash, payment_secret);
9267 // nodes[3] has now received a PaymentClaimable event...which it will take some (exorbitant)
9268 // amount of time to respond to.
9270 // Connect some blocks to time out the payment
9271 connect_blocks(&nodes[3], TEST_FINAL_CLTV);
9272 connect_blocks(&nodes[0], TEST_FINAL_CLTV); // To get the same height for sending later
9274 let failed_destinations = vec![
9275 HTLCDestination::FailedPayment { payment_hash },
9276 HTLCDestination::FailedPayment { payment_hash },
9278 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[3], failed_destinations);
9280 pass_failed_payment_back(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_hash);
9282 // nodes[1] now retries one of the two paths...
9283 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
9284 check_added_monitors!(nodes[0], 2);
9286 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9287 assert_eq!(events.len(), 2);
9288 let (node_1_msgs, _events) = remove_first_msg_event_to_node(&nodes[1].node.get_our_node_id(), &events);
9289 pass_along_path(&nodes[0], &[&nodes[1], &nodes[3]], 15_000_000, payment_hash, Some(payment_secret), node_1_msgs, false, None);
9291 // At this point nodes[3] has received one half of the payment, and the user goes to handle
9292 // that PaymentClaimable event they got hours ago and never handled...we should refuse to claim.
9293 nodes[3].node.claim_funds(payment_preimage);
9294 check_added_monitors!(nodes[3], 0);
9295 assert!(nodes[3].node.get_and_clear_pending_msg_events().is_empty());
9298 /// The possible events which may trigger a `max_dust_htlc_exposure` breach
9299 #[derive(Clone, Copy, PartialEq)]
9300 enum ExposureEvent {
9301 /// Breach occurs at HTLC forwarding (see `send_htlc`)
9303 /// Breach occurs at HTLC reception (see `update_add_htlc`)
9305 /// Breach occurs at outbound update_fee (see `send_update_fee`)
9306 AtUpdateFeeOutbound,
9309 fn do_test_max_dust_htlc_exposure(dust_outbound_balance: bool, exposure_breach_event: ExposureEvent, on_holder_tx: bool) {
9310 // Test that we properly reject dust HTLC violating our `max_dust_htlc_exposure_msat`
9313 // At HTLC forward (`send_payment()`), if the sum of the trimmed-to-dust HTLC inbound and
9314 // trimmed-to-dust HTLC outbound balance and this new payment as included on next
9315 // counterparty commitment are above our `max_dust_htlc_exposure_msat`, we'll reject the
9316 // update. At HTLC reception (`update_add_htlc()`), if the sum of the trimmed-to-dust HTLC
9317 // inbound and trimmed-to-dust HTLC outbound balance and this new received HTLC as included
9318 // on next counterparty commitment are above our `max_dust_htlc_exposure_msat`, we'll fail
9319 // the update. Note, we return a `temporary_channel_failure` (0x1000 | 7), as the channel
9320 // might be available again for HTLC processing once the dust bandwidth has cleared up.
9322 let chanmon_cfgs = create_chanmon_cfgs(2);
9323 let mut config = test_default_channel_config();
9324 config.channel_config.max_dust_htlc_exposure_msat = 5_000_000; // default setting value
9325 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9326 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(config), None]);
9327 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9329 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
9330 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9331 open_channel.max_htlc_value_in_flight_msat = 50_000_000;
9332 open_channel.max_accepted_htlcs = 60;
9334 open_channel.dust_limit_satoshis = 546;
9336 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
9337 let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
9338 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
9340 let opt_anchors = false;
9342 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 1_000_000, 42);
9345 let mut node_0_per_peer_lock;
9346 let mut node_0_peer_state_lock;
9347 let mut chan = get_channel_ref!(nodes[0], nodes[1], node_0_per_peer_lock, node_0_peer_state_lock, temporary_channel_id);
9348 chan.holder_dust_limit_satoshis = 546;
9351 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).unwrap();
9352 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id()));
9353 check_added_monitors!(nodes[1], 1);
9355 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id()));
9356 check_added_monitors!(nodes[0], 1);
9358 let (channel_ready, channel_id) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
9359 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &channel_ready);
9360 update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
9362 let dust_buffer_feerate = {
9363 let per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
9364 let chan_lock = per_peer_state.get(&nodes[1].node.get_our_node_id()).unwrap().lock().unwrap();
9365 let chan = chan_lock.channel_by_id.get(&channel_id).unwrap();
9366 chan.get_dust_buffer_feerate(None) as u64
9368 let dust_outbound_htlc_on_holder_tx_msat: u64 = (dust_buffer_feerate * htlc_timeout_tx_weight(opt_anchors) / 1000 + open_channel.dust_limit_satoshis - 1) * 1000;
9369 let dust_outbound_htlc_on_holder_tx: u64 = config.channel_config.max_dust_htlc_exposure_msat / dust_outbound_htlc_on_holder_tx_msat;
9371 let dust_inbound_htlc_on_holder_tx_msat: u64 = (dust_buffer_feerate * htlc_success_tx_weight(opt_anchors) / 1000 + open_channel.dust_limit_satoshis - 1) * 1000;
9372 let dust_inbound_htlc_on_holder_tx: u64 = config.channel_config.max_dust_htlc_exposure_msat / dust_inbound_htlc_on_holder_tx_msat;
9374 let dust_htlc_on_counterparty_tx: u64 = 25;
9375 let dust_htlc_on_counterparty_tx_msat: u64 = config.channel_config.max_dust_htlc_exposure_msat / dust_htlc_on_counterparty_tx;
9378 if dust_outbound_balance {
9379 // Outbound dust threshold: 2223 sats (`dust_buffer_feerate` * HTLC_TIMEOUT_TX_WEIGHT / 1000 + holder's `dust_limit_satoshis`)
9380 // Outbound dust balance: 4372 sats
9381 // Note, we need sent payment to be above outbound dust threshold on counterparty_tx of 2132 sats
9382 for i in 0..dust_outbound_htlc_on_holder_tx {
9383 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], dust_outbound_htlc_on_holder_tx_msat);
9384 if let Err(_) = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)) { panic!("Unexpected event at dust HTLC {}", i); }
9387 // Inbound dust threshold: 2324 sats (`dust_buffer_feerate` * HTLC_SUCCESS_TX_WEIGHT / 1000 + holder's `dust_limit_satoshis`)
9388 // Inbound dust balance: 4372 sats
9389 // Note, we need sent payment to be above outbound dust threshold on counterparty_tx of 2031 sats
9390 for _ in 0..dust_inbound_htlc_on_holder_tx {
9391 route_payment(&nodes[1], &[&nodes[0]], dust_inbound_htlc_on_holder_tx_msat);
9395 if dust_outbound_balance {
9396 // Outbound dust threshold: 2132 sats (`dust_buffer_feerate` * HTLC_TIMEOUT_TX_WEIGHT / 1000 + counteparty's `dust_limit_satoshis`)
9397 // Outbound dust balance: 5000 sats
9398 for i in 0..dust_htlc_on_counterparty_tx {
9399 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], dust_htlc_on_counterparty_tx_msat);
9400 if let Err(_) = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)) { panic!("Unexpected event at dust HTLC {}", i); }
9403 // Inbound dust threshold: 2031 sats (`dust_buffer_feerate` * HTLC_TIMEOUT_TX_WEIGHT / 1000 + counteparty's `dust_limit_satoshis`)
9404 // Inbound dust balance: 5000 sats
9405 for _ in 0..dust_htlc_on_counterparty_tx {
9406 route_payment(&nodes[1], &[&nodes[0]], dust_htlc_on_counterparty_tx_msat);
9411 let dust_overflow = dust_htlc_on_counterparty_tx_msat * (dust_htlc_on_counterparty_tx + 1);
9412 if exposure_breach_event == ExposureEvent::AtHTLCForward {
9413 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], if on_holder_tx { dust_outbound_htlc_on_holder_tx_msat } else { dust_htlc_on_counterparty_tx_msat });
9414 let mut config = UserConfig::default();
9415 // With default dust exposure: 5000 sats
9417 let dust_outbound_overflow = dust_outbound_htlc_on_holder_tx_msat * (dust_outbound_htlc_on_holder_tx + 1);
9418 let dust_inbound_overflow = dust_inbound_htlc_on_holder_tx_msat * dust_inbound_htlc_on_holder_tx + dust_outbound_htlc_on_holder_tx_msat;
9419 unwrap_send_err!(nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)), true, APIError::ChannelUnavailable { ref err }, assert_eq!(err, &format!("Cannot send value that would put our exposure to dust HTLCs at {} over the limit {} on holder commitment tx", if dust_outbound_balance { dust_outbound_overflow } else { dust_inbound_overflow }, config.channel_config.max_dust_htlc_exposure_msat)));
9421 unwrap_send_err!(nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)), true, APIError::ChannelUnavailable { ref err }, assert_eq!(err, &format!("Cannot send value that would put our exposure to dust HTLCs at {} over the limit {} on counterparty commitment tx", dust_overflow, config.channel_config.max_dust_htlc_exposure_msat)));
9423 } else if exposure_breach_event == ExposureEvent::AtHTLCReception {
9424 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], if on_holder_tx { dust_inbound_htlc_on_holder_tx_msat } else { dust_htlc_on_counterparty_tx_msat });
9425 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
9426 check_added_monitors!(nodes[1], 1);
9427 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
9428 assert_eq!(events.len(), 1);
9429 let payment_event = SendEvent::from_event(events.remove(0));
9430 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
9431 // With default dust exposure: 5000 sats
9433 // Outbound dust balance: 6399 sats
9434 let dust_inbound_overflow = dust_inbound_htlc_on_holder_tx_msat * (dust_inbound_htlc_on_holder_tx + 1);
9435 let dust_outbound_overflow = dust_outbound_htlc_on_holder_tx_msat * dust_outbound_htlc_on_holder_tx + dust_inbound_htlc_on_holder_tx_msat;
9436 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), format!("Cannot accept value that would put our exposure to dust HTLCs at {} over the limit {} on holder commitment tx", if dust_outbound_balance { dust_outbound_overflow } else { dust_inbound_overflow }, config.channel_config.max_dust_htlc_exposure_msat), 1);
9438 // Outbound dust balance: 5200 sats
9439 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), format!("Cannot accept value that would put our exposure to dust HTLCs at {} over the limit {} on counterparty commitment tx", dust_overflow, config.channel_config.max_dust_htlc_exposure_msat), 1);
9441 } else if exposure_breach_event == ExposureEvent::AtUpdateFeeOutbound {
9442 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 2_500_000);
9443 if let Err(_) = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)) { panic!("Unexpected event at update_fee-swallowed HTLC", ); }
9445 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
9446 *feerate_lock = *feerate_lock * 10;
9448 nodes[0].node.timer_tick_occurred();
9449 check_added_monitors!(nodes[0], 1);
9450 nodes[0].logger.assert_log_contains("lightning::ln::channel".to_string(), "Cannot afford to send new feerate at 2530 without infringing max dust htlc exposure".to_string(), 1);
9453 let _ = nodes[0].node.get_and_clear_pending_msg_events();
9454 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
9455 added_monitors.clear();
9459 fn test_max_dust_htlc_exposure() {
9460 do_test_max_dust_htlc_exposure(true, ExposureEvent::AtHTLCForward, true);
9461 do_test_max_dust_htlc_exposure(false, ExposureEvent::AtHTLCForward, true);
9462 do_test_max_dust_htlc_exposure(false, ExposureEvent::AtHTLCReception, true);
9463 do_test_max_dust_htlc_exposure(false, ExposureEvent::AtHTLCReception, false);
9464 do_test_max_dust_htlc_exposure(true, ExposureEvent::AtHTLCForward, false);
9465 do_test_max_dust_htlc_exposure(true, ExposureEvent::AtHTLCReception, false);
9466 do_test_max_dust_htlc_exposure(true, ExposureEvent::AtHTLCReception, true);
9467 do_test_max_dust_htlc_exposure(false, ExposureEvent::AtHTLCForward, false);
9468 do_test_max_dust_htlc_exposure(true, ExposureEvent::AtUpdateFeeOutbound, true);
9469 do_test_max_dust_htlc_exposure(true, ExposureEvent::AtUpdateFeeOutbound, false);
9470 do_test_max_dust_htlc_exposure(false, ExposureEvent::AtUpdateFeeOutbound, false);
9471 do_test_max_dust_htlc_exposure(false, ExposureEvent::AtUpdateFeeOutbound, true);
9475 fn test_non_final_funding_tx() {
9476 let chanmon_cfgs = create_chanmon_cfgs(2);
9477 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9478 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9479 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9481 let temp_channel_id = nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
9482 let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9483 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_message);
9484 let accept_channel_message = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
9485 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel_message);
9487 let best_height = nodes[0].node.best_block.read().unwrap().height();
9489 let chan_id = *nodes[0].network_chan_count.borrow();
9490 let events = nodes[0].node.get_and_clear_pending_events();
9491 let input = TxIn { previous_output: BitcoinOutPoint::null(), script_sig: bitcoin::Script::new(), sequence: Sequence(1), witness: Witness::from_vec(vec!(vec!(1))) };
9492 assert_eq!(events.len(), 1);
9493 let mut tx = match events[0] {
9494 Event::FundingGenerationReady { ref channel_value_satoshis, ref output_script, .. } => {
9495 // Timelock the transaction _beyond_ the best client height + 2.
9496 Transaction { version: chan_id as i32, lock_time: PackedLockTime(best_height + 3), input: vec![input], output: vec![TxOut {
9497 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
9500 _ => panic!("Unexpected event"),
9502 // Transaction should fail as it's evaluated as non-final for propagation.
9503 match nodes[0].node.funding_transaction_generated(&temp_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()) {
9504 Err(APIError::APIMisuseError { err }) => {
9505 assert_eq!(format!("Funding transaction absolute timelock is non-final"), err);
9510 // However, transaction should be accepted if it's in a +2 headroom from best block.
9511 tx.lock_time = PackedLockTime(tx.lock_time.0 - 1);
9512 assert!(nodes[0].node.funding_transaction_generated(&temp_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).is_ok());
9513 get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
9517 fn accept_busted_but_better_fee() {
9518 // If a peer sends us a fee update that is too low, but higher than our previous channel
9519 // feerate, we should accept it. In the future we may want to consider closing the channel
9520 // later, but for now we only accept the update.
9521 let mut chanmon_cfgs = create_chanmon_cfgs(2);
9522 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9523 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9524 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9526 create_chan_between_nodes(&nodes[0], &nodes[1]);
9528 // Set nodes[1] to expect 5,000 sat/kW.
9530 let mut feerate_lock = chanmon_cfgs[1].fee_estimator.sat_per_kw.lock().unwrap();
9531 *feerate_lock = 5000;
9534 // If nodes[0] increases their feerate, even if its not enough, nodes[1] should accept it.
9536 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
9537 *feerate_lock = 1000;
9539 nodes[0].node.timer_tick_occurred();
9540 check_added_monitors!(nodes[0], 1);
9542 let events = nodes[0].node.get_and_clear_pending_msg_events();
9543 assert_eq!(events.len(), 1);
9545 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
9546 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_fee.as_ref().unwrap());
9547 commitment_signed_dance!(nodes[1], nodes[0], commitment_signed, false);
9549 _ => panic!("Unexpected event"),
9552 // If nodes[0] increases their feerate further, even if its not enough, nodes[1] should accept
9555 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
9556 *feerate_lock = 2000;
9558 nodes[0].node.timer_tick_occurred();
9559 check_added_monitors!(nodes[0], 1);
9561 let events = nodes[0].node.get_and_clear_pending_msg_events();
9562 assert_eq!(events.len(), 1);
9564 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
9565 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_fee.as_ref().unwrap());
9566 commitment_signed_dance!(nodes[1], nodes[0], commitment_signed, false);
9568 _ => panic!("Unexpected event"),
9571 // However, if nodes[0] decreases their feerate, nodes[1] should reject it and close the
9574 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
9575 *feerate_lock = 1000;
9577 nodes[0].node.timer_tick_occurred();
9578 check_added_monitors!(nodes[0], 1);
9580 let events = nodes[0].node.get_and_clear_pending_msg_events();
9581 assert_eq!(events.len(), 1);
9583 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
9584 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_fee.as_ref().unwrap());
9585 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError {
9586 err: "Peer's feerate much too low. Actual: 1000. Our expected lower limit: 5000 (- 250)".to_owned() });
9587 check_closed_broadcast!(nodes[1], true);
9588 check_added_monitors!(nodes[1], 1);
9590 _ => panic!("Unexpected event"),
9594 fn do_payment_with_custom_min_final_cltv_expiry(valid_delta: bool, use_user_hash: bool) {
9595 let mut chanmon_cfgs = create_chanmon_cfgs(2);
9596 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9597 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9598 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9599 let min_final_cltv_expiry_delta = 120;
9600 let final_cltv_expiry_delta = if valid_delta { min_final_cltv_expiry_delta + 2 } else {
9601 min_final_cltv_expiry_delta - 2 };
9602 let recv_value = 100_000;
9604 create_chan_between_nodes(&nodes[0], &nodes[1]);
9606 let payment_parameters = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id());
9607 let (payment_hash, payment_preimage, payment_secret) = if use_user_hash {
9608 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1],
9609 Some(recv_value), Some(min_final_cltv_expiry_delta));
9610 (payment_hash, payment_preimage, payment_secret)
9612 let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(recv_value), 7200, Some(min_final_cltv_expiry_delta)).unwrap();
9613 (payment_hash, nodes[1].node.get_payment_preimage(payment_hash, payment_secret).unwrap(), payment_secret)
9615 let route = get_route!(nodes[0], payment_parameters, recv_value, final_cltv_expiry_delta as u32).unwrap();
9616 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
9617 check_added_monitors!(nodes[0], 1);
9618 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9619 assert_eq!(events.len(), 1);
9620 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
9621 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
9622 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
9623 expect_pending_htlcs_forwardable!(nodes[1]);
9626 expect_payment_claimable!(nodes[1], payment_hash, payment_secret, recv_value, if use_user_hash {
9627 None } else { Some(payment_preimage) }, nodes[1].node.get_our_node_id());
9629 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
9631 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
9633 check_added_monitors!(nodes[1], 1);
9635 let fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9636 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_updates.update_fail_htlcs[0]);
9637 commitment_signed_dance!(nodes[0], nodes[1], fail_updates.commitment_signed, false, true);
9639 expect_payment_failed!(nodes[0], payment_hash, true);
9644 fn test_payment_with_custom_min_cltv_expiry_delta() {
9645 do_payment_with_custom_min_final_cltv_expiry(false, false);
9646 do_payment_with_custom_min_final_cltv_expiry(false, true);
9647 do_payment_with_custom_min_final_cltv_expiry(true, false);
9648 do_payment_with_custom_min_final_cltv_expiry(true, true);