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.
17 use chain::channelmonitor;
18 use chain::channelmonitor::{ChannelMonitor, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY};
19 use chain::transaction::OutPoint;
20 use chain::keysinterface::{KeysInterface, BaseSign};
21 use ln::channel::{COMMITMENT_TX_BASE_WEIGHT, COMMITMENT_TX_WEIGHT_PER_HTLC};
22 use ln::channelmanager::{ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentPreimage, PaymentHash, PaymentSecret, PaymentSendFailure, BREAKDOWN_TIMEOUT};
23 use ln::channel::{Channel, ChannelError};
24 use ln::{chan_utils, onion_utils};
25 use routing::router::{Route, RouteHop, get_route};
26 use ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
28 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler,HTLCFailChannelUpdate, ErrorAction};
29 use util::enforcing_trait_impls::EnforcingSigner;
30 use util::{byte_utils, test_utils};
31 use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
32 use util::errors::APIError;
33 use util::ser::{Writeable, ReadableArgs};
34 use util::config::UserConfig;
36 use bitcoin::hashes::sha256d::Hash as Sha256dHash;
37 use bitcoin::hash_types::{Txid, BlockHash};
38 use bitcoin::blockdata::block::{Block, BlockHeader};
39 use bitcoin::blockdata::script::Builder;
40 use bitcoin::blockdata::opcodes;
41 use bitcoin::blockdata::constants::genesis_block;
42 use bitcoin::network::constants::Network;
44 use bitcoin::hashes::sha256::Hash as Sha256;
45 use bitcoin::hashes::Hash;
47 use bitcoin::secp256k1::{Secp256k1, Message};
48 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
52 use std::collections::{BTreeSet, HashMap, HashSet};
53 use std::default::Default;
56 use ln::functional_test_utils::*;
57 use ln::chan_utils::CommitmentTransaction;
58 use ln::msgs::OptionalField::Present;
61 fn test_insane_channel_opens() {
62 // Stand up a network of 2 nodes
63 let chanmon_cfgs = create_chanmon_cfgs(2);
64 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
65 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
66 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
68 // Instantiate channel parameters where we push the maximum msats given our
70 let channel_value_sat = 31337; // same as funding satoshis
71 let channel_reserve_satoshis = Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(channel_value_sat);
72 let push_msat = (channel_value_sat - channel_reserve_satoshis) * 1000;
74 // Have node0 initiate a channel to node1 with aforementioned parameters
75 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_sat, push_msat, 42, None).unwrap();
77 // Extract the channel open message from node0 to node1
78 let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
80 // Test helper that asserts we get the correct error string given a mutator
81 // that supposedly makes the channel open message insane
82 let insane_open_helper = |expected_error_str: &str, message_mutator: fn(msgs::OpenChannel) -> msgs::OpenChannel| {
83 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &message_mutator(open_channel_message.clone()));
84 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
85 assert_eq!(msg_events.len(), 1);
86 let expected_regex = regex::Regex::new(expected_error_str).unwrap();
87 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
89 &ErrorAction::SendErrorMessage { .. } => {
90 nodes[1].logger.assert_log_regex("lightning::ln::channelmanager".to_string(), expected_regex, 1);
92 _ => panic!("unexpected event!"),
94 } else { assert!(false); }
97 use ln::channel::MAX_FUNDING_SATOSHIS;
98 use ln::channelmanager::MAX_LOCAL_BREAKDOWN_TIMEOUT;
100 // Test all mutations that would make the channel open message insane
101 insane_open_helper(format!("Funding must be smaller than {}. It was {}", MAX_FUNDING_SATOSHIS, MAX_FUNDING_SATOSHIS).as_str(), |mut msg| { msg.funding_satoshis = MAX_FUNDING_SATOSHIS; msg });
103 insane_open_helper("Bogus channel_reserve_satoshis", |mut msg| { msg.channel_reserve_satoshis = msg.funding_satoshis + 1; msg });
105 insane_open_helper(r"push_msat \d+ was larger than funding value \d+", |mut msg| { msg.push_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 + 1; msg });
107 insane_open_helper("Peer never wants payout outputs?", |mut msg| { msg.dust_limit_satoshis = msg.funding_satoshis + 1 ; msg });
109 insane_open_helper(r"Bogus; channel reserve \(\d+\) is less than dust limit \(\d+\)", |mut msg| { msg.dust_limit_satoshis = msg.channel_reserve_satoshis + 1; msg });
111 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 });
113 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 });
115 insane_open_helper("0 max_accepted_htlcs makes for a useless channel", |mut msg| { msg.max_accepted_htlcs = 0; msg });
117 insane_open_helper("max_accepted_htlcs was 484. It must not be larger than 483", |mut msg| { msg.max_accepted_htlcs = 484; msg });
121 fn test_async_inbound_update_fee() {
122 let chanmon_cfgs = create_chanmon_cfgs(2);
123 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
124 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
125 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
126 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
127 let logger = test_utils::TestLogger::new();
128 let channel_id = chan.2;
131 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
135 // send (1) commitment_signed -.
136 // <- update_add_htlc/commitment_signed
137 // send (2) RAA (awaiting remote revoke) -.
138 // (1) commitment_signed is delivered ->
139 // .- send (3) RAA (awaiting remote revoke)
140 // (2) RAA is delivered ->
141 // .- send (4) commitment_signed
142 // <- (3) RAA is delivered
143 // send (5) commitment_signed -.
144 // <- (4) commitment_signed is delivered
146 // (5) commitment_signed is delivered ->
148 // (6) RAA is delivered ->
150 // First nodes[0] generates an update_fee
151 nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
152 check_added_monitors!(nodes[0], 1);
154 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
155 assert_eq!(events_0.len(), 1);
156 let (update_msg, commitment_signed) = match events_0[0] { // (1)
157 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
158 (update_fee.as_ref(), commitment_signed)
160 _ => panic!("Unexpected event"),
163 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
165 // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
166 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
167 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
168 nodes[1].node.send_payment(&get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), None, None, &Vec::new(), 40000, TEST_FINAL_CLTV, &logger).unwrap(), our_payment_hash, &None).unwrap();
169 check_added_monitors!(nodes[1], 1);
171 let payment_event = {
172 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
173 assert_eq!(events_1.len(), 1);
174 SendEvent::from_event(events_1.remove(0))
176 assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
177 assert_eq!(payment_event.msgs.len(), 1);
179 // ...now when the messages get delivered everyone should be happy
180 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
181 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
182 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
183 // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
184 check_added_monitors!(nodes[0], 1);
186 // deliver(1), generate (3):
187 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
188 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
189 // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
190 check_added_monitors!(nodes[1], 1);
192 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack); // deliver (2)
193 let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
194 assert!(bs_update.update_add_htlcs.is_empty()); // (4)
195 assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
196 assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
197 assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
198 assert!(bs_update.update_fee.is_none()); // (4)
199 check_added_monitors!(nodes[1], 1);
201 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack); // deliver (3)
202 let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
203 assert!(as_update.update_add_htlcs.is_empty()); // (5)
204 assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
205 assert!(as_update.update_fail_htlcs.is_empty()); // (5)
206 assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
207 assert!(as_update.update_fee.is_none()); // (5)
208 check_added_monitors!(nodes[0], 1);
210 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed); // deliver (4)
211 let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
212 // only (6) so get_event_msg's assert(len == 1) passes
213 check_added_monitors!(nodes[0], 1);
215 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed); // deliver (5)
216 let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
217 check_added_monitors!(nodes[1], 1);
219 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
220 check_added_monitors!(nodes[0], 1);
222 let events_2 = nodes[0].node.get_and_clear_pending_events();
223 assert_eq!(events_2.len(), 1);
225 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
226 _ => panic!("Unexpected event"),
229 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke); // deliver (6)
230 check_added_monitors!(nodes[1], 1);
234 fn test_update_fee_unordered_raa() {
235 // Just the intro to the previous test followed by an out-of-order RAA (which caused a
236 // crash in an earlier version of the update_fee patch)
237 let chanmon_cfgs = create_chanmon_cfgs(2);
238 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
239 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
240 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
241 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
242 let channel_id = chan.2;
243 let logger = test_utils::TestLogger::new();
246 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
248 // First nodes[0] generates an update_fee
249 nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
250 check_added_monitors!(nodes[0], 1);
252 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
253 assert_eq!(events_0.len(), 1);
254 let update_msg = match events_0[0] { // (1)
255 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
258 _ => panic!("Unexpected event"),
261 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
263 // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
264 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
265 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
266 nodes[1].node.send_payment(&get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), None, None, &Vec::new(), 40000, TEST_FINAL_CLTV, &logger).unwrap(), our_payment_hash, &None).unwrap();
267 check_added_monitors!(nodes[1], 1);
269 let payment_event = {
270 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
271 assert_eq!(events_1.len(), 1);
272 SendEvent::from_event(events_1.remove(0))
274 assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
275 assert_eq!(payment_event.msgs.len(), 1);
277 // ...now when the messages get delivered everyone should be happy
278 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
279 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
280 let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
281 // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
282 check_added_monitors!(nodes[0], 1);
284 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg); // deliver (2)
285 check_added_monitors!(nodes[1], 1);
287 // We can't continue, sadly, because our (1) now has a bogus signature
291 fn test_multi_flight_update_fee() {
292 let chanmon_cfgs = create_chanmon_cfgs(2);
293 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
294 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
295 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
296 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
297 let channel_id = chan.2;
300 // update_fee/commitment_signed ->
301 // .- send (1) RAA and (2) commitment_signed
302 // update_fee (never committed) ->
304 // We have to manually generate the above update_fee, it is allowed by the protocol but we
305 // don't track which updates correspond to which revoke_and_ack responses so we're in
306 // AwaitingRAA mode and will not generate the update_fee yet.
307 // <- (1) RAA delivered
308 // (3) is generated and send (4) CS -.
309 // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
310 // know the per_commitment_point to use for it.
311 // <- (2) commitment_signed delivered
313 // B should send no response here
314 // (4) commitment_signed delivered ->
315 // <- RAA/commitment_signed delivered
318 // First nodes[0] generates an update_fee
319 let initial_feerate = get_feerate!(nodes[0], channel_id);
320 nodes[0].node.update_fee(channel_id, initial_feerate + 20).unwrap();
321 check_added_monitors!(nodes[0], 1);
323 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
324 assert_eq!(events_0.len(), 1);
325 let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
326 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
327 (update_fee.as_ref().unwrap(), commitment_signed)
329 _ => panic!("Unexpected event"),
332 // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
333 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1);
334 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1);
335 let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
336 check_added_monitors!(nodes[1], 1);
338 // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
340 nodes[0].node.update_fee(channel_id, initial_feerate + 40).unwrap();
341 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
342 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
344 // Create the (3) update_fee message that nodes[0] will generate before it does...
345 let mut update_msg_2 = msgs::UpdateFee {
346 channel_id: update_msg_1.channel_id.clone(),
347 feerate_per_kw: (initial_feerate + 30) as u32,
350 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
352 update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
354 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
356 // Deliver (1), generating (3) and (4)
357 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg);
358 let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
359 check_added_monitors!(nodes[0], 1);
360 assert!(as_second_update.update_add_htlcs.is_empty());
361 assert!(as_second_update.update_fulfill_htlcs.is_empty());
362 assert!(as_second_update.update_fail_htlcs.is_empty());
363 assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
364 // Check that the update_fee newly generated matches what we delivered:
365 assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
366 assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
368 // Deliver (2) commitment_signed
369 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
370 let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
371 check_added_monitors!(nodes[0], 1);
372 // No commitment_signed so get_event_msg's assert(len == 1) passes
374 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg);
375 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
376 check_added_monitors!(nodes[1], 1);
379 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
380 let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
381 check_added_monitors!(nodes[1], 1);
383 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
384 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
385 check_added_monitors!(nodes[0], 1);
387 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment);
388 let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
389 // No commitment_signed so get_event_msg's assert(len == 1) passes
390 check_added_monitors!(nodes[0], 1);
392 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke);
393 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
394 check_added_monitors!(nodes[1], 1);
397 fn do_test_1_conf_open(connect_style: ConnectStyle) {
398 // Previously, if the minium_depth config was set to 1, we'd never send a funding_locked. This
399 // tests that we properly send one in that case.
400 let mut alice_config = UserConfig::default();
401 alice_config.own_channel_config.minimum_depth = 1;
402 alice_config.channel_options.announced_channel = true;
403 alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
404 let mut bob_config = UserConfig::default();
405 bob_config.own_channel_config.minimum_depth = 1;
406 bob_config.channel_options.announced_channel = true;
407 bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
408 let chanmon_cfgs = create_chanmon_cfgs(2);
409 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
410 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(alice_config), Some(bob_config)]);
411 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
412 *nodes[0].connect_style.borrow_mut() = connect_style;
414 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
415 mine_transaction(&nodes[1], &tx);
416 nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendFundingLocked, nodes[0].node.get_our_node_id()));
418 mine_transaction(&nodes[0], &tx);
419 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
420 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
423 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
424 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
425 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
429 fn test_1_conf_open() {
430 do_test_1_conf_open(ConnectStyle::BestBlockFirst);
431 do_test_1_conf_open(ConnectStyle::TransactionsFirst);
432 do_test_1_conf_open(ConnectStyle::FullBlockViaListen);
435 fn do_test_sanity_on_in_flight_opens(steps: u8) {
436 // Previously, we had issues deserializing channels when we hadn't connected the first block
437 // after creation. To catch that and similar issues, we lean on the Node::drop impl to test
438 // serialization round-trips and simply do steps towards opening a channel and then drop the
441 let chanmon_cfgs = create_chanmon_cfgs(2);
442 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
443 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
444 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
446 if steps & 0b1000_0000 != 0{
448 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
451 connect_block(&nodes[0], &block);
452 connect_block(&nodes[1], &block);
455 if steps & 0x0f == 0 { return; }
456 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
457 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
459 if steps & 0x0f == 1 { return; }
460 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
461 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
463 if steps & 0x0f == 2 { return; }
464 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
466 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
468 if steps & 0x0f == 3 { return; }
469 nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
470 check_added_monitors!(nodes[0], 0);
471 let funding_created = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
473 if steps & 0x0f == 4 { return; }
474 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
476 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
477 assert_eq!(added_monitors.len(), 1);
478 assert_eq!(added_monitors[0].0, funding_output);
479 added_monitors.clear();
481 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
483 if steps & 0x0f == 5 { return; }
484 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
486 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
487 assert_eq!(added_monitors.len(), 1);
488 assert_eq!(added_monitors[0].0, funding_output);
489 added_monitors.clear();
492 let events_4 = nodes[0].node.get_and_clear_pending_events();
493 assert_eq!(events_4.len(), 0);
495 if steps & 0x0f == 6 { return; }
496 create_chan_between_nodes_with_value_confirm_first(&nodes[0], &nodes[1], &tx, 2);
498 if steps & 0x0f == 7 { return; }
499 confirm_transaction_at(&nodes[0], &tx, 2);
500 connect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH);
501 create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
505 fn test_sanity_on_in_flight_opens() {
506 do_test_sanity_on_in_flight_opens(0);
507 do_test_sanity_on_in_flight_opens(0 | 0b1000_0000);
508 do_test_sanity_on_in_flight_opens(1);
509 do_test_sanity_on_in_flight_opens(1 | 0b1000_0000);
510 do_test_sanity_on_in_flight_opens(2);
511 do_test_sanity_on_in_flight_opens(2 | 0b1000_0000);
512 do_test_sanity_on_in_flight_opens(3);
513 do_test_sanity_on_in_flight_opens(3 | 0b1000_0000);
514 do_test_sanity_on_in_flight_opens(4);
515 do_test_sanity_on_in_flight_opens(4 | 0b1000_0000);
516 do_test_sanity_on_in_flight_opens(5);
517 do_test_sanity_on_in_flight_opens(5 | 0b1000_0000);
518 do_test_sanity_on_in_flight_opens(6);
519 do_test_sanity_on_in_flight_opens(6 | 0b1000_0000);
520 do_test_sanity_on_in_flight_opens(7);
521 do_test_sanity_on_in_flight_opens(7 | 0b1000_0000);
522 do_test_sanity_on_in_flight_opens(8);
523 do_test_sanity_on_in_flight_opens(8 | 0b1000_0000);
527 fn test_update_fee_vanilla() {
528 let chanmon_cfgs = create_chanmon_cfgs(2);
529 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
530 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
531 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
532 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
533 let channel_id = chan.2;
535 let feerate = get_feerate!(nodes[0], channel_id);
536 nodes[0].node.update_fee(channel_id, feerate+25).unwrap();
537 check_added_monitors!(nodes[0], 1);
539 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
540 assert_eq!(events_0.len(), 1);
541 let (update_msg, commitment_signed) = match events_0[0] {
542 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 } } => {
543 (update_fee.as_ref(), commitment_signed)
545 _ => panic!("Unexpected event"),
547 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
549 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
550 let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
551 check_added_monitors!(nodes[1], 1);
553 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
554 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
555 check_added_monitors!(nodes[0], 1);
557 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
558 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
559 // No commitment_signed so get_event_msg's assert(len == 1) passes
560 check_added_monitors!(nodes[0], 1);
562 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
563 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
564 check_added_monitors!(nodes[1], 1);
568 fn test_update_fee_that_funder_cannot_afford() {
569 let chanmon_cfgs = create_chanmon_cfgs(2);
570 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
571 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
572 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
573 let channel_value = 1888;
574 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000, InitFeatures::known(), InitFeatures::known());
575 let channel_id = chan.2;
578 nodes[0].node.update_fee(channel_id, feerate).unwrap();
579 check_added_monitors!(nodes[0], 1);
580 let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
582 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap());
584 commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
586 //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
587 //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
589 let commitment_tx = get_local_commitment_txn!(nodes[1], channel_id)[0].clone();
591 //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
592 let num_htlcs = commitment_tx.output.len() - 2;
593 let total_fee: u64 = feerate as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
594 let mut actual_fee = commitment_tx.output.iter().fold(0, |acc, output| acc + output.value);
595 actual_fee = channel_value - actual_fee;
596 assert_eq!(total_fee, actual_fee);
599 //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
600 //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
601 nodes[0].node.update_fee(channel_id, feerate+2).unwrap();
602 check_added_monitors!(nodes[0], 1);
604 let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
606 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap());
608 //While producing the commitment_signed response after handling a received update_fee request the
609 //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
610 //Should produce and error.
611 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed);
612 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Funding remote cannot afford proposed new fee".to_string(), 1);
613 check_added_monitors!(nodes[1], 1);
614 check_closed_broadcast!(nodes[1], true);
618 fn test_update_fee_with_fundee_update_add_htlc() {
619 let chanmon_cfgs = create_chanmon_cfgs(2);
620 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
621 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
622 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
623 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
624 let channel_id = chan.2;
625 let logger = test_utils::TestLogger::new();
628 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
630 let feerate = get_feerate!(nodes[0], channel_id);
631 nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
632 check_added_monitors!(nodes[0], 1);
634 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
635 assert_eq!(events_0.len(), 1);
636 let (update_msg, commitment_signed) = match events_0[0] {
637 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 } } => {
638 (update_fee.as_ref(), commitment_signed)
640 _ => panic!("Unexpected event"),
642 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
643 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
644 let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
645 check_added_monitors!(nodes[1], 1);
647 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[1]);
648 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
649 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), None, None, &Vec::new(), 800000, TEST_FINAL_CLTV, &logger).unwrap();
651 // nothing happens since node[1] is in AwaitingRemoteRevoke
652 nodes[1].node.send_payment(&route, our_payment_hash, &None).unwrap();
654 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
655 assert_eq!(added_monitors.len(), 0);
656 added_monitors.clear();
658 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
659 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
660 // node[1] has nothing to do
662 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
663 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
664 check_added_monitors!(nodes[0], 1);
666 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
667 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
668 // No commitment_signed so get_event_msg's assert(len == 1) passes
669 check_added_monitors!(nodes[0], 1);
670 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
671 check_added_monitors!(nodes[1], 1);
672 // AwaitingRemoteRevoke ends here
674 let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
675 assert_eq!(commitment_update.update_add_htlcs.len(), 1);
676 assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
677 assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
678 assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
679 assert_eq!(commitment_update.update_fee.is_none(), true);
681 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]);
682 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
683 check_added_monitors!(nodes[0], 1);
684 let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
686 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke);
687 check_added_monitors!(nodes[1], 1);
688 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
690 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
691 check_added_monitors!(nodes[1], 1);
692 let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
693 // No commitment_signed so get_event_msg's assert(len == 1) passes
695 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke);
696 check_added_monitors!(nodes[0], 1);
697 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
699 expect_pending_htlcs_forwardable!(nodes[0]);
701 let events = nodes[0].node.get_and_clear_pending_events();
702 assert_eq!(events.len(), 1);
704 Event::PaymentReceived { .. } => { },
705 _ => panic!("Unexpected event"),
708 claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage, 800_000);
710 send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000, 800_000);
711 send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000, 800_000);
712 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
716 fn test_update_fee() {
717 let chanmon_cfgs = create_chanmon_cfgs(2);
718 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
719 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
720 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
721 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
722 let channel_id = chan.2;
725 // (1) update_fee/commitment_signed ->
726 // <- (2) revoke_and_ack
727 // .- send (3) commitment_signed
728 // (4) update_fee/commitment_signed ->
729 // .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
730 // <- (3) commitment_signed delivered
731 // send (6) revoke_and_ack -.
732 // <- (5) deliver revoke_and_ack
733 // (6) deliver revoke_and_ack ->
734 // .- send (7) commitment_signed in response to (4)
735 // <- (7) deliver commitment_signed
738 // Create and deliver (1)...
739 let feerate = get_feerate!(nodes[0], channel_id);
740 nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
741 check_added_monitors!(nodes[0], 1);
743 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
744 assert_eq!(events_0.len(), 1);
745 let (update_msg, commitment_signed) = match events_0[0] {
746 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 } } => {
747 (update_fee.as_ref(), commitment_signed)
749 _ => panic!("Unexpected event"),
751 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
753 // Generate (2) and (3):
754 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
755 let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
756 check_added_monitors!(nodes[1], 1);
759 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
760 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
761 check_added_monitors!(nodes[0], 1);
763 // Create and deliver (4)...
764 nodes[0].node.update_fee(channel_id, feerate+30).unwrap();
765 check_added_monitors!(nodes[0], 1);
766 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
767 assert_eq!(events_0.len(), 1);
768 let (update_msg, commitment_signed) = match events_0[0] {
769 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 } } => {
770 (update_fee.as_ref(), commitment_signed)
772 _ => panic!("Unexpected event"),
775 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
776 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
777 check_added_monitors!(nodes[1], 1);
779 let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
780 // No commitment_signed so get_event_msg's assert(len == 1) passes
782 // Handle (3), creating (6):
783 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0);
784 check_added_monitors!(nodes[0], 1);
785 let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
786 // No commitment_signed so get_event_msg's assert(len == 1) passes
789 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
790 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
791 check_added_monitors!(nodes[0], 1);
793 // Deliver (6), creating (7):
794 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0);
795 let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
796 assert!(commitment_update.update_add_htlcs.is_empty());
797 assert!(commitment_update.update_fulfill_htlcs.is_empty());
798 assert!(commitment_update.update_fail_htlcs.is_empty());
799 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
800 assert!(commitment_update.update_fee.is_none());
801 check_added_monitors!(nodes[1], 1);
804 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
805 check_added_monitors!(nodes[0], 1);
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
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 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
813 assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
814 assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
815 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
819 fn pre_funding_lock_shutdown_test() {
820 // Test sending a shutdown prior to funding_locked after funding generation
821 let chanmon_cfgs = create_chanmon_cfgs(2);
822 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
823 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
824 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
825 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0, InitFeatures::known(), InitFeatures::known());
826 mine_transaction(&nodes[0], &tx);
827 mine_transaction(&nodes[1], &tx);
829 nodes[0].node.close_channel(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id()).unwrap();
830 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
831 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
832 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
833 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
835 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
836 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
837 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
838 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
839 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
840 assert!(node_0_none.is_none());
842 assert!(nodes[0].node.list_channels().is_empty());
843 assert!(nodes[1].node.list_channels().is_empty());
847 fn updates_shutdown_wait() {
848 // Test sending a shutdown with outstanding updates pending
849 let chanmon_cfgs = create_chanmon_cfgs(3);
850 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
851 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
852 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
853 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
854 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
855 let logger = test_utils::TestLogger::new();
857 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
859 nodes[0].node.close_channel(&chan_1.2).unwrap();
860 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
861 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
862 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
863 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
865 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
866 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
868 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
870 let net_graph_msg_handler0 = &nodes[0].net_graph_msg_handler;
871 let net_graph_msg_handler1 = &nodes[1].net_graph_msg_handler;
872 let route_1 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler0.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
873 let route_2 = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler1.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), None, None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
874 unwrap_send_err!(nodes[0].node.send_payment(&route_1, payment_hash, &None), true, APIError::ChannelUnavailable {..}, {});
875 unwrap_send_err!(nodes[1].node.send_payment(&route_2, payment_hash, &None), true, APIError::ChannelUnavailable {..}, {});
877 assert!(nodes[2].node.claim_funds(our_payment_preimage, &None, 100_000));
878 check_added_monitors!(nodes[2], 1);
879 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
880 assert!(updates.update_add_htlcs.is_empty());
881 assert!(updates.update_fail_htlcs.is_empty());
882 assert!(updates.update_fail_malformed_htlcs.is_empty());
883 assert!(updates.update_fee.is_none());
884 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
885 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
886 check_added_monitors!(nodes[1], 1);
887 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
888 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
890 assert!(updates_2.update_add_htlcs.is_empty());
891 assert!(updates_2.update_fail_htlcs.is_empty());
892 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
893 assert!(updates_2.update_fee.is_none());
894 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
895 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
896 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
898 let events = nodes[0].node.get_and_clear_pending_events();
899 assert_eq!(events.len(), 1);
901 Event::PaymentSent { ref payment_preimage } => {
902 assert_eq!(our_payment_preimage, *payment_preimage);
904 _ => panic!("Unexpected event"),
907 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
908 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
909 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
910 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
911 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
912 assert!(node_0_none.is_none());
914 assert!(nodes[0].node.list_channels().is_empty());
916 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
917 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
918 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
919 assert!(nodes[1].node.list_channels().is_empty());
920 assert!(nodes[2].node.list_channels().is_empty());
924 fn htlc_fail_async_shutdown() {
925 // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
926 let chanmon_cfgs = create_chanmon_cfgs(3);
927 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
928 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
929 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
930 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
931 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
932 let logger = test_utils::TestLogger::new();
934 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
935 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
936 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), None, None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
937 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
938 check_added_monitors!(nodes[0], 1);
939 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
940 assert_eq!(updates.update_add_htlcs.len(), 1);
941 assert!(updates.update_fulfill_htlcs.is_empty());
942 assert!(updates.update_fail_htlcs.is_empty());
943 assert!(updates.update_fail_malformed_htlcs.is_empty());
944 assert!(updates.update_fee.is_none());
946 nodes[1].node.close_channel(&chan_1.2).unwrap();
947 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
948 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
949 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
951 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
952 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
953 check_added_monitors!(nodes[1], 1);
954 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
955 commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
957 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
958 assert!(updates_2.update_add_htlcs.is_empty());
959 assert!(updates_2.update_fulfill_htlcs.is_empty());
960 assert_eq!(updates_2.update_fail_htlcs.len(), 1);
961 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
962 assert!(updates_2.update_fee.is_none());
964 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
965 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
967 expect_payment_failed!(nodes[0], our_payment_hash, false);
969 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
970 assert_eq!(msg_events.len(), 2);
971 let node_0_closing_signed = match msg_events[0] {
972 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
973 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
976 _ => panic!("Unexpected event"),
978 match msg_events[1] {
979 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
980 assert_eq!(msg.contents.short_channel_id, chan_1.0.contents.short_channel_id);
982 _ => panic!("Unexpected event"),
985 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
986 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
987 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
988 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
989 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
990 assert!(node_0_none.is_none());
992 assert!(nodes[0].node.list_channels().is_empty());
994 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
995 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
996 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
997 assert!(nodes[1].node.list_channels().is_empty());
998 assert!(nodes[2].node.list_channels().is_empty());
1001 fn do_test_shutdown_rebroadcast(recv_count: u8) {
1002 // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
1003 // messages delivered prior to disconnect
1004 let chanmon_cfgs = create_chanmon_cfgs(3);
1005 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1006 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1007 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1008 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1009 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1011 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
1013 nodes[1].node.close_channel(&chan_1.2).unwrap();
1014 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1016 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
1017 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1019 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
1023 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1024 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1026 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1027 let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1028 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1029 let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1031 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
1032 let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1033 assert!(node_1_shutdown == node_1_2nd_shutdown);
1035 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
1036 let node_0_2nd_shutdown = if recv_count > 0 {
1037 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1038 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_2nd_shutdown);
1041 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1042 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_2nd_shutdown);
1043 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
1045 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_2nd_shutdown);
1047 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1048 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1050 assert!(nodes[2].node.claim_funds(our_payment_preimage, &None, 100_000));
1051 check_added_monitors!(nodes[2], 1);
1052 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1053 assert!(updates.update_add_htlcs.is_empty());
1054 assert!(updates.update_fail_htlcs.is_empty());
1055 assert!(updates.update_fail_malformed_htlcs.is_empty());
1056 assert!(updates.update_fee.is_none());
1057 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1058 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1059 check_added_monitors!(nodes[1], 1);
1060 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1061 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1063 assert!(updates_2.update_add_htlcs.is_empty());
1064 assert!(updates_2.update_fail_htlcs.is_empty());
1065 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
1066 assert!(updates_2.update_fee.is_none());
1067 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
1068 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
1069 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
1071 let events = nodes[0].node.get_and_clear_pending_events();
1072 assert_eq!(events.len(), 1);
1074 Event::PaymentSent { ref payment_preimage } => {
1075 assert_eq!(our_payment_preimage, *payment_preimage);
1077 _ => panic!("Unexpected event"),
1080 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1082 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1083 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1084 assert!(node_1_closing_signed.is_some());
1087 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1088 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1090 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1091 let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1092 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1093 if recv_count == 0 {
1094 // If all closing_signeds weren't delivered we can just resume where we left off...
1095 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1097 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
1098 let node_0_3rd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1099 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
1101 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1102 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1103 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
1105 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_3rd_shutdown);
1106 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1108 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_3rd_shutdown);
1109 let node_0_2nd_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1110 assert!(node_0_closing_signed == node_0_2nd_closing_signed);
1112 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
1113 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1114 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
1115 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1116 assert!(node_0_none.is_none());
1118 // If one node, however, received + responded with an identical closing_signed we end
1119 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
1120 // There isn't really anything better we can do simply, but in the future we might
1121 // explore storing a set of recently-closed channels that got disconnected during
1122 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
1123 // give our counterparty enough time to (potentially) broadcast a cooperative closing
1125 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1127 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1128 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
1129 assert_eq!(msg_events.len(), 1);
1130 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
1132 &ErrorAction::SendErrorMessage { ref msg } => {
1133 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msg);
1134 assert_eq!(msg.channel_id, chan_1.2);
1136 _ => panic!("Unexpected event!"),
1138 } else { panic!("Needed SendErrorMessage close"); }
1140 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
1141 // checks it, but in this case nodes[0] didn't ever get a chance to receive a
1142 // closing_signed so we do it ourselves
1143 check_closed_broadcast!(nodes[0], false);
1144 check_added_monitors!(nodes[0], 1);
1147 assert!(nodes[0].node.list_channels().is_empty());
1149 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1150 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1151 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1152 assert!(nodes[1].node.list_channels().is_empty());
1153 assert!(nodes[2].node.list_channels().is_empty());
1157 fn test_shutdown_rebroadcast() {
1158 do_test_shutdown_rebroadcast(0);
1159 do_test_shutdown_rebroadcast(1);
1160 do_test_shutdown_rebroadcast(2);
1164 fn fake_network_test() {
1165 // Simple test which builds a network of ChannelManagers, connects them to each other, and
1166 // tests that payments get routed and transactions broadcast in semi-reasonable ways.
1167 let chanmon_cfgs = create_chanmon_cfgs(4);
1168 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1169 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1170 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1172 // Create some initial channels
1173 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1174 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1175 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1177 // Rebalance the network a bit by relaying one payment through all the channels...
1178 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1179 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1180 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1181 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1183 // Send some more payments
1184 send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000, 1_000_000);
1185 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000, 1_000_000);
1186 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000, 1_000_000);
1188 // Test failure packets
1189 let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
1190 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
1192 // Add a new channel that skips 3
1193 let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1195 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000, 1_000_000);
1196 send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000, 1_000_000);
1197 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1198 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1199 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1200 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1201 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1203 // Do some rebalance loop payments, simultaneously
1204 let mut hops = Vec::with_capacity(3);
1205 hops.push(RouteHop {
1206 pubkey: nodes[2].node.get_our_node_id(),
1207 node_features: NodeFeatures::empty(),
1208 short_channel_id: chan_2.0.contents.short_channel_id,
1209 channel_features: ChannelFeatures::empty(),
1211 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
1213 hops.push(RouteHop {
1214 pubkey: nodes[3].node.get_our_node_id(),
1215 node_features: NodeFeatures::empty(),
1216 short_channel_id: chan_3.0.contents.short_channel_id,
1217 channel_features: ChannelFeatures::empty(),
1219 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
1221 hops.push(RouteHop {
1222 pubkey: nodes[1].node.get_our_node_id(),
1223 node_features: NodeFeatures::empty(),
1224 short_channel_id: chan_4.0.contents.short_channel_id,
1225 channel_features: ChannelFeatures::empty(),
1227 cltv_expiry_delta: TEST_FINAL_CLTV,
1229 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;
1230 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;
1231 let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
1233 let mut hops = Vec::with_capacity(3);
1234 hops.push(RouteHop {
1235 pubkey: nodes[3].node.get_our_node_id(),
1236 node_features: NodeFeatures::empty(),
1237 short_channel_id: chan_4.0.contents.short_channel_id,
1238 channel_features: ChannelFeatures::empty(),
1240 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
1242 hops.push(RouteHop {
1243 pubkey: nodes[2].node.get_our_node_id(),
1244 node_features: NodeFeatures::empty(),
1245 short_channel_id: chan_3.0.contents.short_channel_id,
1246 channel_features: ChannelFeatures::empty(),
1248 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
1250 hops.push(RouteHop {
1251 pubkey: nodes[1].node.get_our_node_id(),
1252 node_features: NodeFeatures::empty(),
1253 short_channel_id: chan_2.0.contents.short_channel_id,
1254 channel_features: ChannelFeatures::empty(),
1256 cltv_expiry_delta: TEST_FINAL_CLTV,
1258 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;
1259 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;
1260 let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1262 // Claim the rebalances...
1263 fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1264 claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1, 1_000_000);
1266 // Add a duplicate new channel from 2 to 4
1267 let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1269 // Send some payments across both channels
1270 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1271 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1272 let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1275 route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
1276 let events = nodes[0].node.get_and_clear_pending_msg_events();
1277 assert_eq!(events.len(), 0);
1278 nodes[0].logger.assert_log_regex("lightning::ln::channelmanager".to_string(), regex::Regex::new(r"Cannot send value that would put us over the max HTLC value in flight our peer will accept \(\d+\)").unwrap(), 1);
1280 //TODO: Test that routes work again here as we've been notified that the channel is full
1282 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3, 3_000_000);
1283 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4, 3_000_000);
1284 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5, 3_000_000);
1286 // Close down the channels...
1287 close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1288 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1289 close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1290 close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1291 close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
1295 fn holding_cell_htlc_counting() {
1296 // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1297 // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1298 // commitment dance rounds.
1299 let chanmon_cfgs = create_chanmon_cfgs(3);
1300 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1301 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1302 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1303 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1304 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1305 let logger = test_utils::TestLogger::new();
1307 let mut payments = Vec::new();
1308 for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1309 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1310 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1311 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), None, None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1312 nodes[1].node.send_payment(&route, payment_hash, &None).unwrap();
1313 payments.push((payment_preimage, payment_hash));
1315 check_added_monitors!(nodes[1], 1);
1317 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1318 assert_eq!(events.len(), 1);
1319 let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1320 assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1322 // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1323 // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1325 let (_, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
1327 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1328 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), None, None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1329 unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash_1, &None), true, APIError::ChannelUnavailable { ref err },
1330 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
1331 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1332 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1335 // This should also be true if we try to forward a payment.
1336 let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
1338 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1339 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), None, None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1340 nodes[0].node.send_payment(&route, payment_hash_2, &None).unwrap();
1341 check_added_monitors!(nodes[0], 1);
1344 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1345 assert_eq!(events.len(), 1);
1346 let payment_event = SendEvent::from_event(events.pop().unwrap());
1347 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1349 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1350 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1351 // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1352 // fails), the second will process the resulting failure and fail the HTLC backward.
1353 expect_pending_htlcs_forwardable!(nodes[1]);
1354 expect_pending_htlcs_forwardable!(nodes[1]);
1355 check_added_monitors!(nodes[1], 1);
1357 let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1358 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1359 commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1361 let events = nodes[0].node.get_and_clear_pending_msg_events();
1362 assert_eq!(events.len(), 1);
1364 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
1365 assert_eq!(msg.contents.short_channel_id, chan_2.0.contents.short_channel_id);
1367 _ => panic!("Unexpected event"),
1370 expect_payment_failed!(nodes[0], payment_hash_2, false);
1372 // Now forward all the pending HTLCs and claim them back
1373 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1374 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1375 check_added_monitors!(nodes[2], 1);
1377 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1378 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1379 check_added_monitors!(nodes[1], 1);
1380 let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1382 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1383 check_added_monitors!(nodes[1], 1);
1384 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1386 for ref update in as_updates.update_add_htlcs.iter() {
1387 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1389 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1390 check_added_monitors!(nodes[2], 1);
1391 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1392 check_added_monitors!(nodes[2], 1);
1393 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1395 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1396 check_added_monitors!(nodes[1], 1);
1397 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1398 check_added_monitors!(nodes[1], 1);
1399 let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1401 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1402 check_added_monitors!(nodes[2], 1);
1404 expect_pending_htlcs_forwardable!(nodes[2]);
1406 let events = nodes[2].node.get_and_clear_pending_events();
1407 assert_eq!(events.len(), payments.len());
1408 for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1410 &Event::PaymentReceived { ref payment_hash, .. } => {
1411 assert_eq!(*payment_hash, *hash);
1413 _ => panic!("Unexpected event"),
1417 for (preimage, _) in payments.drain(..) {
1418 claim_payment(&nodes[1], &[&nodes[2]], preimage, 100_000);
1421 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000, 1_000_000);
1425 fn duplicate_htlc_test() {
1426 // Test that we accept duplicate payment_hash HTLCs across the network and that
1427 // claiming/failing them are all separate and don't affect each other
1428 let chanmon_cfgs = create_chanmon_cfgs(6);
1429 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1430 let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1431 let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1433 // Create some initial channels to route via 3 to 4/5 from 0/1/2
1434 create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
1435 create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1436 create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1437 create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
1438 create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
1440 let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1442 *nodes[0].network_payment_count.borrow_mut() -= 1;
1443 assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1445 *nodes[0].network_payment_count.borrow_mut() -= 1;
1446 assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1448 claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage, 1_000_000);
1449 fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1450 claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage, 1_000_000);
1454 fn test_duplicate_htlc_different_direction_onchain() {
1455 // Test that ChannelMonitor doesn't generate 2 preimage txn
1456 // when we have 2 HTLCs with same preimage that go across a node
1457 // in opposite directions.
1458 let chanmon_cfgs = create_chanmon_cfgs(2);
1459 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1460 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1461 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1463 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1464 let logger = test_utils::TestLogger::new();
1467 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
1469 let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1471 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1472 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), None, None, &Vec::new(), 800_000, TEST_FINAL_CLTV, &logger).unwrap();
1473 send_along_route_with_hash(&nodes[1], route, &vec!(&nodes[0])[..], 800_000, payment_hash);
1475 // Provide preimage to node 0 by claiming payment
1476 nodes[0].node.claim_funds(payment_preimage, &None, 800_000);
1477 check_added_monitors!(nodes[0], 1);
1479 // Broadcast node 1 commitment txn
1480 let remote_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
1482 assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1483 let mut has_both_htlcs = 0; // check htlcs match ones committed
1484 for outp in remote_txn[0].output.iter() {
1485 if outp.value == 800_000 / 1000 {
1486 has_both_htlcs += 1;
1487 } else if outp.value == 900_000 / 1000 {
1488 has_both_htlcs += 1;
1491 assert_eq!(has_both_htlcs, 2);
1493 mine_transaction(&nodes[0], &remote_txn[0]);
1494 check_added_monitors!(nodes[0], 1);
1496 // Check we only broadcast 1 timeout tx
1497 let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1498 let htlc_pair = if claim_txn[0].output[0].value == 800_000 / 1000 { (claim_txn[0].clone(), claim_txn[1].clone()) } else { (claim_txn[1].clone(), claim_txn[0].clone()) };
1499 assert_eq!(claim_txn.len(), 5);
1500 check_spends!(claim_txn[2], chan_1.3);
1501 check_spends!(claim_txn[3], claim_txn[2]);
1502 assert_eq!(htlc_pair.0.input.len(), 1);
1503 assert_eq!(htlc_pair.0.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1504 check_spends!(htlc_pair.0, remote_txn[0]);
1505 assert_eq!(htlc_pair.1.input.len(), 1);
1506 assert_eq!(htlc_pair.1.input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1507 check_spends!(htlc_pair.1, remote_txn[0]);
1509 let events = nodes[0].node.get_and_clear_pending_msg_events();
1510 assert_eq!(events.len(), 3);
1513 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1514 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1515 assert_eq!(node_id, nodes[1].node.get_our_node_id());
1516 assert_eq!(msg.data, "Commitment or closing transaction was confirmed on chain.");
1518 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, .. } } => {
1519 assert!(update_add_htlcs.is_empty());
1520 assert!(update_fail_htlcs.is_empty());
1521 assert_eq!(update_fulfill_htlcs.len(), 1);
1522 assert!(update_fail_malformed_htlcs.is_empty());
1523 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1525 _ => panic!("Unexpected event"),
1531 fn test_basic_channel_reserve() {
1532 let chanmon_cfgs = create_chanmon_cfgs(2);
1533 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1534 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1535 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1536 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1537 let logger = test_utils::TestLogger::new();
1539 let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1540 let channel_reserve = chan_stat.channel_reserve_msat;
1542 // The 2* and +1 are for the fee spike reserve.
1543 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
1544 let commit_tx_fee = 2 * commit_tx_fee_msat(get_feerate!(nodes[0], chan.2), 1 + 1);
1545 let max_can_send = 5000000 - channel_reserve - commit_tx_fee;
1546 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1547 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes.last().unwrap().node.get_our_node_id(), None, None, &Vec::new(), max_can_send + 1, TEST_FINAL_CLTV, &logger).unwrap();
1548 let err = nodes[0].node.send_payment(&route, our_payment_hash, &None).err().unwrap();
1550 PaymentSendFailure::AllFailedRetrySafe(ref fails) => {
1552 &APIError::ChannelUnavailable{ref err} =>
1553 assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)),
1554 _ => panic!("Unexpected error variant"),
1557 _ => panic!("Unexpected error variant"),
1559 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1560 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);
1562 send_payment(&nodes[0], &vec![&nodes[1]], max_can_send, max_can_send);
1566 fn test_fee_spike_violation_fails_htlc() {
1567 let chanmon_cfgs = create_chanmon_cfgs(2);
1568 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1569 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1570 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1571 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1573 let (route, payment_hash, _) = get_route_and_payment_hash!(nodes[0], nodes[1], 3460001);
1574 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1575 let secp_ctx = Secp256k1::new();
1576 let session_priv = SecretKey::from_slice(&[42; 32]).expect("RNG is bad!");
1578 let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1580 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1581 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3460001, &None, cur_height).unwrap();
1582 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1583 let msg = msgs::UpdateAddHTLC {
1586 amount_msat: htlc_msat,
1587 payment_hash: payment_hash,
1588 cltv_expiry: htlc_cltv,
1589 onion_routing_packet: onion_packet,
1592 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1594 // Now manually create the commitment_signed message corresponding to the update_add
1595 // nodes[0] just sent. In the code for construction of this message, "local" refers
1596 // to the sender of the message, and "remote" refers to the receiver.
1598 let feerate_per_kw = get_feerate!(nodes[0], chan.2);
1600 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
1602 // Get the EnforcingSigner for each channel, which will be used to (1) get the keys
1603 // needed to sign the new commitment tx and (2) sign the new commitment tx.
1604 let (local_revocation_basepoint, local_htlc_basepoint, local_secret, next_local_point) = {
1605 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
1606 let local_chan = chan_lock.by_id.get(&chan.2).unwrap();
1607 let chan_signer = local_chan.get_signer();
1608 let pubkeys = chan_signer.pubkeys();
1609 (pubkeys.revocation_basepoint, pubkeys.htlc_basepoint,
1610 chan_signer.release_commitment_secret(INITIAL_COMMITMENT_NUMBER),
1611 chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 2, &secp_ctx))
1613 let (remote_delayed_payment_basepoint, remote_htlc_basepoint,remote_point) = {
1614 let chan_lock = nodes[1].node.channel_state.lock().unwrap();
1615 let remote_chan = chan_lock.by_id.get(&chan.2).unwrap();
1616 let chan_signer = remote_chan.get_signer();
1617 let pubkeys = chan_signer.pubkeys();
1618 (pubkeys.delayed_payment_basepoint, pubkeys.htlc_basepoint,
1619 chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 1, &secp_ctx))
1622 // Assemble the set of keys we can use for signatures for our commitment_signed message.
1623 let commit_tx_keys = chan_utils::TxCreationKeys::derive_new(&secp_ctx, &remote_point, &remote_delayed_payment_basepoint,
1624 &remote_htlc_basepoint, &local_revocation_basepoint, &local_htlc_basepoint).unwrap();
1626 // Build the remote commitment transaction so we can sign it, and then later use the
1627 // signature for the commitment_signed message.
1628 let local_chan_balance = 1313;
1630 let accepted_htlc_info = chan_utils::HTLCOutputInCommitment {
1632 amount_msat: 3460001,
1633 cltv_expiry: htlc_cltv,
1635 transaction_output_index: Some(1),
1638 let commitment_number = INITIAL_COMMITMENT_NUMBER - 1;
1641 let local_chan_lock = nodes[0].node.channel_state.lock().unwrap();
1642 let local_chan = local_chan_lock.by_id.get(&chan.2).unwrap();
1643 let local_chan_signer = local_chan.get_signer();
1644 let commitment_tx = CommitmentTransaction::new_with_auxiliary_htlc_data(
1648 commit_tx_keys.clone(),
1650 &mut vec![(accepted_htlc_info, ())],
1651 &local_chan.channel_transaction_parameters.as_counterparty_broadcastable()
1653 local_chan_signer.sign_counterparty_commitment(&commitment_tx, &secp_ctx).unwrap()
1656 let commit_signed_msg = msgs::CommitmentSigned {
1659 htlc_signatures: res.1
1662 // Send the commitment_signed message to the nodes[1].
1663 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commit_signed_msg);
1664 let _ = nodes[1].node.get_and_clear_pending_msg_events();
1666 // Send the RAA to nodes[1].
1667 let raa_msg = msgs::RevokeAndACK {
1669 per_commitment_secret: local_secret,
1670 next_per_commitment_point: next_local_point
1672 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_msg);
1674 let events = nodes[1].node.get_and_clear_pending_msg_events();
1675 assert_eq!(events.len(), 1);
1676 // Make sure the HTLC failed in the way we expect.
1678 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, .. }, .. } => {
1679 assert_eq!(update_fail_htlcs.len(), 1);
1680 update_fail_htlcs[0].clone()
1682 _ => panic!("Unexpected event"),
1684 nodes[1].logger.assert_log("lightning::ln::channel".to_string(), "Attempting to fail HTLC due to fee spike buffer violation".to_string(), 1);
1686 check_added_monitors!(nodes[1], 2);
1690 fn test_chan_reserve_violation_outbound_htlc_inbound_chan() {
1691 let mut chanmon_cfgs = create_chanmon_cfgs(2);
1692 // Set the fee rate for the channel very high, to the point where the fundee
1693 // sending any above-dust amount would result in a channel reserve violation.
1694 // In this test we check that we would be prevented from sending an HTLC in
1696 chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1697 chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1698 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1699 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1700 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1701 let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1703 let (route, our_payment_hash, _) = get_route_and_payment_hash!(nodes[1], nodes[0], 4843000);
1704 unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
1705 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1706 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1707 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);
1711 fn test_chan_reserve_violation_inbound_htlc_outbound_channel() {
1712 let mut chanmon_cfgs = create_chanmon_cfgs(2);
1713 // Set the fee rate for the channel very high, to the point where the funder
1714 // receiving 1 update_add_htlc would result in them closing the channel due
1715 // to channel reserve violation. This close could also happen if the fee went
1716 // up a more realistic amount, but many HTLCs were outstanding at the time of
1717 // the update_add_htlc.
1718 chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1719 chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1720 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1721 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1722 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1723 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1725 let (route, payment_hash, _) = get_route_and_payment_hash!(nodes[1], nodes[0], 1000);
1726 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1727 let secp_ctx = Secp256k1::new();
1728 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1729 let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1730 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1731 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 1000, &None, cur_height).unwrap();
1732 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1733 let msg = msgs::UpdateAddHTLC {
1736 amount_msat: htlc_msat + 1,
1737 payment_hash: payment_hash,
1738 cltv_expiry: htlc_cltv,
1739 onion_routing_packet: onion_packet,
1742 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &msg);
1743 // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1744 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);
1745 assert_eq!(nodes[0].node.list_channels().len(), 0);
1746 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
1747 assert_eq!(err_msg.data, "Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value");
1748 check_added_monitors!(nodes[0], 1);
1752 fn test_chan_reserve_dust_inbound_htlcs_outbound_chan() {
1753 // Test that if we receive many dust HTLCs over an outbound channel, they don't count when
1754 // calculating our commitment transaction fee (this was previously broken).
1755 let chanmon_cfgs = create_chanmon_cfgs(2);
1756 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1757 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1758 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1760 // Set nodes[0]'s balance such that they will consider any above-dust received HTLC to be a
1761 // channel reserve violation (so their balance is channel reserve (1000 sats) + commitment
1762 // transaction fee with 0 HTLCs (183 sats)).
1763 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98817000, InitFeatures::known(), InitFeatures::known());
1765 let dust_amt = 546000; // Dust amount
1766 // In the previous code, routing this dust payment would cause nodes[0] to perceive a channel
1767 // reserve violation even though it's a dust HTLC and therefore shouldn't count towards the
1768 // commitment transaction fee.
1769 let (_, _) = route_payment(&nodes[1], &[&nodes[0]], dust_amt);
1773 fn test_chan_reserve_dust_inbound_htlcs_inbound_chan() {
1774 // Test that if we receive many dust HTLCs over an inbound channel, they don't count when
1775 // calculating our counterparty's commitment transaction fee (this was previously broken).
1776 let chanmon_cfgs = create_chanmon_cfgs(2);
1777 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1778 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1779 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1780 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98000000, InitFeatures::known(), InitFeatures::known());
1782 let payment_amt = 46000; // Dust amount
1783 // In the previous code, these first four payments would succeed.
1784 let (_, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1785 let (_, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1786 let (_, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1787 let (_, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1789 // Then these next 5 would be interpreted by nodes[1] as violating the fee spike buffer.
1790 let (_, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1791 let (_, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1792 let (_, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1793 let (_, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1794 let (_, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1796 // And this last payment previously resulted in nodes[1] closing on its inbound-channel
1797 // counterparty, because it counted all the previous dust HTLCs against nodes[0]'s commitment
1798 // transaction fee and therefore perceived this next payment as a channel reserve violation.
1799 let (_, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1803 fn test_chan_reserve_violation_inbound_htlc_inbound_chan() {
1804 let chanmon_cfgs = create_chanmon_cfgs(3);
1805 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1806 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1807 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1808 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1809 let _ = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1812 let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1813 let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1814 let feerate = get_feerate!(nodes[0], chan.2);
1816 // Add a 2* and +1 for the fee spike reserve.
1817 let commit_tx_fee_2_htlc = 2*commit_tx_fee_msat(feerate, 2 + 1);
1818 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;
1819 let amt_msat_1 = recv_value_1 + total_routing_fee_msat;
1821 // Add a pending HTLC.
1822 let (route_1, our_payment_hash_1, _) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_1);
1823 let payment_event_1 = {
1824 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &None).unwrap();
1825 check_added_monitors!(nodes[0], 1);
1827 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1828 assert_eq!(events.len(), 1);
1829 SendEvent::from_event(events.remove(0))
1831 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1833 // Attempt to trigger a channel reserve violation --> payment failure.
1834 let commit_tx_fee_2_htlcs = commit_tx_fee_msat(feerate, 2);
1835 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;
1836 let amt_msat_2 = recv_value_2 + total_routing_fee_msat;
1837 let (route_2, _, _) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_2);
1839 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1840 let secp_ctx = Secp256k1::new();
1841 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1842 let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
1843 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route_2.paths[0], &session_priv).unwrap();
1844 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route_2.paths[0], recv_value_2, &None, cur_height).unwrap();
1845 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash_1);
1846 let msg = msgs::UpdateAddHTLC {
1849 amount_msat: htlc_msat + 1,
1850 payment_hash: our_payment_hash_1,
1851 cltv_expiry: htlc_cltv,
1852 onion_routing_packet: onion_packet,
1855 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1856 // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1857 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote HTLC add would put them under remote reserve value".to_string(), 1);
1858 assert_eq!(nodes[1].node.list_channels().len(), 1);
1859 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1860 assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
1861 check_added_monitors!(nodes[1], 1);
1865 fn test_inbound_outbound_capacity_is_not_zero() {
1866 let chanmon_cfgs = create_chanmon_cfgs(2);
1867 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1868 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1869 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1870 let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1871 let channels0 = node_chanmgrs[0].list_channels();
1872 let channels1 = node_chanmgrs[1].list_channels();
1873 assert_eq!(channels0.len(), 1);
1874 assert_eq!(channels1.len(), 1);
1876 assert_eq!(channels0[0].inbound_capacity_msat, 95000000);
1877 assert_eq!(channels1[0].outbound_capacity_msat, 95000000);
1879 assert_eq!(channels0[0].outbound_capacity_msat, 100000 * 1000 - 95000000);
1880 assert_eq!(channels1[0].inbound_capacity_msat, 100000 * 1000 - 95000000);
1883 fn commit_tx_fee_msat(feerate: u32, num_htlcs: u64) -> u64 {
1884 (COMMITMENT_TX_BASE_WEIGHT + num_htlcs * COMMITMENT_TX_WEIGHT_PER_HTLC) * feerate as u64 / 1000 * 1000
1888 fn test_channel_reserve_holding_cell_htlcs() {
1889 let chanmon_cfgs = create_chanmon_cfgs(3);
1890 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1891 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1892 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1893 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1894 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1896 let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1897 let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1899 let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1900 let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1902 macro_rules! expect_forward {
1904 let mut events = $node.node.get_and_clear_pending_msg_events();
1905 assert_eq!(events.len(), 1);
1906 check_added_monitors!($node, 1);
1907 let payment_event = SendEvent::from_event(events.remove(0));
1912 let feemsat = 239; // somehow we know?
1913 let total_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1914 let feerate = get_feerate!(nodes[0], chan_1.2);
1916 let recv_value_0 = stat01.counterparty_max_htlc_value_in_flight_msat - total_fee_msat;
1918 // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1920 let (mut route, our_payment_hash, _) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_0);
1921 route.paths[0].last_mut().unwrap().fee_msat += 1;
1922 assert!(route.paths[0].iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1923 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
1924 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)));
1925 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1926 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);
1929 // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1930 // nodes[0]'s wealth
1932 let amt_msat = recv_value_0 + total_fee_msat;
1933 // 3 for the 3 HTLCs that will be sent, 2* and +1 for the fee spike reserve.
1934 // Also, ensure that each payment has enough to be over the dust limit to
1935 // ensure it'll be included in each commit tx fee calculation.
1936 let commit_tx_fee_all_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1937 let ensure_htlc_amounts_above_dust_buffer = 3 * (stat01.counterparty_dust_limit_msat + 1000);
1938 if stat01.value_to_self_msat < stat01.channel_reserve_msat + commit_tx_fee_all_htlcs + ensure_htlc_amounts_above_dust_buffer + amt_msat {
1941 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0, recv_value_0);
1943 let (stat01_, stat11_, stat12_, stat22_) = (
1944 get_channel_value_stat!(nodes[0], chan_1.2),
1945 get_channel_value_stat!(nodes[1], chan_1.2),
1946 get_channel_value_stat!(nodes[1], chan_2.2),
1947 get_channel_value_stat!(nodes[2], chan_2.2),
1950 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1951 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1952 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1953 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1954 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1957 // adding pending output.
1958 // 2* and +1 HTLCs on the commit tx fee for the fee spike reserve.
1959 // The reason we're dividing by two here is as follows: the dividend is the total outbound liquidity
1960 // after fees, the channel reserve, and the fee spike buffer are removed. We eventually want to
1961 // divide this quantity into 3 portions, that will each be sent in an HTLC. This allows us
1962 // to test channel channel reserve policy at the edges of what amount is sendable, i.e.
1963 // cases where 1 msat over X amount will cause a payment failure, but anything less than
1964 // that can be sent successfully. So, dividing by two is a somewhat arbitrary way of getting
1965 // the amount of the first of these aforementioned 3 payments. The reason we split into 3 payments
1966 // is to test the behavior of the holding cell with respect to channel reserve and commit tx fee
1968 let commit_tx_fee_2_htlcs = 2*commit_tx_fee_msat(feerate, 2 + 1);
1969 let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs)/2;
1970 let amt_msat_1 = recv_value_1 + total_fee_msat;
1972 let (route_1, our_payment_hash_1, our_payment_preimage_1) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_1);
1973 let payment_event_1 = {
1974 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &None).unwrap();
1975 check_added_monitors!(nodes[0], 1);
1977 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1978 assert_eq!(events.len(), 1);
1979 SendEvent::from_event(events.remove(0))
1981 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1983 // channel reserve test with htlc pending output > 0
1984 let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs;
1986 let (route, our_payment_hash, _) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_2 + 1);
1987 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
1988 assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
1989 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1992 // split the rest to test holding cell
1993 let commit_tx_fee_3_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1994 let additional_htlc_cost_msat = commit_tx_fee_3_htlcs - commit_tx_fee_2_htlcs;
1995 let recv_value_21 = recv_value_2/2 - additional_htlc_cost_msat/2;
1996 let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat - additional_htlc_cost_msat;
1998 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
1999 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);
2002 // now see if they go through on both sides
2003 let (route_21, our_payment_hash_21, our_payment_preimage_21) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_21);
2004 // but this will stuck in the holding cell
2005 nodes[0].node.send_payment(&route_21, our_payment_hash_21, &None).unwrap();
2006 check_added_monitors!(nodes[0], 0);
2007 let events = nodes[0].node.get_and_clear_pending_events();
2008 assert_eq!(events.len(), 0);
2010 // test with outbound holding cell amount > 0
2012 let (route, our_payment_hash, _) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_22+1);
2013 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
2014 assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
2015 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2016 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);
2019 let (route_22, our_payment_hash_22, our_payment_preimage_22) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_22);
2020 // this will also stuck in the holding cell
2021 nodes[0].node.send_payment(&route_22, our_payment_hash_22, &None).unwrap();
2022 check_added_monitors!(nodes[0], 0);
2023 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
2024 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2026 // flush the pending htlc
2027 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
2028 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2029 check_added_monitors!(nodes[1], 1);
2031 // the pending htlc should be promoted to committed
2032 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
2033 check_added_monitors!(nodes[0], 1);
2034 let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2036 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
2037 let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2038 // No commitment_signed so get_event_msg's assert(len == 1) passes
2039 check_added_monitors!(nodes[0], 1);
2041 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
2042 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2043 check_added_monitors!(nodes[1], 1);
2045 expect_pending_htlcs_forwardable!(nodes[1]);
2047 let ref payment_event_11 = expect_forward!(nodes[1]);
2048 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
2049 commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
2051 expect_pending_htlcs_forwardable!(nodes[2]);
2052 expect_payment_received!(nodes[2], our_payment_hash_1, recv_value_1);
2054 // flush the htlcs in the holding cell
2055 assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
2056 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
2057 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
2058 commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
2059 expect_pending_htlcs_forwardable!(nodes[1]);
2061 let ref payment_event_3 = expect_forward!(nodes[1]);
2062 assert_eq!(payment_event_3.msgs.len(), 2);
2063 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
2064 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
2066 commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
2067 expect_pending_htlcs_forwardable!(nodes[2]);
2069 let events = nodes[2].node.get_and_clear_pending_events();
2070 assert_eq!(events.len(), 2);
2072 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
2073 assert_eq!(our_payment_hash_21, *payment_hash);
2074 assert_eq!(*payment_secret, None);
2075 assert_eq!(recv_value_21, amt);
2077 _ => panic!("Unexpected event"),
2080 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
2081 assert_eq!(our_payment_hash_22, *payment_hash);
2082 assert_eq!(None, *payment_secret);
2083 assert_eq!(recv_value_22, amt);
2085 _ => panic!("Unexpected event"),
2088 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1, recv_value_1);
2089 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21, recv_value_21);
2090 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22, recv_value_22);
2092 let commit_tx_fee_0_htlcs = 2*commit_tx_fee_msat(feerate, 1);
2093 let recv_value_3 = commit_tx_fee_2_htlcs - commit_tx_fee_0_htlcs - total_fee_msat;
2094 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_3, recv_value_3);
2096 let commit_tx_fee_1_htlc = 2*commit_tx_fee_msat(feerate, 1 + 1);
2097 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);
2098 let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
2099 assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
2100 assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat + commit_tx_fee_1_htlc);
2102 let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
2103 assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22 + recv_value_3);
2107 fn channel_reserve_in_flight_removes() {
2108 // In cases where one side claims an HTLC, it thinks it has additional available funds that it
2109 // can send to its counterparty, but due to update ordering, the other side may not yet have
2110 // considered those HTLCs fully removed.
2111 // This tests that we don't count HTLCs which will not be included in the next remote
2112 // commitment transaction towards the reserve value (as it implies no commitment transaction
2113 // will be generated which violates the remote reserve value).
2114 // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
2116 // * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
2117 // you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
2118 // you only consider the value of the first HTLC, it may not),
2119 // * start routing a third HTLC from A to B,
2120 // * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
2121 // the other claim in its holding cell, as it immediately goes into AwaitingRAA),
2122 // * deliver the first fulfill from B
2123 // * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
2125 // * deliver A's response CS and RAA.
2126 // This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
2127 // removed it fully. B now has the push_msat plus the first two HTLCs in value.
2128 // * Now B happily sends another HTLC, potentially violating its reserve value from A's point
2129 // of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
2130 let chanmon_cfgs = create_chanmon_cfgs(2);
2131 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2132 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2133 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2134 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2135 let logger = test_utils::TestLogger::new();
2137 let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
2138 // Route the first two HTLCs.
2139 let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
2140 let (payment_preimage_2, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
2142 // Start routing the third HTLC (this is just used to get everyone in the right state).
2143 let (payment_preimage_3, payment_hash_3) = get_payment_preimage_hash!(nodes[0]);
2145 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
2146 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
2147 nodes[0].node.send_payment(&route, payment_hash_3, &None).unwrap();
2148 check_added_monitors!(nodes[0], 1);
2149 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2150 assert_eq!(events.len(), 1);
2151 SendEvent::from_event(events.remove(0))
2154 // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
2155 // initial fulfill/CS.
2156 assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000));
2157 check_added_monitors!(nodes[1], 1);
2158 let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2160 // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
2161 // remove the second HTLC when we send the HTLC back from B to A.
2162 assert!(nodes[1].node.claim_funds(payment_preimage_2, &None, 20000));
2163 check_added_monitors!(nodes[1], 1);
2164 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2166 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
2167 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
2168 check_added_monitors!(nodes[0], 1);
2169 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2170 expect_payment_sent!(nodes[0], payment_preimage_1);
2172 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
2173 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
2174 check_added_monitors!(nodes[1], 1);
2175 // B is already AwaitingRAA, so cant generate a CS here
2176 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2178 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2179 check_added_monitors!(nodes[1], 1);
2180 let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2182 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2183 check_added_monitors!(nodes[0], 1);
2184 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2186 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2187 check_added_monitors!(nodes[1], 1);
2188 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2190 // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
2191 // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
2192 // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
2193 // can no longer broadcast a commitment transaction with it and B has the preimage so can go
2194 // on-chain as necessary).
2195 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
2196 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
2197 check_added_monitors!(nodes[0], 1);
2198 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2199 expect_payment_sent!(nodes[0], payment_preimage_2);
2201 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2202 check_added_monitors!(nodes[1], 1);
2203 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2205 expect_pending_htlcs_forwardable!(nodes[1]);
2206 expect_payment_received!(nodes[1], payment_hash_3, 100000);
2208 // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
2209 // resolve the second HTLC from A's point of view.
2210 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2211 check_added_monitors!(nodes[0], 1);
2212 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2214 // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
2215 // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
2216 let (payment_preimage_4, payment_hash_4) = get_payment_preimage_hash!(nodes[1]);
2218 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
2219 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), None, None, &[], 10000, TEST_FINAL_CLTV, &logger).unwrap();
2220 nodes[1].node.send_payment(&route, payment_hash_4, &None).unwrap();
2221 check_added_monitors!(nodes[1], 1);
2222 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
2223 assert_eq!(events.len(), 1);
2224 SendEvent::from_event(events.remove(0))
2227 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
2228 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
2229 check_added_monitors!(nodes[0], 1);
2230 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2232 // Now just resolve all the outstanding messages/HTLCs for completeness...
2234 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2235 check_added_monitors!(nodes[1], 1);
2236 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2238 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2239 check_added_monitors!(nodes[1], 1);
2241 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2242 check_added_monitors!(nodes[0], 1);
2243 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2245 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2246 check_added_monitors!(nodes[1], 1);
2247 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2249 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2250 check_added_monitors!(nodes[0], 1);
2252 expect_pending_htlcs_forwardable!(nodes[0]);
2253 expect_payment_received!(nodes[0], payment_hash_4, 10000);
2255 claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4, 10_000);
2256 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3, 100_000);
2260 fn channel_monitor_network_test() {
2261 // Simple test which builds a network of ChannelManagers, connects them to each other, and
2262 // tests that ChannelMonitor is able to recover from various states.
2263 let chanmon_cfgs = create_chanmon_cfgs(5);
2264 let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
2265 let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
2266 let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
2268 // Create some initial channels
2269 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2270 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2271 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
2272 let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
2274 // Make sure all nodes are at the same starting height
2275 connect_blocks(&nodes[0], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
2276 connect_blocks(&nodes[1], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
2277 connect_blocks(&nodes[2], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
2278 connect_blocks(&nodes[3], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[3].best_block_info().1);
2279 connect_blocks(&nodes[4], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[4].best_block_info().1);
2281 // Rebalance the network a bit by relaying one payment through all the channels...
2282 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2283 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2284 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2285 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2287 // Simple case with no pending HTLCs:
2288 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
2289 check_added_monitors!(nodes[1], 1);
2290 check_closed_broadcast!(nodes[1], false);
2292 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
2293 assert_eq!(node_txn.len(), 1);
2294 mine_transaction(&nodes[0], &node_txn[0]);
2295 check_added_monitors!(nodes[0], 1);
2296 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
2298 check_closed_broadcast!(nodes[0], true);
2299 assert_eq!(nodes[0].node.list_channels().len(), 0);
2300 assert_eq!(nodes[1].node.list_channels().len(), 1);
2302 // One pending HTLC is discarded by the force-close:
2303 let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
2305 // Simple case of one pending HTLC to HTLC-Timeout
2306 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
2307 check_closed_broadcast!(nodes[1], false);
2308 check_added_monitors!(nodes[1], 1);
2310 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
2311 mine_transaction(&nodes[2], &node_txn[0]);
2312 check_added_monitors!(nodes[2], 1);
2313 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
2315 check_closed_broadcast!(nodes[2], true);
2316 assert_eq!(nodes[1].node.list_channels().len(), 0);
2317 assert_eq!(nodes[2].node.list_channels().len(), 1);
2319 macro_rules! claim_funds {
2320 ($node: expr, $prev_node: expr, $preimage: expr, $amount: expr) => {
2322 assert!($node.node.claim_funds($preimage, &None, $amount));
2323 check_added_monitors!($node, 1);
2325 let events = $node.node.get_and_clear_pending_msg_events();
2326 assert_eq!(events.len(), 1);
2328 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2329 assert!(update_add_htlcs.is_empty());
2330 assert!(update_fail_htlcs.is_empty());
2331 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2333 _ => panic!("Unexpected event"),
2339 // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2340 // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2341 nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2342 check_added_monitors!(nodes[2], 1);
2343 check_closed_broadcast!(nodes[2], false);
2344 let node2_commitment_txid;
2346 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2347 node2_commitment_txid = node_txn[0].txid();
2349 // Claim the payment on nodes[3], giving it knowledge of the preimage
2350 claim_funds!(nodes[3], nodes[2], payment_preimage_1, 3_000_000);
2351 mine_transaction(&nodes[3], &node_txn[0]);
2352 check_added_monitors!(nodes[3], 1);
2353 check_preimage_claim(&nodes[3], &node_txn);
2355 check_closed_broadcast!(nodes[3], true);
2356 assert_eq!(nodes[2].node.list_channels().len(), 0);
2357 assert_eq!(nodes[3].node.list_channels().len(), 1);
2359 // Drop the ChannelMonitor for the previous channel to avoid it broadcasting transactions and
2360 // confusing us in the following tests.
2361 let chan_3_mon = nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().remove(&OutPoint { txid: chan_3.3.txid(), index: 0 }).unwrap();
2363 // One pending HTLC to time out:
2364 let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2365 // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2368 let (close_chan_update_1, close_chan_update_2) = {
2369 connect_blocks(&nodes[3], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
2370 let events = nodes[3].node.get_and_clear_pending_msg_events();
2371 assert_eq!(events.len(), 2);
2372 let close_chan_update_1 = match events[0] {
2373 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2376 _ => panic!("Unexpected event"),
2379 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2380 assert_eq!(node_id, nodes[4].node.get_our_node_id());
2382 _ => panic!("Unexpected event"),
2384 check_added_monitors!(nodes[3], 1);
2386 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2388 let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2389 node_txn.retain(|tx| {
2390 if tx.input[0].previous_output.txid == node2_commitment_txid {
2396 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2398 // Claim the payment on nodes[4], giving it knowledge of the preimage
2399 claim_funds!(nodes[4], nodes[3], payment_preimage_2, 3_000_000);
2401 connect_blocks(&nodes[4], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + 2);
2402 let events = nodes[4].node.get_and_clear_pending_msg_events();
2403 assert_eq!(events.len(), 2);
2404 let close_chan_update_2 = match events[0] {
2405 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2408 _ => panic!("Unexpected event"),
2411 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2412 assert_eq!(node_id, nodes[3].node.get_our_node_id());
2414 _ => panic!("Unexpected event"),
2416 check_added_monitors!(nodes[4], 1);
2417 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2419 mine_transaction(&nodes[4], &node_txn[0]);
2420 check_preimage_claim(&nodes[4], &node_txn);
2421 (close_chan_update_1, close_chan_update_2)
2423 nodes[3].net_graph_msg_handler.handle_channel_update(&close_chan_update_2).unwrap();
2424 nodes[4].net_graph_msg_handler.handle_channel_update(&close_chan_update_1).unwrap();
2425 assert_eq!(nodes[3].node.list_channels().len(), 0);
2426 assert_eq!(nodes[4].node.list_channels().len(), 0);
2428 nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().insert(OutPoint { txid: chan_3.3.txid(), index: 0 }, chan_3_mon);
2432 fn test_justice_tx() {
2433 // Test justice txn built on revoked HTLC-Success tx, against both sides
2434 let mut alice_config = UserConfig::default();
2435 alice_config.channel_options.announced_channel = true;
2436 alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2437 alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2438 let mut bob_config = UserConfig::default();
2439 bob_config.channel_options.announced_channel = true;
2440 bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2441 bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2442 let user_cfgs = [Some(alice_config), Some(bob_config)];
2443 let mut chanmon_cfgs = create_chanmon_cfgs(2);
2444 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2445 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
2446 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2447 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2448 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2449 // Create some new channels:
2450 let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2452 // A pending HTLC which will be revoked:
2453 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2454 // Get the will-be-revoked local txn from nodes[0]
2455 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2456 assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2457 assert_eq!(revoked_local_txn[0].input.len(), 1);
2458 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2459 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2460 assert_eq!(revoked_local_txn[1].input.len(), 1);
2461 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2462 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2463 // Revoke the old state
2464 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 3_000_000);
2467 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2469 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2470 assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2471 assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2473 check_spends!(node_txn[0], revoked_local_txn[0]);
2474 node_txn.swap_remove(0);
2475 node_txn.truncate(1);
2477 check_added_monitors!(nodes[1], 1);
2478 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2480 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2481 // Verify broadcast of revoked HTLC-timeout
2482 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2483 check_added_monitors!(nodes[0], 1);
2484 // Broadcast revoked HTLC-timeout on node 1
2485 mine_transaction(&nodes[1], &node_txn[1]);
2486 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2488 get_announce_close_broadcast_events(&nodes, 0, 1);
2490 assert_eq!(nodes[0].node.list_channels().len(), 0);
2491 assert_eq!(nodes[1].node.list_channels().len(), 0);
2493 // We test justice_tx build by A on B's revoked HTLC-Success tx
2494 // Create some new channels:
2495 let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2497 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2501 // A pending HTLC which will be revoked:
2502 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2503 // Get the will-be-revoked local txn from B
2504 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2505 assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2506 assert_eq!(revoked_local_txn[0].input.len(), 1);
2507 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2508 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2509 // Revoke the old state
2510 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4, 3_000_000);
2512 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2514 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2515 assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2516 assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2518 check_spends!(node_txn[0], revoked_local_txn[0]);
2519 node_txn.swap_remove(0);
2521 check_added_monitors!(nodes[0], 1);
2522 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2524 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2525 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2526 check_added_monitors!(nodes[1], 1);
2527 mine_transaction(&nodes[0], &node_txn[1]);
2528 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2530 get_announce_close_broadcast_events(&nodes, 0, 1);
2531 assert_eq!(nodes[0].node.list_channels().len(), 0);
2532 assert_eq!(nodes[1].node.list_channels().len(), 0);
2536 fn revoked_output_claim() {
2537 // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2538 // transaction is broadcast by its counterparty
2539 let chanmon_cfgs = create_chanmon_cfgs(2);
2540 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2541 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2542 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2543 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2544 // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2545 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2546 assert_eq!(revoked_local_txn.len(), 1);
2547 // Only output is the full channel value back to nodes[0]:
2548 assert_eq!(revoked_local_txn[0].output.len(), 1);
2549 // Send a payment through, updating everyone's latest commitment txn
2550 send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000, 5_000_000);
2552 // Inform nodes[1] that nodes[0] broadcast a stale tx
2553 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2554 check_added_monitors!(nodes[1], 1);
2555 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2556 assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2558 check_spends!(node_txn[0], revoked_local_txn[0]);
2559 check_spends!(node_txn[1], chan_1.3);
2561 // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2562 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2563 get_announce_close_broadcast_events(&nodes, 0, 1);
2564 check_added_monitors!(nodes[0], 1)
2568 fn claim_htlc_outputs_shared_tx() {
2569 // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2570 let mut chanmon_cfgs = create_chanmon_cfgs(2);
2571 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2572 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2573 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2574 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2576 // Create some new channel:
2577 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2579 // Rebalance the network to generate htlc in the two directions
2580 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2581 // 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
2582 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2583 let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2585 // Get the will-be-revoked local txn from node[0]
2586 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2587 assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2588 assert_eq!(revoked_local_txn[0].input.len(), 1);
2589 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2590 assert_eq!(revoked_local_txn[1].input.len(), 1);
2591 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2592 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2593 check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2595 //Revoke the old state
2596 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2599 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2600 check_added_monitors!(nodes[0], 1);
2601 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2602 check_added_monitors!(nodes[1], 1);
2603 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2604 expect_payment_failed!(nodes[1], payment_hash_2, true);
2606 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2607 assert_eq!(node_txn.len(), 3); // ChannelMonitor: penalty tx, ChannelManager: local commitment + HTLC-timeout
2609 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2610 check_spends!(node_txn[0], revoked_local_txn[0]);
2612 let mut witness_lens = BTreeSet::new();
2613 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2614 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2615 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2616 assert_eq!(witness_lens.len(), 3);
2617 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2618 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2619 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2621 // Next nodes[1] broadcasts its current local tx state:
2622 assert_eq!(node_txn[1].input.len(), 1);
2623 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2625 assert_eq!(node_txn[2].input.len(), 1);
2626 let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
2627 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2628 assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
2629 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2630 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
2632 get_announce_close_broadcast_events(&nodes, 0, 1);
2633 assert_eq!(nodes[0].node.list_channels().len(), 0);
2634 assert_eq!(nodes[1].node.list_channels().len(), 0);
2638 fn claim_htlc_outputs_single_tx() {
2639 // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2640 let mut chanmon_cfgs = create_chanmon_cfgs(2);
2641 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2642 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2643 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2644 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2646 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2648 // Rebalance the network to generate htlc in the two directions
2649 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2650 // 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
2651 // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2652 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2653 let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2655 // Get the will-be-revoked local txn from node[0]
2656 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2658 //Revoke the old state
2659 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2662 confirm_transaction_at(&nodes[0], &revoked_local_txn[0], 100);
2663 check_added_monitors!(nodes[0], 1);
2664 confirm_transaction_at(&nodes[1], &revoked_local_txn[0], 100);
2665 check_added_monitors!(nodes[1], 1);
2666 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
2668 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2669 expect_payment_failed!(nodes[1], payment_hash_2, true);
2671 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2672 assert_eq!(node_txn.len(), 9);
2673 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2674 // ChannelManager: local commmitment + local HTLC-timeout (2)
2675 // ChannelMonitor: bumped justice tx, after one increase, bumps on HTLC aren't generated not being substantial anymore, bump on revoked to_local isn't generated due to more room for expiration (2)
2676 // ChannelMonitor: local commitment + local HTLC-timeout (2)
2678 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2679 assert_eq!(node_txn[0].input.len(), 1);
2680 check_spends!(node_txn[0], chan_1.3);
2681 assert_eq!(node_txn[1].input.len(), 1);
2682 let witness_script = node_txn[1].input[0].witness.last().unwrap();
2683 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2684 check_spends!(node_txn[1], node_txn[0]);
2686 // Justice transactions are indices 1-2-4
2687 assert_eq!(node_txn[2].input.len(), 1);
2688 assert_eq!(node_txn[3].input.len(), 1);
2689 assert_eq!(node_txn[4].input.len(), 1);
2691 check_spends!(node_txn[2], revoked_local_txn[0]);
2692 check_spends!(node_txn[3], revoked_local_txn[0]);
2693 check_spends!(node_txn[4], revoked_local_txn[0]);
2695 let mut witness_lens = BTreeSet::new();
2696 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2697 witness_lens.insert(node_txn[3].input[0].witness.last().unwrap().len());
2698 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2699 assert_eq!(witness_lens.len(), 3);
2700 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2701 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2702 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2704 get_announce_close_broadcast_events(&nodes, 0, 1);
2705 assert_eq!(nodes[0].node.list_channels().len(), 0);
2706 assert_eq!(nodes[1].node.list_channels().len(), 0);
2710 fn test_htlc_on_chain_success() {
2711 // Test that in case of a unilateral close onchain, we detect the state of output and pass
2712 // the preimage backward accordingly. So here we test that ChannelManager is
2713 // broadcasting the right event to other nodes in payment path.
2714 // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2715 // A --------------------> B ----------------------> C (preimage)
2716 // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2717 // commitment transaction was broadcast.
2718 // Then, B should learn the preimage from said transactions, attempting to claim backwards
2720 // B should be able to claim via preimage if A then broadcasts its local tx.
2721 // Finally, when A sees B's latest local commitment transaction it should be able to claim
2722 // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2723 // PaymentSent event).
2725 let chanmon_cfgs = create_chanmon_cfgs(3);
2726 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2727 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2728 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2730 // Create some initial channels
2731 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2732 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2734 // Rebalance the network a bit by relaying one payment through all the channels...
2735 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2736 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2738 let (our_payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2739 let (our_payment_preimage_2, _payment_hash_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2741 // Broadcast legit commitment tx from C on B's chain
2742 // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2743 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2744 assert_eq!(commitment_tx.len(), 1);
2745 check_spends!(commitment_tx[0], chan_2.3);
2746 nodes[2].node.claim_funds(our_payment_preimage, &None, 3_000_000);
2747 nodes[2].node.claim_funds(our_payment_preimage_2, &None, 3_000_000);
2748 check_added_monitors!(nodes[2], 2);
2749 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2750 assert!(updates.update_add_htlcs.is_empty());
2751 assert!(updates.update_fail_htlcs.is_empty());
2752 assert!(updates.update_fail_malformed_htlcs.is_empty());
2753 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2755 mine_transaction(&nodes[2], &commitment_tx[0]);
2756 check_closed_broadcast!(nodes[2], true);
2757 check_added_monitors!(nodes[2], 1);
2758 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx, 2*htlc-success tx), ChannelMonitor : 2 (2 * HTLC-Success tx)
2759 assert_eq!(node_txn.len(), 5);
2760 assert_eq!(node_txn[0], node_txn[3]);
2761 assert_eq!(node_txn[1], node_txn[4]);
2762 assert_eq!(node_txn[2], commitment_tx[0]);
2763 check_spends!(node_txn[0], commitment_tx[0]);
2764 check_spends!(node_txn[1], commitment_tx[0]);
2765 assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2766 assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2767 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2768 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2769 assert_eq!(node_txn[0].lock_time, 0);
2770 assert_eq!(node_txn[1].lock_time, 0);
2772 // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2773 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2774 connect_block(&nodes[1], &Block { header, txdata: node_txn});
2776 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2777 assert_eq!(added_monitors.len(), 1);
2778 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2779 added_monitors.clear();
2781 let events = nodes[1].node.get_and_clear_pending_msg_events();
2783 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2784 assert_eq!(added_monitors.len(), 2);
2785 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2786 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2787 added_monitors.clear();
2789 assert_eq!(events.len(), 3);
2791 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2792 _ => panic!("Unexpected event"),
2795 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
2796 _ => panic!("Unexpected event"),
2800 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, .. } } => {
2801 assert!(update_add_htlcs.is_empty());
2802 assert!(update_fail_htlcs.is_empty());
2803 assert_eq!(update_fulfill_htlcs.len(), 1);
2804 assert!(update_fail_malformed_htlcs.is_empty());
2805 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2807 _ => panic!("Unexpected event"),
2809 macro_rules! check_tx_local_broadcast {
2810 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2811 let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2812 assert_eq!(node_txn.len(), 5);
2813 // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2814 // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout
2815 check_spends!(node_txn[0], $commitment_tx);
2816 check_spends!(node_txn[1], $commitment_tx);
2817 assert_ne!(node_txn[0].lock_time, 0);
2818 assert_ne!(node_txn[1].lock_time, 0);
2820 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2821 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2822 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2823 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2825 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2826 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2827 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2828 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2830 check_spends!(node_txn[2], $chan_tx);
2831 check_spends!(node_txn[3], node_txn[2]);
2832 check_spends!(node_txn[4], node_txn[2]);
2833 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), 71);
2834 assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2835 assert_eq!(node_txn[4].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2836 assert!(node_txn[3].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2837 assert!(node_txn[4].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2838 assert_ne!(node_txn[3].lock_time, 0);
2839 assert_ne!(node_txn[4].lock_time, 0);
2843 // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2844 // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2845 // timeout-claim of the output that nodes[2] just claimed via success.
2846 check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2848 // Broadcast legit commitment tx from A on B's chain
2849 // Broadcast preimage tx by B on offered output from A commitment tx on A's chain
2850 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2851 check_spends!(commitment_tx[0], chan_1.3);
2852 mine_transaction(&nodes[1], &commitment_tx[0]);
2853 check_closed_broadcast!(nodes[1], true);
2854 check_added_monitors!(nodes[1], 1);
2855 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 1 (HTLC-Success)
2856 assert_eq!(node_txn.len(), 4);
2857 check_spends!(node_txn[0], commitment_tx[0]);
2858 assert_eq!(node_txn[0].input.len(), 2);
2859 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2860 assert_eq!(node_txn[0].input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2861 assert_eq!(node_txn[0].lock_time, 0);
2862 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2863 check_spends!(node_txn[1], chan_1.3);
2864 assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2865 check_spends!(node_txn[2], node_txn[1]);
2866 check_spends!(node_txn[3], node_txn[1]);
2867 // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2868 // we already checked the same situation with A.
2870 // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2871 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2872 connect_block(&nodes[0], &Block { header, txdata: vec![commitment_tx[0].clone(), node_txn[0].clone()] });
2873 check_closed_broadcast!(nodes[0], true);
2874 check_added_monitors!(nodes[0], 1);
2875 let events = nodes[0].node.get_and_clear_pending_events();
2876 assert_eq!(events.len(), 2);
2877 let mut first_claimed = false;
2878 for event in events {
2880 Event::PaymentSent { payment_preimage } => {
2881 if payment_preimage == our_payment_preimage {
2882 assert!(!first_claimed);
2883 first_claimed = true;
2885 assert_eq!(payment_preimage, our_payment_preimage_2);
2888 _ => panic!("Unexpected event"),
2891 check_tx_local_broadcast!(nodes[0], true, commitment_tx[0], chan_1.3);
2894 fn do_test_htlc_on_chain_timeout(connect_style: ConnectStyle) {
2895 // Test that in case of a unilateral close onchain, we detect the state of output and
2896 // timeout the HTLC backward accordingly. So here we test that ChannelManager is
2897 // broadcasting the right event to other nodes in payment path.
2898 // A ------------------> B ----------------------> C (timeout)
2899 // B's commitment tx C's commitment tx
2901 // B's HTLC timeout tx B's timeout tx
2903 let chanmon_cfgs = create_chanmon_cfgs(3);
2904 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2905 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2906 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2907 *nodes[0].connect_style.borrow_mut() = connect_style;
2908 *nodes[1].connect_style.borrow_mut() = connect_style;
2909 *nodes[2].connect_style.borrow_mut() = connect_style;
2911 // Create some intial channels
2912 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2913 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2915 // Rebalance the network a bit by relaying one payment thorugh all the channels...
2916 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2917 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2919 let (_payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2921 // Broadcast legit commitment tx from C on B's chain
2922 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2923 check_spends!(commitment_tx[0], chan_2.3);
2924 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
2925 check_added_monitors!(nodes[2], 0);
2926 expect_pending_htlcs_forwardable!(nodes[2]);
2927 check_added_monitors!(nodes[2], 1);
2929 let events = nodes[2].node.get_and_clear_pending_msg_events();
2930 assert_eq!(events.len(), 1);
2932 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, .. } } => {
2933 assert!(update_add_htlcs.is_empty());
2934 assert!(!update_fail_htlcs.is_empty());
2935 assert!(update_fulfill_htlcs.is_empty());
2936 assert!(update_fail_malformed_htlcs.is_empty());
2937 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2939 _ => panic!("Unexpected event"),
2941 mine_transaction(&nodes[2], &commitment_tx[0]);
2942 check_closed_broadcast!(nodes[2], true);
2943 check_added_monitors!(nodes[2], 1);
2944 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2945 assert_eq!(node_txn.len(), 1);
2946 check_spends!(node_txn[0], chan_2.3);
2947 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2949 // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2950 // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2951 connect_blocks(&nodes[1], 200 - nodes[2].best_block_info().1);
2952 mine_transaction(&nodes[1], &commitment_tx[0]);
2955 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2956 assert_eq!(node_txn.len(), 5); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (local commitment tx + HTLC-timeout), 1 timeout tx
2957 assert_eq!(node_txn[0], node_txn[3]);
2958 assert_eq!(node_txn[1], node_txn[4]);
2960 check_spends!(node_txn[2], commitment_tx[0]);
2961 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2963 check_spends!(node_txn[0], chan_2.3);
2964 check_spends!(node_txn[1], node_txn[0]);
2965 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
2966 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2968 timeout_tx = node_txn[2].clone();
2972 mine_transaction(&nodes[1], &timeout_tx);
2973 check_added_monitors!(nodes[1], 1);
2974 check_closed_broadcast!(nodes[1], true);
2976 // B will rebroadcast a fee-bumped timeout transaction here.
2977 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2978 assert_eq!(node_txn.len(), 1);
2979 check_spends!(node_txn[0], commitment_tx[0]);
2982 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2984 // B will rebroadcast its own holder commitment transaction here...just because
2985 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2986 assert_eq!(node_txn.len(), 1);
2987 check_spends!(node_txn[0], chan_2.3);
2990 expect_pending_htlcs_forwardable!(nodes[1]);
2991 check_added_monitors!(nodes[1], 1);
2992 let events = nodes[1].node.get_and_clear_pending_msg_events();
2993 assert_eq!(events.len(), 1);
2995 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, .. } } => {
2996 assert!(update_add_htlcs.is_empty());
2997 assert!(!update_fail_htlcs.is_empty());
2998 assert!(update_fulfill_htlcs.is_empty());
2999 assert!(update_fail_malformed_htlcs.is_empty());
3000 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3002 _ => panic!("Unexpected event"),
3005 // Broadcast legit commitment tx from B on A's chain
3006 let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
3007 check_spends!(commitment_tx[0], chan_1.3);
3009 mine_transaction(&nodes[0], &commitment_tx[0]);
3011 check_closed_broadcast!(nodes[0], true);
3012 check_added_monitors!(nodes[0], 1);
3013 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 1 timeout tx
3014 assert_eq!(node_txn.len(), 3);
3015 check_spends!(node_txn[0], commitment_tx[0]);
3016 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3017 check_spends!(node_txn[1], chan_1.3);
3018 check_spends!(node_txn[2], node_txn[1]);
3019 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
3020 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3024 fn test_htlc_on_chain_timeout() {
3025 do_test_htlc_on_chain_timeout(ConnectStyle::BestBlockFirstSkippingBlocks);
3026 do_test_htlc_on_chain_timeout(ConnectStyle::TransactionsFirstSkippingBlocks);
3027 do_test_htlc_on_chain_timeout(ConnectStyle::FullBlockViaListen);
3031 fn test_simple_commitment_revoked_fail_backward() {
3032 // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
3033 // and fail backward accordingly.
3035 let chanmon_cfgs = create_chanmon_cfgs(3);
3036 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3037 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3038 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3040 // Create some initial channels
3041 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3042 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3044 let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3045 // Get the will-be-revoked local txn from nodes[2]
3046 let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3047 // Revoke the old state
3048 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, 3_000_000);
3050 let (_, payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3052 mine_transaction(&nodes[1], &revoked_local_txn[0]);
3053 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3054 check_added_monitors!(nodes[1], 1);
3055 check_closed_broadcast!(nodes[1], true);
3057 expect_pending_htlcs_forwardable!(nodes[1]);
3058 check_added_monitors!(nodes[1], 1);
3059 let events = nodes[1].node.get_and_clear_pending_msg_events();
3060 assert_eq!(events.len(), 1);
3062 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, .. } } => {
3063 assert!(update_add_htlcs.is_empty());
3064 assert_eq!(update_fail_htlcs.len(), 1);
3065 assert!(update_fulfill_htlcs.is_empty());
3066 assert!(update_fail_malformed_htlcs.is_empty());
3067 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3069 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3070 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3072 let events = nodes[0].node.get_and_clear_pending_msg_events();
3073 assert_eq!(events.len(), 1);
3075 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3076 _ => panic!("Unexpected event"),
3078 expect_payment_failed!(nodes[0], payment_hash, false);
3080 _ => panic!("Unexpected event"),
3084 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
3085 // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
3086 // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
3087 // commitment transaction anymore.
3088 // To do this, we have the peer which will broadcast a revoked commitment transaction send
3089 // a number of update_fail/commitment_signed updates without ever sending the RAA in
3090 // response to our commitment_signed. This is somewhat misbehavior-y, though not
3091 // technically disallowed and we should probably handle it reasonably.
3092 // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
3093 // failed/fulfilled backwards must be in at least one of the latest two remote commitment
3095 // * Once we move it out of our holding cell/add it, we will immediately include it in a
3096 // commitment_signed (implying it will be in the latest remote commitment transaction).
3097 // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
3098 // and once they revoke the previous commitment transaction (allowing us to send a new
3099 // commitment_signed) we will be free to fail/fulfill the HTLC backwards.
3100 let chanmon_cfgs = create_chanmon_cfgs(3);
3101 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3102 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3103 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3105 // Create some initial channels
3106 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3107 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3109 let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], if no_to_remote { 10_000 } else { 3_000_000 });
3110 // Get the will-be-revoked local txn from nodes[2]
3111 let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3112 assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
3113 // Revoke the old state
3114 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, if no_to_remote { 10_000 } else { 3_000_000});
3116 let value = if use_dust {
3117 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
3118 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
3119 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().holder_dust_limit_satoshis * 1000
3122 let (_, first_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3123 let (_, second_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3124 let (_, third_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3126 assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash, &None));
3127 expect_pending_htlcs_forwardable!(nodes[2]);
3128 check_added_monitors!(nodes[2], 1);
3129 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3130 assert!(updates.update_add_htlcs.is_empty());
3131 assert!(updates.update_fulfill_htlcs.is_empty());
3132 assert!(updates.update_fail_malformed_htlcs.is_empty());
3133 assert_eq!(updates.update_fail_htlcs.len(), 1);
3134 assert!(updates.update_fee.is_none());
3135 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3136 let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
3137 // Drop the last RAA from 3 -> 2
3139 assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash, &None));
3140 expect_pending_htlcs_forwardable!(nodes[2]);
3141 check_added_monitors!(nodes[2], 1);
3142 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3143 assert!(updates.update_add_htlcs.is_empty());
3144 assert!(updates.update_fulfill_htlcs.is_empty());
3145 assert!(updates.update_fail_malformed_htlcs.is_empty());
3146 assert_eq!(updates.update_fail_htlcs.len(), 1);
3147 assert!(updates.update_fee.is_none());
3148 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3149 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3150 check_added_monitors!(nodes[1], 1);
3151 // Note that nodes[1] is in AwaitingRAA, so won't send a CS
3152 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3153 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3154 check_added_monitors!(nodes[2], 1);
3156 assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash, &None));
3157 expect_pending_htlcs_forwardable!(nodes[2]);
3158 check_added_monitors!(nodes[2], 1);
3159 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3160 assert!(updates.update_add_htlcs.is_empty());
3161 assert!(updates.update_fulfill_htlcs.is_empty());
3162 assert!(updates.update_fail_malformed_htlcs.is_empty());
3163 assert_eq!(updates.update_fail_htlcs.len(), 1);
3164 assert!(updates.update_fee.is_none());
3165 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3166 // At this point first_payment_hash has dropped out of the latest two commitment
3167 // transactions that nodes[1] is tracking...
3168 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3169 check_added_monitors!(nodes[1], 1);
3170 // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
3171 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3172 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3173 check_added_monitors!(nodes[2], 1);
3175 // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
3176 // on nodes[2]'s RAA.
3177 let (_, fourth_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3178 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3179 let logger = test_utils::TestLogger::new();
3180 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), None, None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3181 nodes[1].node.send_payment(&route, fourth_payment_hash, &None).unwrap();
3182 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3183 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3184 check_added_monitors!(nodes[1], 0);
3187 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
3188 // One monitor for the new revocation preimage, no second on as we won't generate a new
3189 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
3190 check_added_monitors!(nodes[1], 1);
3191 let events = nodes[1].node.get_and_clear_pending_events();
3192 assert_eq!(events.len(), 1);
3194 Event::PendingHTLCsForwardable { .. } => { },
3195 _ => panic!("Unexpected event"),
3197 // Deliberately don't process the pending fail-back so they all fail back at once after
3198 // block connection just like the !deliver_bs_raa case
3201 let mut failed_htlcs = HashSet::new();
3202 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3204 mine_transaction(&nodes[1], &revoked_local_txn[0]);
3205 check_added_monitors!(nodes[1], 1);
3206 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3208 let events = nodes[1].node.get_and_clear_pending_events();
3209 assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
3211 Event::PaymentFailed { ref payment_hash, .. } => {
3212 assert_eq!(*payment_hash, fourth_payment_hash);
3214 _ => panic!("Unexpected event"),
3216 if !deliver_bs_raa {
3218 Event::PendingHTLCsForwardable { .. } => { },
3219 _ => panic!("Unexpected event"),
3222 nodes[1].node.process_pending_htlc_forwards();
3223 check_added_monitors!(nodes[1], 1);
3225 let events = nodes[1].node.get_and_clear_pending_msg_events();
3226 assert_eq!(events.len(), if deliver_bs_raa { 4 } else { 3 });
3227 match events[if deliver_bs_raa { 1 } else { 0 }] {
3228 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
3229 _ => panic!("Unexpected event"),
3231 match events[if deliver_bs_raa { 2 } else { 1 }] {
3232 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage { channel_id, ref data } }, node_id: _ } => {
3233 assert_eq!(channel_id, chan_2.2);
3234 assert_eq!(data.as_str(), "Commitment or closing transaction was confirmed on chain.");
3236 _ => panic!("Unexpected event"),
3240 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, .. } } => {
3241 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
3242 assert_eq!(update_add_htlcs.len(), 1);
3243 assert!(update_fulfill_htlcs.is_empty());
3244 assert!(update_fail_htlcs.is_empty());
3245 assert!(update_fail_malformed_htlcs.is_empty());
3247 _ => panic!("Unexpected event"),
3250 match events[if deliver_bs_raa { 3 } else { 2 }] {
3251 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, .. } } => {
3252 assert!(update_add_htlcs.is_empty());
3253 assert_eq!(update_fail_htlcs.len(), 3);
3254 assert!(update_fulfill_htlcs.is_empty());
3255 assert!(update_fail_malformed_htlcs.is_empty());
3256 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3258 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3259 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
3260 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
3262 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3264 let events = nodes[0].node.get_and_clear_pending_msg_events();
3265 // If we delivered B's RAA we got an unknown preimage error, not something
3266 // that we should update our routing table for.
3267 assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
3268 for event in events {
3270 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3271 _ => panic!("Unexpected event"),
3274 let events = nodes[0].node.get_and_clear_pending_events();
3275 assert_eq!(events.len(), 3);
3277 Event::PaymentFailed { ref payment_hash, .. } => {
3278 assert!(failed_htlcs.insert(payment_hash.0));
3280 _ => panic!("Unexpected event"),
3283 Event::PaymentFailed { ref payment_hash, .. } => {
3284 assert!(failed_htlcs.insert(payment_hash.0));
3286 _ => panic!("Unexpected event"),
3289 Event::PaymentFailed { ref payment_hash, .. } => {
3290 assert!(failed_htlcs.insert(payment_hash.0));
3292 _ => panic!("Unexpected event"),
3295 _ => panic!("Unexpected event"),
3298 assert!(failed_htlcs.contains(&first_payment_hash.0));
3299 assert!(failed_htlcs.contains(&second_payment_hash.0));
3300 assert!(failed_htlcs.contains(&third_payment_hash.0));
3304 fn test_commitment_revoked_fail_backward_exhaustive_a() {
3305 do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
3306 do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
3307 do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
3308 do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
3312 fn test_commitment_revoked_fail_backward_exhaustive_b() {
3313 do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
3314 do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
3315 do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
3316 do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
3320 fn fail_backward_pending_htlc_upon_channel_failure() {
3321 let chanmon_cfgs = create_chanmon_cfgs(2);
3322 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3323 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3324 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3325 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
3326 let logger = test_utils::TestLogger::new();
3328 // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
3330 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
3331 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3332 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3333 nodes[0].node.send_payment(&route, payment_hash, &None).unwrap();
3334 check_added_monitors!(nodes[0], 1);
3336 let payment_event = {
3337 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3338 assert_eq!(events.len(), 1);
3339 SendEvent::from_event(events.remove(0))
3341 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3342 assert_eq!(payment_event.msgs.len(), 1);
3345 // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3346 let (_, failed_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3348 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3349 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3350 nodes[0].node.send_payment(&route, failed_payment_hash, &None).unwrap();
3351 check_added_monitors!(nodes[0], 0);
3353 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3356 // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3358 let (_, payment_hash) = get_payment_preimage_hash!(nodes[1]);
3360 let secp_ctx = Secp256k1::new();
3361 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
3362 let current_height = nodes[1].node.best_block.read().unwrap().height() + 1;
3363 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3364 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), None, None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3365 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &None, current_height).unwrap();
3366 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3367 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3369 // Send a 0-msat update_add_htlc to fail the channel.
3370 let update_add_htlc = msgs::UpdateAddHTLC {
3376 onion_routing_packet,
3378 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3381 // Check that Alice fails backward the pending HTLC from the second payment.
3382 expect_payment_failed!(nodes[0], failed_payment_hash, true);
3383 check_closed_broadcast!(nodes[0], true);
3384 check_added_monitors!(nodes[0], 1);
3388 fn test_htlc_ignore_latest_remote_commitment() {
3389 // Test that HTLC transactions spending the latest remote commitment transaction are simply
3390 // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3391 let chanmon_cfgs = create_chanmon_cfgs(2);
3392 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3393 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3394 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3395 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3397 route_payment(&nodes[0], &[&nodes[1]], 10000000);
3398 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
3399 check_closed_broadcast!(nodes[0], true);
3400 check_added_monitors!(nodes[0], 1);
3402 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3403 assert_eq!(node_txn.len(), 2);
3405 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3406 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]});
3407 check_closed_broadcast!(nodes[1], true);
3408 check_added_monitors!(nodes[1], 1);
3410 // Duplicate the connect_block call since this may happen due to other listeners
3411 // registering new transactions
3412 header.prev_blockhash = header.block_hash();
3413 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]});
3417 fn test_force_close_fail_back() {
3418 // Check which HTLCs are failed-backwards on channel force-closure
3419 let chanmon_cfgs = create_chanmon_cfgs(3);
3420 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3421 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3422 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3423 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3424 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3425 let logger = test_utils::TestLogger::new();
3427 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3429 let mut payment_event = {
3430 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3431 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), None, None, &Vec::new(), 1000000, 42, &logger).unwrap();
3432 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
3433 check_added_monitors!(nodes[0], 1);
3435 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3436 assert_eq!(events.len(), 1);
3437 SendEvent::from_event(events.remove(0))
3440 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3441 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3443 expect_pending_htlcs_forwardable!(nodes[1]);
3445 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3446 assert_eq!(events_2.len(), 1);
3447 payment_event = SendEvent::from_event(events_2.remove(0));
3448 assert_eq!(payment_event.msgs.len(), 1);
3450 check_added_monitors!(nodes[1], 1);
3451 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3452 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3453 check_added_monitors!(nodes[2], 1);
3454 let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3456 // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3457 // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3458 // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3460 nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id).unwrap();
3461 check_closed_broadcast!(nodes[2], true);
3462 check_added_monitors!(nodes[2], 1);
3464 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3465 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3466 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3467 // back to nodes[1] upon timeout otherwise.
3468 assert_eq!(node_txn.len(), 1);
3472 mine_transaction(&nodes[1], &tx);
3474 // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3475 check_closed_broadcast!(nodes[1], true);
3476 check_added_monitors!(nodes[1], 1);
3478 // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3480 let mut monitors = nodes[2].chain_monitor.chain_monitor.monitors.read().unwrap();
3481 monitors.get(&OutPoint{ txid: Txid::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), index: 0 }).unwrap()
3482 .provide_payment_preimage(&our_payment_hash, &our_payment_preimage, &node_cfgs[2].tx_broadcaster, &node_cfgs[2].fee_estimator, &&logger);
3484 mine_transaction(&nodes[2], &tx);
3485 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3486 assert_eq!(node_txn.len(), 1);
3487 assert_eq!(node_txn[0].input.len(), 1);
3488 assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3489 assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3490 assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3492 check_spends!(node_txn[0], tx);
3496 fn test_simple_peer_disconnect() {
3497 // Test that we can reconnect when there are no lost messages
3498 let chanmon_cfgs = create_chanmon_cfgs(3);
3499 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3500 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3501 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3502 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3503 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3505 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3506 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3507 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3509 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3510 let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3511 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3512 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1, 1_000_000);
3514 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3515 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3516 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3518 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3519 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3520 let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3521 let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3523 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3524 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3526 claim_payment_along_route(&nodes[0], &vec!(&nodes[1], &nodes[2]), true, payment_preimage_3, 1_000_000);
3527 fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3529 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3531 let events = nodes[0].node.get_and_clear_pending_events();
3532 assert_eq!(events.len(), 2);
3534 Event::PaymentSent { payment_preimage } => {
3535 assert_eq!(payment_preimage, payment_preimage_3);
3537 _ => panic!("Unexpected event"),
3540 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3541 assert_eq!(payment_hash, payment_hash_5);
3542 assert!(rejected_by_dest);
3544 _ => panic!("Unexpected event"),
3548 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4, 1_000_000);
3549 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3552 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
3553 // Test that we can reconnect when in-flight HTLC updates get dropped
3554 let chanmon_cfgs = create_chanmon_cfgs(2);
3555 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3556 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3557 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3558 if messages_delivered == 0 {
3559 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3560 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3562 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3565 let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
3567 let logger = test_utils::TestLogger::new();
3568 let payment_event = {
3569 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3570 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3571 &nodes[1].node.get_our_node_id(), None, Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3572 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3573 nodes[0].node.send_payment(&route, payment_hash_1, &None).unwrap();
3574 check_added_monitors!(nodes[0], 1);
3576 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3577 assert_eq!(events.len(), 1);
3578 SendEvent::from_event(events.remove(0))
3580 assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3582 if messages_delivered < 2 {
3583 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3585 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3586 if messages_delivered >= 3 {
3587 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3588 check_added_monitors!(nodes[1], 1);
3589 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3591 if messages_delivered >= 4 {
3592 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3593 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3594 check_added_monitors!(nodes[0], 1);
3596 if messages_delivered >= 5 {
3597 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3598 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3599 // No commitment_signed so get_event_msg's assert(len == 1) passes
3600 check_added_monitors!(nodes[0], 1);
3602 if messages_delivered >= 6 {
3603 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3604 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3605 check_added_monitors!(nodes[1], 1);
3612 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3613 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3614 if messages_delivered < 3 {
3615 // Even if the funding_locked messages get exchanged, as long as nothing further was
3616 // received on either side, both sides will need to resend them.
3617 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3618 } else if messages_delivered == 3 {
3619 // nodes[0] still wants its RAA + commitment_signed
3620 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3621 } else if messages_delivered == 4 {
3622 // nodes[0] still wants its commitment_signed
3623 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3624 } else if messages_delivered == 5 {
3625 // nodes[1] still wants its final RAA
3626 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3627 } else if messages_delivered == 6 {
3628 // Everything was delivered...
3629 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3632 let events_1 = nodes[1].node.get_and_clear_pending_events();
3633 assert_eq!(events_1.len(), 1);
3635 Event::PendingHTLCsForwardable { .. } => { },
3636 _ => panic!("Unexpected event"),
3639 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3640 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3641 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3643 nodes[1].node.process_pending_htlc_forwards();
3645 let events_2 = nodes[1].node.get_and_clear_pending_events();
3646 assert_eq!(events_2.len(), 1);
3648 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
3649 assert_eq!(payment_hash_1, *payment_hash);
3650 assert_eq!(*payment_secret, None);
3651 assert_eq!(amt, 1000000);
3653 _ => panic!("Unexpected event"),
3656 nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000);
3657 check_added_monitors!(nodes[1], 1);
3659 let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3660 assert_eq!(events_3.len(), 1);
3661 let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3662 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3663 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3664 assert!(updates.update_add_htlcs.is_empty());
3665 assert!(updates.update_fail_htlcs.is_empty());
3666 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3667 assert!(updates.update_fail_malformed_htlcs.is_empty());
3668 assert!(updates.update_fee.is_none());
3669 (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3671 _ => panic!("Unexpected event"),
3674 if messages_delivered >= 1 {
3675 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3677 let events_4 = nodes[0].node.get_and_clear_pending_events();
3678 assert_eq!(events_4.len(), 1);
3680 Event::PaymentSent { ref payment_preimage } => {
3681 assert_eq!(payment_preimage_1, *payment_preimage);
3683 _ => panic!("Unexpected event"),
3686 if messages_delivered >= 2 {
3687 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3688 check_added_monitors!(nodes[0], 1);
3689 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3691 if messages_delivered >= 3 {
3692 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3693 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3694 check_added_monitors!(nodes[1], 1);
3696 if messages_delivered >= 4 {
3697 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3698 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3699 // No commitment_signed so get_event_msg's assert(len == 1) passes
3700 check_added_monitors!(nodes[1], 1);
3702 if messages_delivered >= 5 {
3703 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3704 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3705 check_added_monitors!(nodes[0], 1);
3712 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3713 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3714 if messages_delivered < 2 {
3715 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3716 //TODO: Deduplicate PaymentSent events, then enable this if:
3717 //if messages_delivered < 1 {
3718 let events_4 = nodes[0].node.get_and_clear_pending_events();
3719 assert_eq!(events_4.len(), 1);
3721 Event::PaymentSent { ref payment_preimage } => {
3722 assert_eq!(payment_preimage_1, *payment_preimage);
3724 _ => panic!("Unexpected event"),
3727 } else if messages_delivered == 2 {
3728 // nodes[0] still wants its RAA + commitment_signed
3729 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3730 } else if messages_delivered == 3 {
3731 // nodes[0] still wants its commitment_signed
3732 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3733 } else if messages_delivered == 4 {
3734 // nodes[1] still wants its final RAA
3735 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3736 } else if messages_delivered == 5 {
3737 // Everything was delivered...
3738 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3741 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3742 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3743 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3745 // Channel should still work fine...
3746 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3747 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3748 &nodes[1].node.get_our_node_id(), None, Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3749 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3750 let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3751 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3755 fn test_drop_messages_peer_disconnect_a() {
3756 do_test_drop_messages_peer_disconnect(0);
3757 do_test_drop_messages_peer_disconnect(1);
3758 do_test_drop_messages_peer_disconnect(2);
3759 do_test_drop_messages_peer_disconnect(3);
3763 fn test_drop_messages_peer_disconnect_b() {
3764 do_test_drop_messages_peer_disconnect(4);
3765 do_test_drop_messages_peer_disconnect(5);
3766 do_test_drop_messages_peer_disconnect(6);
3770 fn test_funding_peer_disconnect() {
3771 // Test that we can lock in our funding tx while disconnected
3772 let chanmon_cfgs = create_chanmon_cfgs(2);
3773 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3774 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3775 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3776 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3778 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3779 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3781 confirm_transaction(&nodes[0], &tx);
3782 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3783 assert_eq!(events_1.len(), 1);
3785 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3786 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3788 _ => panic!("Unexpected event"),
3791 reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3793 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3794 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3796 confirm_transaction(&nodes[1], &tx);
3797 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3798 assert_eq!(events_2.len(), 2);
3799 let funding_locked = match events_2[0] {
3800 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3801 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3804 _ => panic!("Unexpected event"),
3806 let bs_announcement_sigs = match events_2[1] {
3807 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3808 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3811 _ => panic!("Unexpected event"),
3814 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3816 nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3817 nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3818 let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3819 assert_eq!(events_3.len(), 2);
3820 let as_announcement_sigs = match events_3[0] {
3821 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3822 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3825 _ => panic!("Unexpected event"),
3827 let (as_announcement, as_update) = match events_3[1] {
3828 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3829 (msg.clone(), update_msg.clone())
3831 _ => panic!("Unexpected event"),
3834 nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3835 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3836 assert_eq!(events_4.len(), 1);
3837 let (_, bs_update) = match events_4[0] {
3838 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3839 (msg.clone(), update_msg.clone())
3841 _ => panic!("Unexpected event"),
3844 nodes[0].net_graph_msg_handler.handle_channel_announcement(&as_announcement).unwrap();
3845 nodes[0].net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
3846 nodes[0].net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
3848 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3849 let logger = test_utils::TestLogger::new();
3850 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3851 let (payment_preimage, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3852 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage, 1_000_000);
3856 fn test_drop_messages_peer_disconnect_dual_htlc() {
3857 // Test that we can handle reconnecting when both sides of a channel have pending
3858 // commitment_updates when we disconnect.
3859 let chanmon_cfgs = create_chanmon_cfgs(2);
3860 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3861 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3862 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3863 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3864 let logger = test_utils::TestLogger::new();
3866 let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3868 // Now try to send a second payment which will fail to send
3869 let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
3870 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3871 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3872 nodes[0].node.send_payment(&route, payment_hash_2, &None).unwrap();
3873 check_added_monitors!(nodes[0], 1);
3875 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3876 assert_eq!(events_1.len(), 1);
3878 MessageSendEvent::UpdateHTLCs { .. } => {},
3879 _ => panic!("Unexpected event"),
3882 assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000));
3883 check_added_monitors!(nodes[1], 1);
3885 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3886 assert_eq!(events_2.len(), 1);
3888 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 } } => {
3889 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3890 assert!(update_add_htlcs.is_empty());
3891 assert_eq!(update_fulfill_htlcs.len(), 1);
3892 assert!(update_fail_htlcs.is_empty());
3893 assert!(update_fail_malformed_htlcs.is_empty());
3894 assert!(update_fee.is_none());
3896 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3897 let events_3 = nodes[0].node.get_and_clear_pending_events();
3898 assert_eq!(events_3.len(), 1);
3900 Event::PaymentSent { ref payment_preimage } => {
3901 assert_eq!(*payment_preimage, payment_preimage_1);
3903 _ => panic!("Unexpected event"),
3906 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
3907 let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3908 // No commitment_signed so get_event_msg's assert(len == 1) passes
3909 check_added_monitors!(nodes[0], 1);
3911 _ => panic!("Unexpected event"),
3914 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3915 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3917 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3918 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3919 assert_eq!(reestablish_1.len(), 1);
3920 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3921 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3922 assert_eq!(reestablish_2.len(), 1);
3924 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3925 let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3926 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3927 let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3929 assert!(as_resp.0.is_none());
3930 assert!(bs_resp.0.is_none());
3932 assert!(bs_resp.1.is_none());
3933 assert!(bs_resp.2.is_none());
3935 assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3937 assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3938 assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3939 assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3940 assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3941 assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3942 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
3943 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
3944 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3945 // No commitment_signed so get_event_msg's assert(len == 1) passes
3946 check_added_monitors!(nodes[1], 1);
3948 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
3949 let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3950 assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
3951 assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
3952 assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
3953 assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
3954 assert!(bs_second_commitment_signed.update_fee.is_none());
3955 check_added_monitors!(nodes[1], 1);
3957 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3958 let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3959 assert!(as_commitment_signed.update_add_htlcs.is_empty());
3960 assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
3961 assert!(as_commitment_signed.update_fail_htlcs.is_empty());
3962 assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
3963 assert!(as_commitment_signed.update_fee.is_none());
3964 check_added_monitors!(nodes[0], 1);
3966 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
3967 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3968 // No commitment_signed so get_event_msg's assert(len == 1) passes
3969 check_added_monitors!(nodes[0], 1);
3971 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
3972 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3973 // No commitment_signed so get_event_msg's assert(len == 1) passes
3974 check_added_monitors!(nodes[1], 1);
3976 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3977 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3978 check_added_monitors!(nodes[1], 1);
3980 expect_pending_htlcs_forwardable!(nodes[1]);
3982 let events_5 = nodes[1].node.get_and_clear_pending_events();
3983 assert_eq!(events_5.len(), 1);
3985 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt: _ } => {
3986 assert_eq!(payment_hash_2, *payment_hash);
3987 assert_eq!(*payment_secret, None);
3989 _ => panic!("Unexpected event"),
3992 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
3993 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3994 check_added_monitors!(nodes[0], 1);
3996 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3999 fn do_test_htlc_timeout(send_partial_mpp: bool) {
4000 // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
4001 // to avoid our counterparty failing the channel.
4002 let chanmon_cfgs = create_chanmon_cfgs(2);
4003 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4004 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4005 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4007 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4008 let logger = test_utils::TestLogger::new();
4010 let our_payment_hash = if send_partial_mpp {
4011 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4012 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4013 let (_, our_payment_hash) = get_payment_preimage_hash!(&nodes[0]);
4014 let payment_secret = PaymentSecret([0xdb; 32]);
4015 // Use the utility function send_payment_along_path to send the payment with MPP data which
4016 // indicates there are more HTLCs coming.
4017 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.
4018 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200000, cur_height).unwrap();
4019 check_added_monitors!(nodes[0], 1);
4020 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4021 assert_eq!(events.len(), 1);
4022 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
4023 // hop should *not* yet generate any PaymentReceived event(s).
4024 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false);
4027 route_payment(&nodes[0], &[&nodes[1]], 100000).1
4030 let mut block = Block {
4031 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
4034 connect_block(&nodes[0], &block);
4035 connect_block(&nodes[1], &block);
4036 for _ in CHAN_CONFIRM_DEPTH + 2 ..TEST_FINAL_CLTV + CHAN_CONFIRM_DEPTH + 2 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS {
4037 block.header.prev_blockhash = block.block_hash();
4038 connect_block(&nodes[0], &block);
4039 connect_block(&nodes[1], &block);
4042 expect_pending_htlcs_forwardable!(nodes[1]);
4044 check_added_monitors!(nodes[1], 1);
4045 let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4046 assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
4047 assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
4048 assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
4049 assert!(htlc_timeout_updates.update_fee.is_none());
4051 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
4052 commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
4053 // 100_000 msat as u64, followed by a height of TEST_FINAL_CLTV + 2 as u32
4054 let mut expected_failure_data = byte_utils::be64_to_array(100_000).to_vec();
4055 expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(TEST_FINAL_CLTV + 2));
4056 expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
4060 fn test_htlc_timeout() {
4061 do_test_htlc_timeout(true);
4062 do_test_htlc_timeout(false);
4065 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
4066 // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
4067 let chanmon_cfgs = create_chanmon_cfgs(3);
4068 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4069 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4070 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4071 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4072 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
4074 // Make sure all nodes are at the same starting height
4075 connect_blocks(&nodes[0], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
4076 connect_blocks(&nodes[1], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
4077 connect_blocks(&nodes[2], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
4079 let logger = test_utils::TestLogger::new();
4081 // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
4082 let (_, first_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4084 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4085 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), None, None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4086 nodes[1].node.send_payment(&route, first_payment_hash, &None).unwrap();
4088 assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
4089 check_added_monitors!(nodes[1], 1);
4091 // Now attempt to route a second payment, which should be placed in the holding cell
4092 let (_, second_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4094 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4095 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), None, None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4096 nodes[0].node.send_payment(&route, second_payment_hash, &None).unwrap();
4097 check_added_monitors!(nodes[0], 1);
4098 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4099 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
4100 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4101 expect_pending_htlcs_forwardable!(nodes[1]);
4102 check_added_monitors!(nodes[1], 0);
4104 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4105 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), None, None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4106 nodes[1].node.send_payment(&route, second_payment_hash, &None).unwrap();
4107 check_added_monitors!(nodes[1], 0);
4110 connect_blocks(&nodes[1], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS);
4111 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4112 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4113 connect_blocks(&nodes[1], 1);
4116 expect_pending_htlcs_forwardable!(nodes[1]);
4117 check_added_monitors!(nodes[1], 1);
4118 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
4119 assert_eq!(fail_commit.len(), 1);
4120 match fail_commit[0] {
4121 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
4122 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
4123 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
4125 _ => unreachable!(),
4127 expect_payment_failed!(nodes[0], second_payment_hash, false);
4128 if let &MessageSendEvent::PaymentFailureNetworkUpdate { ref update } = &nodes[0].node.get_and_clear_pending_msg_events()[0] {
4130 &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {},
4131 _ => panic!("Unexpected event"),
4134 panic!("Unexpected event");
4137 expect_payment_failed!(nodes[1], second_payment_hash, true);
4142 fn test_holding_cell_htlc_add_timeouts() {
4143 do_test_holding_cell_htlc_add_timeouts(false);
4144 do_test_holding_cell_htlc_add_timeouts(true);
4148 fn test_invalid_channel_announcement() {
4149 //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
4150 let secp_ctx = Secp256k1::new();
4151 let chanmon_cfgs = create_chanmon_cfgs(2);
4152 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4153 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4154 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4156 let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
4158 let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
4159 let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
4160 let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4161 let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4163 nodes[0].net_graph_msg_handler.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap(), is_permanent: false } );
4165 let as_bitcoin_key = as_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4166 let bs_bitcoin_key = bs_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4168 let as_network_key = nodes[0].node.get_our_node_id();
4169 let bs_network_key = nodes[1].node.get_our_node_id();
4171 let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
4173 let mut chan_announcement;
4175 macro_rules! dummy_unsigned_msg {
4177 msgs::UnsignedChannelAnnouncement {
4178 features: ChannelFeatures::known(),
4179 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4180 short_channel_id: as_chan.get_short_channel_id().unwrap(),
4181 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
4182 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
4183 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
4184 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
4185 excess_data: Vec::new(),
4190 macro_rules! sign_msg {
4191 ($unsigned_msg: expr) => {
4192 let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
4193 let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_signer().inner.funding_key);
4194 let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_signer().inner.funding_key);
4195 let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
4196 let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
4197 chan_announcement = msgs::ChannelAnnouncement {
4198 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
4199 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
4200 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
4201 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
4202 contents: $unsigned_msg
4207 let unsigned_msg = dummy_unsigned_msg!();
4208 sign_msg!(unsigned_msg);
4209 assert_eq!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).unwrap(), true);
4210 let _ = nodes[0].net_graph_msg_handler.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap(), is_permanent: false } );
4212 // Configured with Network::Testnet
4213 let mut unsigned_msg = dummy_unsigned_msg!();
4214 unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.block_hash();
4215 sign_msg!(unsigned_msg);
4216 assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4218 let mut unsigned_msg = dummy_unsigned_msg!();
4219 unsigned_msg.chain_hash = BlockHash::hash(&[1,2,3,4,5,6,7,8,9]);
4220 sign_msg!(unsigned_msg);
4221 assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4225 fn test_no_txn_manager_serialize_deserialize() {
4226 let chanmon_cfgs = create_chanmon_cfgs(2);
4227 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4228 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4229 let logger: test_utils::TestLogger;
4230 let fee_estimator: test_utils::TestFeeEstimator;
4231 let persister: test_utils::TestPersister;
4232 let new_chain_monitor: test_utils::TestChainMonitor;
4233 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4234 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4236 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
4238 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4240 let nodes_0_serialized = nodes[0].node.encode();
4241 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4242 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4244 logger = test_utils::TestLogger::new();
4245 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4246 persister = test_utils::TestPersister::new();
4247 let keys_manager = &chanmon_cfgs[0].keys_manager;
4248 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4249 nodes[0].chain_monitor = &new_chain_monitor;
4250 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4251 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4252 &mut chan_0_monitor_read, keys_manager).unwrap();
4253 assert!(chan_0_monitor_read.is_empty());
4255 let mut nodes_0_read = &nodes_0_serialized[..];
4256 let config = UserConfig::default();
4257 let (_, nodes_0_deserialized_tmp) = {
4258 let mut channel_monitors = HashMap::new();
4259 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4260 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4261 default_config: config,
4263 fee_estimator: &fee_estimator,
4264 chain_monitor: nodes[0].chain_monitor,
4265 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4270 nodes_0_deserialized = nodes_0_deserialized_tmp;
4271 assert!(nodes_0_read.is_empty());
4273 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4274 nodes[0].node = &nodes_0_deserialized;
4275 assert_eq!(nodes[0].node.list_channels().len(), 1);
4276 check_added_monitors!(nodes[0], 1);
4278 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4279 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4280 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4281 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4283 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4284 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4285 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4286 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4288 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4289 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4290 for node in nodes.iter() {
4291 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4292 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4293 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4296 send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
4300 fn test_manager_serialize_deserialize_events() {
4301 // This test makes sure the events field in ChannelManager survives de/serialization
4302 let chanmon_cfgs = create_chanmon_cfgs(2);
4303 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4304 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4305 let fee_estimator: test_utils::TestFeeEstimator;
4306 let persister: test_utils::TestPersister;
4307 let logger: test_utils::TestLogger;
4308 let new_chain_monitor: test_utils::TestChainMonitor;
4309 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4310 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4312 // Start creating a channel, but stop right before broadcasting the funding transaction
4313 let channel_value = 100000;
4314 let push_msat = 10001;
4315 let a_flags = InitFeatures::known();
4316 let b_flags = InitFeatures::known();
4317 let node_a = nodes.remove(0);
4318 let node_b = nodes.remove(0);
4319 node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
4320 node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), a_flags, &get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id()));
4321 node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), b_flags, &get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id()));
4323 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&node_a, channel_value, 42);
4325 node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
4326 check_added_monitors!(node_a, 0);
4328 node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id()));
4330 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
4331 assert_eq!(added_monitors.len(), 1);
4332 assert_eq!(added_monitors[0].0, funding_output);
4333 added_monitors.clear();
4336 node_a.node.handle_funding_signed(&node_b.node.get_our_node_id(), &get_event_msg!(node_b, MessageSendEvent::SendFundingSigned, node_a.node.get_our_node_id()));
4338 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
4339 assert_eq!(added_monitors.len(), 1);
4340 assert_eq!(added_monitors[0].0, funding_output);
4341 added_monitors.clear();
4343 // Normally, this is where node_a would broadcast the funding transaction, but the test de/serializes first instead
4348 // Start the de/seriailization process mid-channel creation to check that the channel manager will hold onto events that are serialized
4349 let nodes_0_serialized = nodes[0].node.encode();
4350 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4351 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4353 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4354 logger = test_utils::TestLogger::new();
4355 persister = test_utils::TestPersister::new();
4356 let keys_manager = &chanmon_cfgs[0].keys_manager;
4357 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4358 nodes[0].chain_monitor = &new_chain_monitor;
4359 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4360 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4361 &mut chan_0_monitor_read, keys_manager).unwrap();
4362 assert!(chan_0_monitor_read.is_empty());
4364 let mut nodes_0_read = &nodes_0_serialized[..];
4365 let config = UserConfig::default();
4366 let (_, nodes_0_deserialized_tmp) = {
4367 let mut channel_monitors = HashMap::new();
4368 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4369 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4370 default_config: config,
4372 fee_estimator: &fee_estimator,
4373 chain_monitor: nodes[0].chain_monitor,
4374 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4379 nodes_0_deserialized = nodes_0_deserialized_tmp;
4380 assert!(nodes_0_read.is_empty());
4382 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4384 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4385 nodes[0].node = &nodes_0_deserialized;
4387 // After deserializing, make sure the funding_transaction is still held by the channel manager
4388 let events_4 = nodes[0].node.get_and_clear_pending_events();
4389 assert_eq!(events_4.len(), 0);
4390 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
4391 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
4393 // Make sure the channel is functioning as though the de/serialization never happened
4394 assert_eq!(nodes[0].node.list_channels().len(), 1);
4395 check_added_monitors!(nodes[0], 1);
4397 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4398 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4399 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4400 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4402 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4403 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4404 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4405 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4407 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4408 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4409 for node in nodes.iter() {
4410 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4411 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4412 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4415 send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
4419 fn test_simple_manager_serialize_deserialize() {
4420 let chanmon_cfgs = create_chanmon_cfgs(2);
4421 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4422 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4423 let logger: test_utils::TestLogger;
4424 let fee_estimator: test_utils::TestFeeEstimator;
4425 let persister: test_utils::TestPersister;
4426 let new_chain_monitor: test_utils::TestChainMonitor;
4427 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4428 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4429 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4431 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4432 let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4434 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4436 let nodes_0_serialized = nodes[0].node.encode();
4437 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4438 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4440 logger = test_utils::TestLogger::new();
4441 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4442 persister = test_utils::TestPersister::new();
4443 let keys_manager = &chanmon_cfgs[0].keys_manager;
4444 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4445 nodes[0].chain_monitor = &new_chain_monitor;
4446 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4447 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4448 &mut chan_0_monitor_read, keys_manager).unwrap();
4449 assert!(chan_0_monitor_read.is_empty());
4451 let mut nodes_0_read = &nodes_0_serialized[..];
4452 let (_, nodes_0_deserialized_tmp) = {
4453 let mut channel_monitors = HashMap::new();
4454 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4455 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4456 default_config: UserConfig::default(),
4458 fee_estimator: &fee_estimator,
4459 chain_monitor: nodes[0].chain_monitor,
4460 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4465 nodes_0_deserialized = nodes_0_deserialized_tmp;
4466 assert!(nodes_0_read.is_empty());
4468 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4469 nodes[0].node = &nodes_0_deserialized;
4470 check_added_monitors!(nodes[0], 1);
4472 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4474 fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
4475 claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage, 1_000_000);
4479 fn test_manager_serialize_deserialize_inconsistent_monitor() {
4480 // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
4481 let chanmon_cfgs = create_chanmon_cfgs(4);
4482 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4483 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4484 let logger: test_utils::TestLogger;
4485 let fee_estimator: test_utils::TestFeeEstimator;
4486 let persister: test_utils::TestPersister;
4487 let new_chain_monitor: test_utils::TestChainMonitor;
4488 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4489 let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4490 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4491 create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::known(), InitFeatures::known());
4492 let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
4494 let mut node_0_stale_monitors_serialized = Vec::new();
4495 for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4496 let mut writer = test_utils::TestVecWriter(Vec::new());
4497 monitor.1.write(&mut writer).unwrap();
4498 node_0_stale_monitors_serialized.push(writer.0);
4501 let (our_payment_preimage, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
4503 // Serialize the ChannelManager here, but the monitor we keep up-to-date
4504 let nodes_0_serialized = nodes[0].node.encode();
4506 route_payment(&nodes[0], &[&nodes[3]], 1000000);
4507 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4508 nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4509 nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4511 // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
4513 let mut node_0_monitors_serialized = Vec::new();
4514 for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4515 let mut writer = test_utils::TestVecWriter(Vec::new());
4516 monitor.1.write(&mut writer).unwrap();
4517 node_0_monitors_serialized.push(writer.0);
4520 logger = test_utils::TestLogger::new();
4521 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4522 persister = test_utils::TestPersister::new();
4523 let keys_manager = &chanmon_cfgs[0].keys_manager;
4524 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4525 nodes[0].chain_monitor = &new_chain_monitor;
4528 let mut node_0_stale_monitors = Vec::new();
4529 for serialized in node_0_stale_monitors_serialized.iter() {
4530 let mut read = &serialized[..];
4531 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4532 assert!(read.is_empty());
4533 node_0_stale_monitors.push(monitor);
4536 let mut node_0_monitors = Vec::new();
4537 for serialized in node_0_monitors_serialized.iter() {
4538 let mut read = &serialized[..];
4539 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4540 assert!(read.is_empty());
4541 node_0_monitors.push(monitor);
4544 let mut nodes_0_read = &nodes_0_serialized[..];
4545 if let Err(msgs::DecodeError::InvalidValue) =
4546 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4547 default_config: UserConfig::default(),
4549 fee_estimator: &fee_estimator,
4550 chain_monitor: nodes[0].chain_monitor,
4551 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4553 channel_monitors: node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4555 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
4558 let mut nodes_0_read = &nodes_0_serialized[..];
4559 let (_, nodes_0_deserialized_tmp) =
4560 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4561 default_config: UserConfig::default(),
4563 fee_estimator: &fee_estimator,
4564 chain_monitor: nodes[0].chain_monitor,
4565 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4567 channel_monitors: node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4569 nodes_0_deserialized = nodes_0_deserialized_tmp;
4570 assert!(nodes_0_read.is_empty());
4572 { // Channel close should result in a commitment tx and an HTLC tx
4573 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4574 assert_eq!(txn.len(), 2);
4575 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
4576 assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
4579 for monitor in node_0_monitors.drain(..) {
4580 assert!(nodes[0].chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor).is_ok());
4581 check_added_monitors!(nodes[0], 1);
4583 nodes[0].node = &nodes_0_deserialized;
4585 // nodes[1] and nodes[2] have no lost state with nodes[0]...
4586 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4587 reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4588 //... and we can even still claim the payment!
4589 claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage, 1_000_000);
4591 nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4592 let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4593 nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4594 nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
4595 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4596 assert_eq!(msg_events.len(), 1);
4597 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
4599 &ErrorAction::SendErrorMessage { ref msg } => {
4600 assert_eq!(msg.channel_id, channel_id);
4602 _ => panic!("Unexpected event!"),
4607 macro_rules! check_spendable_outputs {
4608 ($node: expr, $der_idx: expr, $keysinterface: expr, $chan_value: expr) => {
4610 let mut events = $node.chain_monitor.chain_monitor.get_and_clear_pending_events();
4611 let mut txn = Vec::new();
4612 let mut all_outputs = Vec::new();
4613 let secp_ctx = Secp256k1::new();
4614 for event in events.drain(..) {
4616 Event::SpendableOutputs { mut outputs } => {
4617 for outp in outputs.drain(..) {
4618 txn.push($keysinterface.backing.spend_spendable_outputs(&[&outp], Vec::new(), Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &secp_ctx).unwrap());
4619 all_outputs.push(outp);
4622 _ => panic!("Unexpected event"),
4625 if all_outputs.len() > 1 {
4626 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) {
4636 fn test_claim_sizeable_push_msat() {
4637 // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4638 let chanmon_cfgs = create_chanmon_cfgs(2);
4639 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4640 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4641 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4643 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4644 nodes[1].node.force_close_channel(&chan.2).unwrap();
4645 check_closed_broadcast!(nodes[1], true);
4646 check_added_monitors!(nodes[1], 1);
4647 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4648 assert_eq!(node_txn.len(), 1);
4649 check_spends!(node_txn[0], chan.3);
4650 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
4652 mine_transaction(&nodes[1], &node_txn[0]);
4653 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4655 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4656 assert_eq!(spend_txn.len(), 1);
4657 check_spends!(spend_txn[0], node_txn[0]);
4661 fn test_claim_on_remote_sizeable_push_msat() {
4662 // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4663 // to_remote output is encumbered by a P2WPKH
4664 let chanmon_cfgs = create_chanmon_cfgs(2);
4665 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4666 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4667 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4669 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4670 nodes[0].node.force_close_channel(&chan.2).unwrap();
4671 check_closed_broadcast!(nodes[0], true);
4672 check_added_monitors!(nodes[0], 1);
4674 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4675 assert_eq!(node_txn.len(), 1);
4676 check_spends!(node_txn[0], chan.3);
4677 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
4679 mine_transaction(&nodes[1], &node_txn[0]);
4680 check_closed_broadcast!(nodes[1], true);
4681 check_added_monitors!(nodes[1], 1);
4682 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4684 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4685 assert_eq!(spend_txn.len(), 1);
4686 check_spends!(spend_txn[0], node_txn[0]);
4690 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4691 // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4692 // to_remote output is encumbered by a P2WPKH
4694 let chanmon_cfgs = create_chanmon_cfgs(2);
4695 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4696 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4697 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4699 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::known(), InitFeatures::known());
4700 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4701 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4702 assert_eq!(revoked_local_txn[0].input.len(), 1);
4703 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4705 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4706 mine_transaction(&nodes[1], &revoked_local_txn[0]);
4707 check_closed_broadcast!(nodes[1], true);
4708 check_added_monitors!(nodes[1], 1);
4710 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4711 mine_transaction(&nodes[1], &node_txn[0]);
4712 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4714 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4715 assert_eq!(spend_txn.len(), 3);
4716 check_spends!(spend_txn[0], revoked_local_txn[0]); // to_remote output on revoked remote commitment_tx
4717 check_spends!(spend_txn[1], node_txn[0]);
4718 check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[0]); // Both outputs
4722 fn test_static_spendable_outputs_preimage_tx() {
4723 let chanmon_cfgs = create_chanmon_cfgs(2);
4724 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4725 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4726 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4728 // Create some initial channels
4729 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4731 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4733 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4734 assert_eq!(commitment_tx[0].input.len(), 1);
4735 assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4737 // Settle A's commitment tx on B's chain
4738 assert!(nodes[1].node.claim_funds(payment_preimage, &None, 3_000_000));
4739 check_added_monitors!(nodes[1], 1);
4740 mine_transaction(&nodes[1], &commitment_tx[0]);
4741 check_added_monitors!(nodes[1], 1);
4742 let events = nodes[1].node.get_and_clear_pending_msg_events();
4744 MessageSendEvent::UpdateHTLCs { .. } => {},
4745 _ => panic!("Unexpected event"),
4748 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4749 _ => panic!("Unexepected event"),
4752 // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4753 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4754 assert_eq!(node_txn.len(), 3);
4755 check_spends!(node_txn[0], commitment_tx[0]);
4756 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4757 check_spends!(node_txn[1], chan_1.3);
4758 check_spends!(node_txn[2], node_txn[1]);
4760 mine_transaction(&nodes[1], &node_txn[0]);
4761 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4763 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4764 assert_eq!(spend_txn.len(), 1);
4765 check_spends!(spend_txn[0], node_txn[0]);
4769 fn test_static_spendable_outputs_timeout_tx() {
4770 let chanmon_cfgs = create_chanmon_cfgs(2);
4771 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4772 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4773 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4775 // Create some initial channels
4776 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4778 // Rebalance the network a bit by relaying one payment through all the channels ...
4779 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
4781 let (_, our_payment_hash) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
4783 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4784 assert_eq!(commitment_tx[0].input.len(), 1);
4785 assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4787 // Settle A's commitment tx on B' chain
4788 mine_transaction(&nodes[1], &commitment_tx[0]);
4789 check_added_monitors!(nodes[1], 1);
4790 let events = nodes[1].node.get_and_clear_pending_msg_events();
4792 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4793 _ => panic!("Unexpected event"),
4796 // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
4797 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4798 assert_eq!(node_txn.len(), 3); // ChannelManager : 2 (local commitent tx + HTLC-timeout), ChannelMonitor: timeout tx
4799 check_spends!(node_txn[0], commitment_tx[0].clone());
4800 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4801 check_spends!(node_txn[1], chan_1.3.clone());
4802 check_spends!(node_txn[2], node_txn[1]);
4804 mine_transaction(&nodes[1], &node_txn[0]);
4805 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4806 expect_payment_failed!(nodes[1], our_payment_hash, true);
4808 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4809 assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote, timeout_tx.output
4810 check_spends!(spend_txn[0], commitment_tx[0]);
4811 check_spends!(spend_txn[1], node_txn[0]);
4812 check_spends!(spend_txn[2], node_txn[0], commitment_tx[0]); // All outputs
4816 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
4817 let chanmon_cfgs = create_chanmon_cfgs(2);
4818 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4819 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4820 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4822 // Create some initial channels
4823 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4825 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4826 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4827 assert_eq!(revoked_local_txn[0].input.len(), 1);
4828 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4830 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4832 mine_transaction(&nodes[1], &revoked_local_txn[0]);
4833 check_closed_broadcast!(nodes[1], true);
4834 check_added_monitors!(nodes[1], 1);
4836 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4837 assert_eq!(node_txn.len(), 2);
4838 assert_eq!(node_txn[0].input.len(), 2);
4839 check_spends!(node_txn[0], revoked_local_txn[0]);
4841 mine_transaction(&nodes[1], &node_txn[0]);
4842 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4844 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4845 assert_eq!(spend_txn.len(), 1);
4846 check_spends!(spend_txn[0], node_txn[0]);
4850 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
4851 let mut chanmon_cfgs = create_chanmon_cfgs(2);
4852 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
4853 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4854 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4855 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4857 // Create some initial channels
4858 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4860 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4861 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4862 assert_eq!(revoked_local_txn[0].input.len(), 1);
4863 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4865 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4867 // A will generate HTLC-Timeout from revoked commitment tx
4868 mine_transaction(&nodes[0], &revoked_local_txn[0]);
4869 check_closed_broadcast!(nodes[0], true);
4870 check_added_monitors!(nodes[0], 1);
4872 let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4873 assert_eq!(revoked_htlc_txn.len(), 2);
4874 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4875 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4876 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
4877 check_spends!(revoked_htlc_txn[1], chan_1.3);
4879 // B will generate justice tx from A's revoked commitment/HTLC tx
4880 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4881 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] });
4882 check_closed_broadcast!(nodes[1], true);
4883 check_added_monitors!(nodes[1], 1);
4885 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4886 assert_eq!(node_txn.len(), 3); // ChannelMonitor: bogus justice tx, justice tx on revoked outputs, ChannelManager: local commitment tx
4887 // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
4888 // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
4889 // transactions next...
4890 assert_eq!(node_txn[0].input.len(), 3);
4891 check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
4893 assert_eq!(node_txn[1].input.len(), 2);
4894 check_spends!(node_txn[1], revoked_local_txn[0], revoked_htlc_txn[0]);
4895 if node_txn[1].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
4896 assert_ne!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4898 assert_eq!(node_txn[1].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
4899 assert_ne!(node_txn[1].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4902 assert_eq!(node_txn[2].input.len(), 1);
4903 check_spends!(node_txn[2], chan_1.3);
4905 mine_transaction(&nodes[1], &node_txn[1]);
4906 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4908 // Check B's ChannelMonitor was able to generate the right spendable output descriptor
4909 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4910 assert_eq!(spend_txn.len(), 1);
4911 assert_eq!(spend_txn[0].input.len(), 1);
4912 check_spends!(spend_txn[0], node_txn[1]);
4916 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
4917 let mut chanmon_cfgs = create_chanmon_cfgs(2);
4918 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
4919 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4920 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4921 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4923 // Create some initial channels
4924 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4926 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4927 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
4928 assert_eq!(revoked_local_txn[0].input.len(), 1);
4929 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4931 // The to-be-revoked commitment tx should have one HTLC and one to_remote output
4932 assert_eq!(revoked_local_txn[0].output.len(), 2);
4934 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4936 // B will generate HTLC-Success from revoked commitment tx
4937 mine_transaction(&nodes[1], &revoked_local_txn[0]);
4938 check_closed_broadcast!(nodes[1], true);
4939 check_added_monitors!(nodes[1], 1);
4940 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4942 assert_eq!(revoked_htlc_txn.len(), 2);
4943 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4944 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4945 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
4947 // Check that the unspent (of two) outputs on revoked_local_txn[0] is a P2WPKH:
4948 let unspent_local_txn_output = revoked_htlc_txn[0].input[0].previous_output.vout as usize ^ 1;
4949 assert_eq!(revoked_local_txn[0].output[unspent_local_txn_output].script_pubkey.len(), 2 + 20); // P2WPKH
4951 // A will generate justice tx from B's revoked commitment/HTLC tx
4952 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4953 connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] });
4954 check_closed_broadcast!(nodes[0], true);
4955 check_added_monitors!(nodes[0], 1);
4957 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4958 assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
4960 // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
4961 // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
4962 // transactions next...
4963 assert_eq!(node_txn[0].input.len(), 2);
4964 check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
4965 if node_txn[0].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
4966 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4968 assert_eq!(node_txn[0].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
4969 assert_eq!(node_txn[0].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4972 assert_eq!(node_txn[1].input.len(), 1);
4973 check_spends!(node_txn[1], revoked_htlc_txn[0]);
4975 check_spends!(node_txn[2], chan_1.3);
4977 mine_transaction(&nodes[0], &node_txn[1]);
4978 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
4980 // Note that nodes[0]'s tx_broadcaster is still locked, so if we get here the channelmonitor
4981 // didn't try to generate any new transactions.
4983 // Check A's ChannelMonitor was able to generate the right spendable output descriptor
4984 let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
4985 assert_eq!(spend_txn.len(), 3);
4986 assert_eq!(spend_txn[0].input.len(), 1);
4987 check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
4988 assert_ne!(spend_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4989 check_spends!(spend_txn[1], node_txn[1]); // spending justice tx output on the htlc success tx
4990 check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[1]); // Both outputs
4994 fn test_onchain_to_onchain_claim() {
4995 // Test that in case of channel closure, we detect the state of output and claim HTLC
4996 // on downstream peer's remote commitment tx.
4997 // First, have C claim an HTLC against its own latest commitment transaction.
4998 // Then, broadcast these to B, which should update the monitor downstream on the A<->B
5000 // Finally, check that B will claim the HTLC output if A's latest commitment transaction
5003 let chanmon_cfgs = create_chanmon_cfgs(3);
5004 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5005 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5006 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5008 // Create some initial channels
5009 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5010 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5012 // Rebalance the network a bit by relaying one payment through all the channels ...
5013 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
5014 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
5016 let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
5017 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
5018 check_spends!(commitment_tx[0], chan_2.3);
5019 nodes[2].node.claim_funds(payment_preimage, &None, 3_000_000);
5020 check_added_monitors!(nodes[2], 1);
5021 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5022 assert!(updates.update_add_htlcs.is_empty());
5023 assert!(updates.update_fail_htlcs.is_empty());
5024 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5025 assert!(updates.update_fail_malformed_htlcs.is_empty());
5027 mine_transaction(&nodes[2], &commitment_tx[0]);
5028 check_closed_broadcast!(nodes[2], true);
5029 check_added_monitors!(nodes[2], 1);
5031 let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
5032 assert_eq!(c_txn.len(), 3);
5033 assert_eq!(c_txn[0], c_txn[2]);
5034 assert_eq!(commitment_tx[0], c_txn[1]);
5035 check_spends!(c_txn[1], chan_2.3);
5036 check_spends!(c_txn[2], c_txn[1]);
5037 assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
5038 assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5039 assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5040 assert_eq!(c_txn[0].lock_time, 0); // Success tx
5042 // 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
5043 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
5044 connect_block(&nodes[1], &Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]});
5046 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5047 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-timeout tx
5048 assert_eq!(b_txn.len(), 3);
5049 check_spends!(b_txn[1], chan_2.3); // B local commitment tx, issued by ChannelManager
5050 check_spends!(b_txn[2], b_txn[1]); // HTLC-Timeout on B local commitment tx, issued by ChannelManager
5051 assert_eq!(b_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5052 assert!(b_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5053 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
5054 check_spends!(b_txn[0], c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor
5055 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5056 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5057 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
5060 check_added_monitors!(nodes[1], 1);
5061 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5062 assert_eq!(msg_events.len(), 3);
5063 check_added_monitors!(nodes[1], 1);
5064 match msg_events[0] {
5065 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5066 _ => panic!("Unexpected event"),
5068 match msg_events[1] {
5069 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
5070 _ => panic!("Unexpected event"),
5072 match msg_events[2] {
5073 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, .. } } => {
5074 assert!(update_add_htlcs.is_empty());
5075 assert!(update_fail_htlcs.is_empty());
5076 assert_eq!(update_fulfill_htlcs.len(), 1);
5077 assert!(update_fail_malformed_htlcs.is_empty());
5078 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
5080 _ => panic!("Unexpected event"),
5082 // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
5083 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5084 mine_transaction(&nodes[1], &commitment_tx[0]);
5085 let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5086 // ChannelMonitor: HTLC-Success tx, ChannelManager: local commitment tx + HTLC-Success tx
5087 assert_eq!(b_txn.len(), 3);
5088 check_spends!(b_txn[1], chan_1.3);
5089 check_spends!(b_txn[2], b_txn[1]);
5090 check_spends!(b_txn[0], commitment_tx[0]);
5091 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5092 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5093 assert_eq!(b_txn[0].lock_time, 0); // Success tx
5095 check_closed_broadcast!(nodes[1], true);
5096 check_added_monitors!(nodes[1], 1);
5100 fn test_duplicate_payment_hash_one_failure_one_success() {
5101 // Topology : A --> B --> C
5102 // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
5103 let chanmon_cfgs = create_chanmon_cfgs(3);
5104 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5105 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5106 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5108 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5109 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5111 let (our_payment_preimage, duplicate_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
5112 *nodes[0].network_payment_count.borrow_mut() -= 1;
5113 assert_eq!(route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000).1, duplicate_payment_hash);
5115 let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
5116 assert_eq!(commitment_txn[0].input.len(), 1);
5117 check_spends!(commitment_txn[0], chan_2.3);
5119 mine_transaction(&nodes[1], &commitment_txn[0]);
5120 check_closed_broadcast!(nodes[1], true);
5121 check_added_monitors!(nodes[1], 1);
5123 let htlc_timeout_tx;
5124 { // Extract one of the two HTLC-Timeout transaction
5125 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5126 // ChannelMonitor: timeout tx * 2, ChannelManager: local commitment tx + HTLC-timeout * 2
5127 assert_eq!(node_txn.len(), 5);
5128 check_spends!(node_txn[0], commitment_txn[0]);
5129 assert_eq!(node_txn[0].input.len(), 1);
5130 check_spends!(node_txn[1], commitment_txn[0]);
5131 assert_eq!(node_txn[1].input.len(), 1);
5132 assert_ne!(node_txn[0].input[0], node_txn[1].input[0]);
5133 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5134 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5135 check_spends!(node_txn[2], chan_2.3);
5136 check_spends!(node_txn[3], node_txn[2]);
5137 check_spends!(node_txn[4], node_txn[2]);
5138 htlc_timeout_tx = node_txn[1].clone();
5141 nodes[2].node.claim_funds(our_payment_preimage, &None, 900_000);
5142 mine_transaction(&nodes[2], &commitment_txn[0]);
5143 check_added_monitors!(nodes[2], 3);
5144 let events = nodes[2].node.get_and_clear_pending_msg_events();
5146 MessageSendEvent::UpdateHTLCs { .. } => {},
5147 _ => panic!("Unexpected event"),
5150 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5151 _ => panic!("Unexepected event"),
5153 let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5154 assert_eq!(htlc_success_txn.len(), 5); // ChannelMonitor: HTLC-Success txn (*2 due to 2-HTLC outputs), ChannelManager: local commitment tx + HTLC-Success txn (*2 due to 2-HTLC outputs)
5155 check_spends!(htlc_success_txn[2], chan_2.3);
5156 check_spends!(htlc_success_txn[3], htlc_success_txn[2]);
5157 check_spends!(htlc_success_txn[4], htlc_success_txn[2]);
5158 assert_eq!(htlc_success_txn[0], htlc_success_txn[3]);
5159 assert_eq!(htlc_success_txn[0].input.len(), 1);
5160 assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5161 assert_eq!(htlc_success_txn[1], htlc_success_txn[4]);
5162 assert_eq!(htlc_success_txn[1].input.len(), 1);
5163 assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5164 assert_ne!(htlc_success_txn[0].input[0], htlc_success_txn[1].input[0]);
5165 check_spends!(htlc_success_txn[0], commitment_txn[0]);
5166 check_spends!(htlc_success_txn[1], commitment_txn[0]);
5168 mine_transaction(&nodes[1], &htlc_timeout_tx);
5169 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5170 expect_pending_htlcs_forwardable!(nodes[1]);
5171 let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5172 assert!(htlc_updates.update_add_htlcs.is_empty());
5173 assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5174 assert_eq!(htlc_updates.update_fail_htlcs[0].htlc_id, 1);
5175 assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5176 assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5177 check_added_monitors!(nodes[1], 1);
5179 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
5180 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5182 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5183 let events = nodes[0].node.get_and_clear_pending_msg_events();
5184 assert_eq!(events.len(), 1);
5186 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. } } => {
5188 _ => { panic!("Unexpected event"); }
5191 expect_payment_failed!(nodes[0], duplicate_payment_hash, false);
5193 // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5194 mine_transaction(&nodes[1], &htlc_success_txn[0]);
5195 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5196 assert!(updates.update_add_htlcs.is_empty());
5197 assert!(updates.update_fail_htlcs.is_empty());
5198 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5199 assert_eq!(updates.update_fulfill_htlcs[0].htlc_id, 0);
5200 assert!(updates.update_fail_malformed_htlcs.is_empty());
5201 check_added_monitors!(nodes[1], 1);
5203 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
5204 commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5206 let events = nodes[0].node.get_and_clear_pending_events();
5208 Event::PaymentSent { ref payment_preimage } => {
5209 assert_eq!(*payment_preimage, our_payment_preimage);
5211 _ => panic!("Unexpected event"),
5216 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
5217 let chanmon_cfgs = create_chanmon_cfgs(2);
5218 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5219 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5220 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5222 // Create some initial channels
5223 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5225 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5226 let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5227 assert_eq!(local_txn.len(), 1);
5228 assert_eq!(local_txn[0].input.len(), 1);
5229 check_spends!(local_txn[0], chan_1.3);
5231 // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5232 nodes[1].node.claim_funds(payment_preimage, &None, 9_000_000);
5233 check_added_monitors!(nodes[1], 1);
5234 mine_transaction(&nodes[1], &local_txn[0]);
5235 check_added_monitors!(nodes[1], 1);
5236 let events = nodes[1].node.get_and_clear_pending_msg_events();
5238 MessageSendEvent::UpdateHTLCs { .. } => {},
5239 _ => panic!("Unexpected event"),
5242 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5243 _ => panic!("Unexepected event"),
5246 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5247 assert_eq!(node_txn.len(), 3);
5248 assert_eq!(node_txn[0], node_txn[2]);
5249 assert_eq!(node_txn[1], local_txn[0]);
5250 assert_eq!(node_txn[0].input.len(), 1);
5251 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5252 check_spends!(node_txn[0], local_txn[0]);
5256 mine_transaction(&nodes[1], &node_tx);
5257 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5259 // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5260 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5261 assert_eq!(spend_txn.len(), 1);
5262 check_spends!(spend_txn[0], node_tx);
5265 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
5266 // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
5267 // unrevoked commitment transaction.
5268 // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
5269 // a remote RAA before they could be failed backwards (and combinations thereof).
5270 // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
5271 // use the same payment hashes.
5272 // Thus, we use a six-node network:
5277 // And test where C fails back to A/B when D announces its latest commitment transaction
5278 let chanmon_cfgs = create_chanmon_cfgs(6);
5279 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
5280 let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
5281 let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
5282 let logger = test_utils::TestLogger::new();
5284 create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5285 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5286 let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5287 create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
5288 create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
5290 // Rebalance and check output sanity...
5291 send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000, 500_000);
5292 send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000, 500_000);
5293 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
5295 let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
5297 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
5299 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
5300 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
5301 let our_node_id = &nodes[1].node.get_our_node_id();
5302 let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), None, None, &Vec::new(), ds_dust_limit*1000, TEST_FINAL_CLTV, &logger).unwrap();
5304 send_along_route_with_hash(&nodes[1], route.clone(), &[&nodes[2], &nodes[3], &nodes[5]], ds_dust_limit*1000, payment_hash_1); // not added < dust limit + HTLC tx fee
5306 send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], ds_dust_limit*1000, payment_hash_2); // not added < dust limit + HTLC tx fee
5308 let (_, payment_hash_3) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5310 let (_, payment_hash_4) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5311 let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), None, None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
5313 send_along_route_with_hash(&nodes[1], route.clone(), &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_3);
5315 send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_4);
5318 let (_, payment_hash_5) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5320 let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), None, None, &Vec::new(), ds_dust_limit*1000, TEST_FINAL_CLTV, &logger).unwrap();
5321 send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], ds_dust_limit*1000, payment_hash_5); // not added < dust limit + HTLC tx fee
5324 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
5326 let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), None, None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
5327 send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_6);
5329 // Double-check that six of the new HTLC were added
5330 // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
5331 // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
5332 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
5333 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
5335 // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
5336 // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
5337 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1, &None));
5338 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3, &None));
5339 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5, &None));
5340 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6, &None));
5341 check_added_monitors!(nodes[4], 0);
5342 expect_pending_htlcs_forwardable!(nodes[4]);
5343 check_added_monitors!(nodes[4], 1);
5345 let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
5346 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
5347 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
5348 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
5349 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
5350 commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
5352 // Fail 3rd below-dust and 7th above-dust HTLCs
5353 assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2, &None));
5354 assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4, &None));
5355 check_added_monitors!(nodes[5], 0);
5356 expect_pending_htlcs_forwardable!(nodes[5]);
5357 check_added_monitors!(nodes[5], 1);
5359 let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5360 nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5361 nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5362 commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5364 let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5366 expect_pending_htlcs_forwardable!(nodes[3]);
5367 check_added_monitors!(nodes[3], 1);
5368 let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5369 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5370 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5371 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5372 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5373 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5374 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5375 if deliver_last_raa {
5376 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5378 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5381 // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5382 // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5383 // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5384 // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5386 // We now broadcast the latest commitment transaction, which *should* result in failures for
5387 // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5388 // the non-broadcast above-dust HTLCs.
5390 // Alternatively, we may broadcast the previous commitment transaction, which should only
5391 // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5392 let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5394 if announce_latest {
5395 mine_transaction(&nodes[2], &ds_last_commitment_tx[0]);
5397 mine_transaction(&nodes[2], &ds_prev_commitment_tx[0]);
5399 connect_blocks(&nodes[2], ANTI_REORG_DELAY - 1);
5400 check_closed_broadcast!(nodes[2], true);
5401 expect_pending_htlcs_forwardable!(nodes[2]);
5402 check_added_monitors!(nodes[2], 3);
5404 let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5405 assert_eq!(cs_msgs.len(), 2);
5406 let mut a_done = false;
5407 for msg in cs_msgs {
5409 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5410 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5411 // should be failed-backwards here.
5412 let target = if *node_id == nodes[0].node.get_our_node_id() {
5413 // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5414 for htlc in &updates.update_fail_htlcs {
5415 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 });
5417 assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5422 // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5423 for htlc in &updates.update_fail_htlcs {
5424 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5426 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5427 assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5430 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5431 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5432 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5433 if announce_latest {
5434 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5435 if *node_id == nodes[0].node.get_our_node_id() {
5436 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5439 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5441 _ => panic!("Unexpected event"),
5445 let as_events = nodes[0].node.get_and_clear_pending_events();
5446 assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
5447 let mut as_failds = HashSet::new();
5448 for event in as_events.iter() {
5449 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5450 assert!(as_failds.insert(*payment_hash));
5451 if *payment_hash != payment_hash_2 {
5452 assert_eq!(*rejected_by_dest, deliver_last_raa);
5454 assert!(!rejected_by_dest);
5456 } else { panic!("Unexpected event"); }
5458 assert!(as_failds.contains(&payment_hash_1));
5459 assert!(as_failds.contains(&payment_hash_2));
5460 if announce_latest {
5461 assert!(as_failds.contains(&payment_hash_3));
5462 assert!(as_failds.contains(&payment_hash_5));
5464 assert!(as_failds.contains(&payment_hash_6));
5466 let bs_events = nodes[1].node.get_and_clear_pending_events();
5467 assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
5468 let mut bs_failds = HashSet::new();
5469 for event in bs_events.iter() {
5470 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5471 assert!(bs_failds.insert(*payment_hash));
5472 if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5473 assert_eq!(*rejected_by_dest, deliver_last_raa);
5475 assert!(!rejected_by_dest);
5477 } else { panic!("Unexpected event"); }
5479 assert!(bs_failds.contains(&payment_hash_1));
5480 assert!(bs_failds.contains(&payment_hash_2));
5481 if announce_latest {
5482 assert!(bs_failds.contains(&payment_hash_4));
5484 assert!(bs_failds.contains(&payment_hash_5));
5486 // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5487 // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
5488 // to unknown-preimage-etc, B should have gotten 2. Thus, in the
5489 // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
5490 // PaymentFailureNetworkUpdates.
5491 let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
5492 assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5493 let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5494 assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5495 for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
5497 &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
5498 _ => panic!("Unexpected event"),
5504 fn test_fail_backwards_latest_remote_announce_a() {
5505 do_test_fail_backwards_unrevoked_remote_announce(false, true);
5509 fn test_fail_backwards_latest_remote_announce_b() {
5510 do_test_fail_backwards_unrevoked_remote_announce(true, true);
5514 fn test_fail_backwards_previous_remote_announce() {
5515 do_test_fail_backwards_unrevoked_remote_announce(false, false);
5516 // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5517 // tested for in test_commitment_revoked_fail_backward_exhaustive()
5521 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5522 let chanmon_cfgs = create_chanmon_cfgs(2);
5523 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5524 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5525 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5527 // Create some initial channels
5528 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5530 let (_, our_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5531 let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5532 assert_eq!(local_txn[0].input.len(), 1);
5533 check_spends!(local_txn[0], chan_1.3);
5535 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5536 mine_transaction(&nodes[0], &local_txn[0]);
5537 check_closed_broadcast!(nodes[0], true);
5538 check_added_monitors!(nodes[0], 1);
5540 let htlc_timeout = {
5541 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5542 assert_eq!(node_txn[0].input.len(), 1);
5543 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5544 check_spends!(node_txn[0], local_txn[0]);
5548 mine_transaction(&nodes[0], &htlc_timeout);
5549 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5550 expect_payment_failed!(nodes[0], our_payment_hash, true);
5552 // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5553 let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
5554 assert_eq!(spend_txn.len(), 3);
5555 check_spends!(spend_txn[0], local_txn[0]);
5556 check_spends!(spend_txn[1], htlc_timeout);
5557 check_spends!(spend_txn[2], local_txn[0], htlc_timeout);
5561 fn test_key_derivation_params() {
5562 // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with
5563 // a key manager rotation to test that key_derivation_params returned in DynamicOutputP2WSH
5564 // let us re-derive the channel key set to then derive a delayed_payment_key.
5566 let chanmon_cfgs = create_chanmon_cfgs(3);
5568 // We manually create the node configuration to backup the seed.
5569 let seed = [42; 32];
5570 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5571 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);
5572 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, chain_monitor, keys_manager: &keys_manager, node_seed: seed };
5573 let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5574 node_cfgs.remove(0);
5575 node_cfgs.insert(0, node);
5577 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5578 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5580 // Create some initial channels
5581 // Create a dummy channel to advance index by one and thus test re-derivation correctness
5583 let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5584 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5585 assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5587 let (_, our_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5588 let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5589 let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5590 assert_eq!(local_txn_1[0].input.len(), 1);
5591 check_spends!(local_txn_1[0], chan_1.3);
5593 // We check funding pubkey are unique
5594 let (from_0_funding_key_0, from_0_funding_key_1) = (PublicKey::from_slice(&local_txn_0[0].input[0].witness[3][2..35]), PublicKey::from_slice(&local_txn_0[0].input[0].witness[3][36..69]));
5595 let (from_1_funding_key_0, from_1_funding_key_1) = (PublicKey::from_slice(&local_txn_1[0].input[0].witness[3][2..35]), PublicKey::from_slice(&local_txn_1[0].input[0].witness[3][36..69]));
5596 if from_0_funding_key_0 == from_1_funding_key_0
5597 || from_0_funding_key_0 == from_1_funding_key_1
5598 || from_0_funding_key_1 == from_1_funding_key_0
5599 || from_0_funding_key_1 == from_1_funding_key_1 {
5600 panic!("Funding pubkeys aren't unique");
5603 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5604 mine_transaction(&nodes[0], &local_txn_1[0]);
5605 check_closed_broadcast!(nodes[0], true);
5606 check_added_monitors!(nodes[0], 1);
5608 let htlc_timeout = {
5609 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5610 assert_eq!(node_txn[0].input.len(), 1);
5611 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5612 check_spends!(node_txn[0], local_txn_1[0]);
5616 mine_transaction(&nodes[0], &htlc_timeout);
5617 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5618 expect_payment_failed!(nodes[0], our_payment_hash, true);
5620 // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5621 let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5622 let spend_txn = check_spendable_outputs!(nodes[0], 1, new_keys_manager, 100000);
5623 assert_eq!(spend_txn.len(), 3);
5624 check_spends!(spend_txn[0], local_txn_1[0]);
5625 check_spends!(spend_txn[1], htlc_timeout);
5626 check_spends!(spend_txn[2], local_txn_1[0], htlc_timeout);
5630 fn test_static_output_closing_tx() {
5631 let chanmon_cfgs = create_chanmon_cfgs(2);
5632 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5633 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5634 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5636 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5638 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
5639 let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5641 mine_transaction(&nodes[0], &closing_tx);
5642 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5644 let spend_txn = check_spendable_outputs!(nodes[0], 2, node_cfgs[0].keys_manager, 100000);
5645 assert_eq!(spend_txn.len(), 1);
5646 check_spends!(spend_txn[0], closing_tx);
5648 mine_transaction(&nodes[1], &closing_tx);
5649 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5651 let spend_txn = check_spendable_outputs!(nodes[1], 2, node_cfgs[1].keys_manager, 100000);
5652 assert_eq!(spend_txn.len(), 1);
5653 check_spends!(spend_txn[0], closing_tx);
5656 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5657 let chanmon_cfgs = create_chanmon_cfgs(2);
5658 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5659 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5660 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5661 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5663 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5665 // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5666 // present in B's local commitment transaction, but none of A's commitment transactions.
5667 assert!(nodes[1].node.claim_funds(our_payment_preimage, &None, if use_dust { 50_000 } else { 3_000_000 }));
5668 check_added_monitors!(nodes[1], 1);
5670 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5671 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5672 let events = nodes[0].node.get_and_clear_pending_events();
5673 assert_eq!(events.len(), 1);
5675 Event::PaymentSent { payment_preimage } => {
5676 assert_eq!(payment_preimage, our_payment_preimage);
5678 _ => panic!("Unexpected event"),
5681 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5682 check_added_monitors!(nodes[0], 1);
5683 let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5684 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5685 check_added_monitors!(nodes[1], 1);
5687 let starting_block = nodes[1].best_block_info();
5688 let mut block = Block {
5689 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5692 for _ in starting_block.1 + 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + starting_block.1 + 2 {
5693 connect_block(&nodes[1], &block);
5694 block.header.prev_blockhash = block.block_hash();
5696 test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5697 check_closed_broadcast!(nodes[1], true);
5698 check_added_monitors!(nodes[1], 1);
5701 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5702 let chanmon_cfgs = create_chanmon_cfgs(2);
5703 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5704 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5705 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5706 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5707 let logger = test_utils::TestLogger::new();
5709 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
5710 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5711 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &Vec::new(), if use_dust { 50000 } else { 3000000 }, TEST_FINAL_CLTV, &logger).unwrap();
5712 nodes[0].node.send_payment(&route, payment_hash, &None).unwrap();
5713 check_added_monitors!(nodes[0], 1);
5715 let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5717 // As far as A is concerned, the HTLC is now present only in the latest remote commitment
5718 // transaction, however it is not in A's latest local commitment, so we can just broadcast that
5719 // to "time out" the HTLC.
5721 let starting_block = nodes[1].best_block_info();
5722 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5724 for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + starting_block.1 + 2 {
5725 connect_block(&nodes[0], &Block { header, txdata: Vec::new()});
5726 header.prev_blockhash = header.block_hash();
5728 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5729 check_closed_broadcast!(nodes[0], true);
5730 check_added_monitors!(nodes[0], 1);
5733 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
5734 let chanmon_cfgs = create_chanmon_cfgs(3);
5735 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5736 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5737 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5738 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5740 // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
5741 // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
5742 // Also optionally test that we *don't* fail the channel in case the commitment transaction was
5743 // actually revoked.
5744 let htlc_value = if use_dust { 50000 } else { 3000000 };
5745 let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
5746 assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash, &None));
5747 expect_pending_htlcs_forwardable!(nodes[1]);
5748 check_added_monitors!(nodes[1], 1);
5750 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5751 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
5752 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5753 check_added_monitors!(nodes[0], 1);
5754 let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5755 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5756 check_added_monitors!(nodes[1], 1);
5757 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
5758 check_added_monitors!(nodes[1], 1);
5759 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
5761 if check_revoke_no_close {
5762 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
5763 check_added_monitors!(nodes[0], 1);
5766 let starting_block = nodes[1].best_block_info();
5767 let mut block = Block {
5768 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5771 for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 2 {
5772 connect_block(&nodes[0], &block);
5773 block.header.prev_blockhash = block.block_hash();
5775 if !check_revoke_no_close {
5776 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5777 check_closed_broadcast!(nodes[0], true);
5778 check_added_monitors!(nodes[0], 1);
5780 expect_payment_failed!(nodes[0], our_payment_hash, true);
5784 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
5785 // There are only a few cases to test here:
5786 // * its not really normative behavior, but we test that below-dust HTLCs "included" in
5787 // broadcastable commitment transactions result in channel closure,
5788 // * its included in an unrevoked-but-previous remote commitment transaction,
5789 // * its included in the latest remote or local commitment transactions.
5790 // We test each of the three possible commitment transactions individually and use both dust and
5792 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
5793 // assume they are handled the same across all six cases, as both outbound and inbound failures are
5794 // tested for at least one of the cases in other tests.
5796 fn htlc_claim_single_commitment_only_a() {
5797 do_htlc_claim_local_commitment_only(true);
5798 do_htlc_claim_local_commitment_only(false);
5800 do_htlc_claim_current_remote_commitment_only(true);
5801 do_htlc_claim_current_remote_commitment_only(false);
5805 fn htlc_claim_single_commitment_only_b() {
5806 do_htlc_claim_previous_remote_commitment_only(true, false);
5807 do_htlc_claim_previous_remote_commitment_only(false, false);
5808 do_htlc_claim_previous_remote_commitment_only(true, true);
5809 do_htlc_claim_previous_remote_commitment_only(false, true);
5814 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
5815 let chanmon_cfgs = create_chanmon_cfgs(2);
5816 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5817 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5818 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5819 //Force duplicate channel ids
5820 for node in nodes.iter() {
5821 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
5824 // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
5825 let channel_value_satoshis=10000;
5826 let push_msat=10001;
5827 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
5828 let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5829 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
5831 //Create a second channel with a channel_id collision
5832 assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5836 fn bolt2_open_channel_sending_node_checks_part2() {
5837 let chanmon_cfgs = create_chanmon_cfgs(2);
5838 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5839 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5840 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5842 // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
5843 let channel_value_satoshis=2^24;
5844 let push_msat=10001;
5845 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5847 // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
5848 let channel_value_satoshis=10000;
5849 // Test when push_msat is equal to 1000 * funding_satoshis.
5850 let push_msat=1000*channel_value_satoshis+1;
5851 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5853 // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
5854 let channel_value_satoshis=10000;
5855 let push_msat=10001;
5856 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
5857 let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5858 assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
5860 // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
5861 // 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
5862 assert!(node0_to_1_send_open_channel.channel_flags<=1);
5864 // 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.
5865 assert!(BREAKDOWN_TIMEOUT>0);
5866 assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
5868 // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
5869 let chain_hash=genesis_block(Network::Testnet).header.block_hash();
5870 assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
5872 // 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.
5873 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
5874 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
5875 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
5876 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
5877 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
5880 // Test that if we fail to send an HTLC that is being freed from the holding cell, and the HTLC
5881 // originated from our node, its failure is surfaced to the user. We trigger this failure to
5882 // free the HTLC by increasing our fee while the HTLC is in the holding cell such that the HTLC
5883 // is no longer affordable once it's freed.
5885 fn test_fail_holding_cell_htlc_upon_free() {
5886 let chanmon_cfgs = create_chanmon_cfgs(2);
5887 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5888 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5889 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5890 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
5891 let logger = test_utils::TestLogger::new();
5893 // First nodes[0] generates an update_fee, setting the channel's
5894 // pending_update_fee.
5895 nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 20).unwrap();
5896 check_added_monitors!(nodes[0], 1);
5898 let events = nodes[0].node.get_and_clear_pending_msg_events();
5899 assert_eq!(events.len(), 1);
5900 let (update_msg, commitment_signed) = match events[0] {
5901 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
5902 (update_fee.as_ref(), commitment_signed)
5904 _ => panic!("Unexpected event"),
5907 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
5909 let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
5910 let channel_reserve = chan_stat.channel_reserve_msat;
5911 let feerate = get_feerate!(nodes[0], chan.2);
5913 // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
5914 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5915 let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1);
5916 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5917 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
5919 // Send a payment which passes reserve checks but gets stuck in the holding cell.
5920 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
5921 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
5922 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
5924 // Flush the pending fee update.
5925 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
5926 let (as_revoke_and_ack, _) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5927 check_added_monitors!(nodes[1], 1);
5928 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
5929 check_added_monitors!(nodes[0], 1);
5931 // Upon receipt of the RAA, there will be an attempt to resend the holding cell
5932 // HTLC, but now that the fee has been raised the payment will now fail, causing
5933 // us to surface its failure to the user.
5934 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
5935 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
5936 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), "Freeing holding cell with 1 HTLC updates".to_string(), 1);
5937 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 ({})", log_bytes!(our_payment_hash.0), chan_stat.channel_reserve_msat);
5938 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
5940 // Check that the payment failed to be sent out.
5941 let events = nodes[0].node.get_and_clear_pending_events();
5942 assert_eq!(events.len(), 1);
5944 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
5945 assert_eq!(our_payment_hash.clone(), *payment_hash);
5946 assert_eq!(*rejected_by_dest, false);
5947 assert_eq!(*error_code, None);
5948 assert_eq!(*error_data, None);
5950 _ => panic!("Unexpected event"),
5954 // Test that if multiple HTLCs are released from the holding cell and one is
5955 // valid but the other is no longer valid upon release, the valid HTLC can be
5956 // successfully completed while the other one fails as expected.
5958 fn test_free_and_fail_holding_cell_htlcs() {
5959 let chanmon_cfgs = create_chanmon_cfgs(2);
5960 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5961 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5962 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5963 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
5964 let logger = test_utils::TestLogger::new();
5966 // First nodes[0] generates an update_fee, setting the channel's
5967 // pending_update_fee.
5968 nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 200).unwrap();
5969 check_added_monitors!(nodes[0], 1);
5971 let events = nodes[0].node.get_and_clear_pending_msg_events();
5972 assert_eq!(events.len(), 1);
5973 let (update_msg, commitment_signed) = match events[0] {
5974 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
5975 (update_fee.as_ref(), commitment_signed)
5977 _ => panic!("Unexpected event"),
5980 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
5982 let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
5983 let channel_reserve = chan_stat.channel_reserve_msat;
5984 let feerate = get_feerate!(nodes[0], chan.2);
5986 // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
5987 let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
5989 let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
5990 let amt_2 = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 2 + 1) - amt_1;
5991 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5992 let route_1 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &[], amt_1, TEST_FINAL_CLTV, &logger).unwrap();
5993 let route_2 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &[], amt_2, TEST_FINAL_CLTV, &logger).unwrap();
5995 // Send 2 payments which pass reserve checks but get stuck in the holding cell.
5996 nodes[0].node.send_payment(&route_1, payment_hash_1, &None).unwrap();
5997 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
5998 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1);
5999 nodes[0].node.send_payment(&route_2, payment_hash_2, &None).unwrap();
6000 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6001 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1 + amt_2);
6003 // Flush the pending fee update.
6004 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6005 let (revoke_and_ack, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6006 check_added_monitors!(nodes[1], 1);
6007 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_and_ack);
6008 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6009 check_added_monitors!(nodes[0], 2);
6011 // Upon receipt of the RAA, there will be an attempt to resend the holding cell HTLCs,
6012 // but now that the fee has been raised the second payment will now fail, causing us
6013 // to surface its failure to the user. The first payment should succeed.
6014 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6015 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6016 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), "Freeing holding cell with 2 HTLC updates".to_string(), 1);
6017 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 ({})", log_bytes!(payment_hash_2.0), chan_stat.channel_reserve_msat);
6018 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6020 // Check that the second payment failed to be sent out.
6021 let events = nodes[0].node.get_and_clear_pending_events();
6022 assert_eq!(events.len(), 1);
6024 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6025 assert_eq!(payment_hash_2.clone(), *payment_hash);
6026 assert_eq!(*rejected_by_dest, false);
6027 assert_eq!(*error_code, None);
6028 assert_eq!(*error_data, None);
6030 _ => panic!("Unexpected event"),
6033 // Complete the first payment and the RAA from the fee update.
6034 let (payment_event, send_raa_event) = {
6035 let mut msgs = nodes[0].node.get_and_clear_pending_msg_events();
6036 assert_eq!(msgs.len(), 2);
6037 (SendEvent::from_event(msgs.remove(0)), msgs.remove(0))
6039 let raa = match send_raa_event {
6040 MessageSendEvent::SendRevokeAndACK { msg, .. } => msg,
6041 _ => panic!("Unexpected event"),
6043 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6044 check_added_monitors!(nodes[1], 1);
6045 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6046 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6047 let events = nodes[1].node.get_and_clear_pending_events();
6048 assert_eq!(events.len(), 1);
6050 Event::PendingHTLCsForwardable { .. } => {},
6051 _ => panic!("Unexpected event"),
6053 nodes[1].node.process_pending_htlc_forwards();
6054 let events = nodes[1].node.get_and_clear_pending_events();
6055 assert_eq!(events.len(), 1);
6057 Event::PaymentReceived { .. } => {},
6058 _ => panic!("Unexpected event"),
6060 nodes[1].node.claim_funds(payment_preimage_1, &None, amt_1);
6061 check_added_monitors!(nodes[1], 1);
6062 let update_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6063 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msgs.update_fulfill_htlcs[0]);
6064 commitment_signed_dance!(nodes[0], nodes[1], update_msgs.commitment_signed, false, true);
6065 let events = nodes[0].node.get_and_clear_pending_events();
6066 assert_eq!(events.len(), 1);
6068 Event::PaymentSent { ref payment_preimage } => {
6069 assert_eq!(*payment_preimage, payment_preimage_1);
6071 _ => panic!("Unexpected event"),
6075 // Test that if we fail to forward an HTLC that is being freed from the holding cell that the
6076 // HTLC is failed backwards. We trigger this failure to forward the freed HTLC by increasing
6077 // our fee while the HTLC is in the holding cell such that the HTLC is no longer affordable
6080 fn test_fail_holding_cell_htlc_upon_free_multihop() {
6081 let chanmon_cfgs = create_chanmon_cfgs(3);
6082 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6083 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6084 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6085 let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6086 let chan_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6087 let logger = test_utils::TestLogger::new();
6089 // First nodes[1] generates an update_fee, setting the channel's
6090 // pending_update_fee.
6091 nodes[1].node.update_fee(chan_1_2.2, get_feerate!(nodes[1], chan_1_2.2) + 20).unwrap();
6092 check_added_monitors!(nodes[1], 1);
6094 let events = nodes[1].node.get_and_clear_pending_msg_events();
6095 assert_eq!(events.len(), 1);
6096 let (update_msg, commitment_signed) = match events[0] {
6097 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6098 (update_fee.as_ref(), commitment_signed)
6100 _ => panic!("Unexpected event"),
6103 nodes[2].node.handle_update_fee(&nodes[1].node.get_our_node_id(), update_msg.unwrap());
6105 let mut chan_stat = get_channel_value_stat!(nodes[0], chan_0_1.2);
6106 let channel_reserve = chan_stat.channel_reserve_msat;
6107 let feerate = get_feerate!(nodes[0], chan_0_1.2);
6109 // Send a payment which passes reserve checks but gets stuck in the holding cell.
6111 let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
6112 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6113 let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1) - total_routing_fee_msat;
6114 let payment_event = {
6115 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6116 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), None, None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6117 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6118 check_added_monitors!(nodes[0], 1);
6120 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6121 assert_eq!(events.len(), 1);
6123 SendEvent::from_event(events.remove(0))
6125 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6126 check_added_monitors!(nodes[1], 0);
6127 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6128 expect_pending_htlcs_forwardable!(nodes[1]);
6130 chan_stat = get_channel_value_stat!(nodes[1], chan_1_2.2);
6131 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6133 // Flush the pending fee update.
6134 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
6135 let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6136 check_added_monitors!(nodes[2], 1);
6137 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &raa);
6138 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &commitment_signed);
6139 check_added_monitors!(nodes[1], 2);
6141 // A final RAA message is generated to finalize the fee update.
6142 let events = nodes[1].node.get_and_clear_pending_msg_events();
6143 assert_eq!(events.len(), 1);
6145 let raa_msg = match &events[0] {
6146 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => {
6149 _ => panic!("Unexpected event"),
6152 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_msg);
6153 check_added_monitors!(nodes[2], 1);
6154 assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
6156 // nodes[1]'s ChannelManager will now signal that we have HTLC forwards to process.
6157 let process_htlc_forwards_event = nodes[1].node.get_and_clear_pending_events();
6158 assert_eq!(process_htlc_forwards_event.len(), 1);
6159 match &process_htlc_forwards_event[0] {
6160 &Event::PendingHTLCsForwardable { .. } => {},
6161 _ => panic!("Unexpected event"),
6164 // In response, we call ChannelManager's process_pending_htlc_forwards
6165 nodes[1].node.process_pending_htlc_forwards();
6166 check_added_monitors!(nodes[1], 1);
6168 // This causes the HTLC to be failed backwards.
6169 let fail_event = nodes[1].node.get_and_clear_pending_msg_events();
6170 assert_eq!(fail_event.len(), 1);
6171 let (fail_msg, commitment_signed) = match &fail_event[0] {
6172 &MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6173 assert_eq!(updates.update_add_htlcs.len(), 0);
6174 assert_eq!(updates.update_fulfill_htlcs.len(), 0);
6175 assert_eq!(updates.update_fail_malformed_htlcs.len(), 0);
6176 assert_eq!(updates.update_fail_htlcs.len(), 1);
6177 (updates.update_fail_htlcs[0].clone(), updates.commitment_signed.clone())
6179 _ => panic!("Unexpected event"),
6182 // Pass the failure messages back to nodes[0].
6183 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
6184 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6186 // Complete the HTLC failure+removal process.
6187 let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6188 check_added_monitors!(nodes[0], 1);
6189 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6190 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
6191 check_added_monitors!(nodes[1], 2);
6192 let final_raa_event = nodes[1].node.get_and_clear_pending_msg_events();
6193 assert_eq!(final_raa_event.len(), 1);
6194 let raa = match &final_raa_event[0] {
6195 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => msg.clone(),
6196 _ => panic!("Unexpected event"),
6198 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
6199 let fail_msg_event = nodes[0].node.get_and_clear_pending_msg_events();
6200 assert_eq!(fail_msg_event.len(), 1);
6201 match &fail_msg_event[0] {
6202 &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
6203 _ => panic!("Unexpected event"),
6205 let failure_event = nodes[0].node.get_and_clear_pending_events();
6206 assert_eq!(failure_event.len(), 1);
6207 match &failure_event[0] {
6208 &Event::PaymentFailed { rejected_by_dest, .. } => {
6209 assert!(!rejected_by_dest);
6211 _ => panic!("Unexpected event"),
6213 check_added_monitors!(nodes[0], 1);
6216 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
6217 // 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.
6218 //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.
6221 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
6222 //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
6223 let chanmon_cfgs = create_chanmon_cfgs(2);
6224 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6225 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6226 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6227 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6229 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6230 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6231 let logger = test_utils::TestLogger::new();
6232 let mut route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6233 route.paths[0][0].fee_msat = 100;
6235 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6236 assert!(regex::Regex::new(r"Cannot send less than their minimum HTLC value \(\d+\)").unwrap().is_match(err)));
6237 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6238 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
6242 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
6243 //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6244 let chanmon_cfgs = create_chanmon_cfgs(2);
6245 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6246 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6247 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6248 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6249 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6251 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6252 let logger = test_utils::TestLogger::new();
6253 let mut route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6254 route.paths[0][0].fee_msat = 0;
6255 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6256 assert_eq!(err, "Cannot send 0-msat HTLC"));
6258 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6259 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
6263 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
6264 //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6265 let chanmon_cfgs = create_chanmon_cfgs(2);
6266 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6267 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6268 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6269 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6271 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6272 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6273 let logger = test_utils::TestLogger::new();
6274 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6275 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6276 check_added_monitors!(nodes[0], 1);
6277 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6278 updates.update_add_htlcs[0].amount_msat = 0;
6280 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6281 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
6282 check_closed_broadcast!(nodes[1], true).unwrap();
6283 check_added_monitors!(nodes[1], 1);
6287 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6288 //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6289 //It is enforced when constructing a route.
6290 let chanmon_cfgs = create_chanmon_cfgs(2);
6291 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6292 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6293 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6294 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6295 let logger = test_utils::TestLogger::new();
6297 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6299 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6300 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &[], 100000000, 500000001, &logger).unwrap();
6301 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::RouteError { ref err },
6302 assert_eq!(err, &"Channel CLTV overflowed?"));
6306 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6307 //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.
6308 //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6309 //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
6310 let chanmon_cfgs = create_chanmon_cfgs(2);
6311 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6312 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6313 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6314 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6315 let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().counterparty_max_accepted_htlcs as u64;
6317 let logger = test_utils::TestLogger::new();
6318 for i in 0..max_accepted_htlcs {
6319 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6320 let payment_event = {
6321 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6322 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6323 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6324 check_added_monitors!(nodes[0], 1);
6326 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6327 assert_eq!(events.len(), 1);
6328 if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6329 assert_eq!(htlcs[0].htlc_id, i);
6333 SendEvent::from_event(events.remove(0))
6335 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6336 check_added_monitors!(nodes[1], 0);
6337 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6339 expect_pending_htlcs_forwardable!(nodes[1]);
6340 expect_payment_received!(nodes[1], our_payment_hash, 100000);
6342 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6343 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6344 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6345 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6346 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
6348 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6349 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
6353 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6354 //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.
6355 let chanmon_cfgs = create_chanmon_cfgs(2);
6356 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6357 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6358 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6359 let channel_value = 100000;
6360 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::known(), InitFeatures::known());
6361 let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).counterparty_max_htlc_value_in_flight_msat;
6363 send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight, max_in_flight);
6365 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6366 // Manually create a route over our max in flight (which our router normally automatically
6368 let route = Route { paths: vec![vec![RouteHop {
6369 pubkey: nodes[1].node.get_our_node_id(), node_features: NodeFeatures::known(), channel_features: ChannelFeatures::known(),
6370 short_channel_id: nodes[1].node.list_usable_channels()[0].short_channel_id.unwrap(),
6371 fee_msat: max_in_flight + 1, cltv_expiry_delta: TEST_FINAL_CLTV
6373 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6374 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)));
6376 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6377 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);
6379 send_payment(&nodes[0], &[&nodes[1]], max_in_flight, max_in_flight);
6382 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6384 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6385 //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
6386 let chanmon_cfgs = create_chanmon_cfgs(2);
6387 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6388 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6389 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6390 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6391 let htlc_minimum_msat: u64;
6393 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
6394 let channel = chan_lock.by_id.get(&chan.2).unwrap();
6395 htlc_minimum_msat = channel.get_holder_htlc_minimum_msat();
6398 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6399 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6400 let logger = test_utils::TestLogger::new();
6401 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &[], htlc_minimum_msat, TEST_FINAL_CLTV, &logger).unwrap();
6402 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6403 check_added_monitors!(nodes[0], 1);
6404 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6405 updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6406 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6407 assert!(nodes[1].node.list_channels().is_empty());
6408 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6409 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()));
6410 check_added_monitors!(nodes[1], 1);
6414 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6415 //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
6416 let chanmon_cfgs = create_chanmon_cfgs(2);
6417 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6418 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6419 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6420 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6421 let logger = test_utils::TestLogger::new();
6423 let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6424 let channel_reserve = chan_stat.channel_reserve_msat;
6425 let feerate = get_feerate!(nodes[0], chan.2);
6426 // The 2* and +1 are for the fee spike reserve.
6427 let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1);
6429 let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6430 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6431 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6432 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6433 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6434 check_added_monitors!(nodes[0], 1);
6435 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6437 // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6438 // at this time channel-initiatee receivers are not required to enforce that senders
6439 // respect the fee_spike_reserve.
6440 updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
6441 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6443 assert!(nodes[1].node.list_channels().is_empty());
6444 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6445 assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
6446 check_added_monitors!(nodes[1], 1);
6450 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
6451 //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
6452 //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
6453 let chanmon_cfgs = create_chanmon_cfgs(2);
6454 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6455 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6456 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6457 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6458 let logger = test_utils::TestLogger::new();
6460 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6461 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
6463 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6464 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &[], 3999999, TEST_FINAL_CLTV, &logger).unwrap();
6466 let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
6467 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
6468 let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &None, cur_height).unwrap();
6469 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
6471 let mut msg = msgs::UpdateAddHTLC {
6475 payment_hash: our_payment_hash,
6476 cltv_expiry: htlc_cltv,
6477 onion_routing_packet: onion_packet.clone(),
6480 for i in 0..super::channel::OUR_MAX_HTLCS {
6481 msg.htlc_id = i as u64;
6482 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6484 msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
6485 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6487 assert!(nodes[1].node.list_channels().is_empty());
6488 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6489 assert!(regex::Regex::new(r"Remote tried to push more than our max accepted HTLCs \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6490 check_added_monitors!(nodes[1], 1);
6494 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
6495 //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
6496 let chanmon_cfgs = create_chanmon_cfgs(2);
6497 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6498 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6499 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6500 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6501 let logger = test_utils::TestLogger::new();
6503 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6504 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6505 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6506 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6507 check_added_monitors!(nodes[0], 1);
6508 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6509 updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).counterparty_max_htlc_value_in_flight_msat + 1;
6510 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6512 assert!(nodes[1].node.list_channels().is_empty());
6513 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6514 assert!(regex::Regex::new("Remote HTLC add would put them over our max HTLC value").unwrap().is_match(err_msg.data.as_str()));
6515 check_added_monitors!(nodes[1], 1);
6519 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6520 //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6521 let chanmon_cfgs = create_chanmon_cfgs(2);
6522 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6523 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6524 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6525 let logger = test_utils::TestLogger::new();
6527 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6528 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6529 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6530 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6531 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6532 check_added_monitors!(nodes[0], 1);
6533 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6534 updates.update_add_htlcs[0].cltv_expiry = 500000000;
6535 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6537 assert!(nodes[1].node.list_channels().is_empty());
6538 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6539 assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6540 check_added_monitors!(nodes[1], 1);
6544 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6545 //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6546 // We test this by first testing that that repeated HTLCs pass commitment signature checks
6547 // after disconnect and that non-sequential htlc_ids result in a channel failure.
6548 let chanmon_cfgs = create_chanmon_cfgs(2);
6549 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6550 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6551 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6552 let logger = test_utils::TestLogger::new();
6554 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6555 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6556 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6557 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6558 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6559 check_added_monitors!(nodes[0], 1);
6560 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6561 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6563 //Disconnect and Reconnect
6564 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6565 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6566 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6567 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6568 assert_eq!(reestablish_1.len(), 1);
6569 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6570 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6571 assert_eq!(reestablish_2.len(), 1);
6572 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6573 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6574 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6575 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6578 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6579 assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6580 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6581 check_added_monitors!(nodes[1], 1);
6582 let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6584 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6586 assert!(nodes[1].node.list_channels().is_empty());
6587 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6588 assert!(regex::Regex::new(r"Remote skipped HTLC ID \(skipped ID: \d+\)").unwrap().is_match(err_msg.data.as_str()));
6589 check_added_monitors!(nodes[1], 1);
6593 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6594 //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.
6596 let chanmon_cfgs = create_chanmon_cfgs(2);
6597 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6598 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6599 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6600 let logger = test_utils::TestLogger::new();
6601 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6602 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6603 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6604 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6605 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6607 check_added_monitors!(nodes[0], 1);
6608 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6609 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6611 let update_msg = msgs::UpdateFulfillHTLC{
6614 payment_preimage: our_payment_preimage,
6617 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6619 assert!(nodes[0].node.list_channels().is_empty());
6620 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6621 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()));
6622 check_added_monitors!(nodes[0], 1);
6626 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6627 //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.
6629 let chanmon_cfgs = create_chanmon_cfgs(2);
6630 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6631 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6632 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6633 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6634 let logger = test_utils::TestLogger::new();
6636 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6637 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6638 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6639 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6640 check_added_monitors!(nodes[0], 1);
6641 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6642 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6644 let update_msg = msgs::UpdateFailHTLC{
6647 reason: msgs::OnionErrorPacket { data: Vec::new()},
6650 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6652 assert!(nodes[0].node.list_channels().is_empty());
6653 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6654 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()));
6655 check_added_monitors!(nodes[0], 1);
6659 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6660 //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.
6662 let chanmon_cfgs = create_chanmon_cfgs(2);
6663 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6664 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6665 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6666 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6667 let logger = test_utils::TestLogger::new();
6669 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6670 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6671 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6672 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6673 check_added_monitors!(nodes[0], 1);
6674 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6675 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6676 let update_msg = msgs::UpdateFailMalformedHTLC{
6679 sha256_of_onion: [1; 32],
6680 failure_code: 0x8000,
6683 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6685 assert!(nodes[0].node.list_channels().is_empty());
6686 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6687 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()));
6688 check_added_monitors!(nodes[0], 1);
6692 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
6693 //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
6695 let chanmon_cfgs = create_chanmon_cfgs(2);
6696 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6697 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6698 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6699 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6701 let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6703 nodes[1].node.claim_funds(our_payment_preimage, &None, 100_000);
6704 check_added_monitors!(nodes[1], 1);
6706 let events = nodes[1].node.get_and_clear_pending_msg_events();
6707 assert_eq!(events.len(), 1);
6708 let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6710 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, .. } } => {
6711 assert!(update_add_htlcs.is_empty());
6712 assert_eq!(update_fulfill_htlcs.len(), 1);
6713 assert!(update_fail_htlcs.is_empty());
6714 assert!(update_fail_malformed_htlcs.is_empty());
6715 assert!(update_fee.is_none());
6716 update_fulfill_htlcs[0].clone()
6718 _ => panic!("Unexpected event"),
6722 update_fulfill_msg.htlc_id = 1;
6724 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6726 assert!(nodes[0].node.list_channels().is_empty());
6727 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6728 assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
6729 check_added_monitors!(nodes[0], 1);
6733 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
6734 //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.
6736 let chanmon_cfgs = create_chanmon_cfgs(2);
6737 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6738 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6739 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6740 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6742 let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6744 nodes[1].node.claim_funds(our_payment_preimage, &None, 100_000);
6745 check_added_monitors!(nodes[1], 1);
6747 let events = nodes[1].node.get_and_clear_pending_msg_events();
6748 assert_eq!(events.len(), 1);
6749 let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6751 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, .. } } => {
6752 assert!(update_add_htlcs.is_empty());
6753 assert_eq!(update_fulfill_htlcs.len(), 1);
6754 assert!(update_fail_htlcs.is_empty());
6755 assert!(update_fail_malformed_htlcs.is_empty());
6756 assert!(update_fee.is_none());
6757 update_fulfill_htlcs[0].clone()
6759 _ => panic!("Unexpected event"),
6763 update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
6765 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6767 assert!(nodes[0].node.list_channels().is_empty());
6768 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6769 assert!(regex::Regex::new(r"Remote tried to fulfill HTLC \(\d+\) with an incorrect preimage").unwrap().is_match(err_msg.data.as_str()));
6770 check_added_monitors!(nodes[0], 1);
6774 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
6775 //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.
6777 let chanmon_cfgs = create_chanmon_cfgs(2);
6778 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6779 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6780 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6781 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6782 let logger = test_utils::TestLogger::new();
6784 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6785 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6786 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6787 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6788 check_added_monitors!(nodes[0], 1);
6790 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6791 updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6793 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6794 check_added_monitors!(nodes[1], 0);
6795 commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
6797 let events = nodes[1].node.get_and_clear_pending_msg_events();
6799 let mut update_msg: msgs::UpdateFailMalformedHTLC = {
6801 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, .. } } => {
6802 assert!(update_add_htlcs.is_empty());
6803 assert!(update_fulfill_htlcs.is_empty());
6804 assert!(update_fail_htlcs.is_empty());
6805 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6806 assert!(update_fee.is_none());
6807 update_fail_malformed_htlcs[0].clone()
6809 _ => panic!("Unexpected event"),
6812 update_msg.failure_code &= !0x8000;
6813 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6815 assert!(nodes[0].node.list_channels().is_empty());
6816 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6817 assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
6818 check_added_monitors!(nodes[0], 1);
6822 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
6823 //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
6824 // * 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.
6826 let chanmon_cfgs = create_chanmon_cfgs(3);
6827 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6828 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6829 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6830 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6831 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6832 let logger = test_utils::TestLogger::new();
6834 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6837 let mut payment_event = {
6838 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6839 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), None, None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
6840 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6841 check_added_monitors!(nodes[0], 1);
6842 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6843 assert_eq!(events.len(), 1);
6844 SendEvent::from_event(events.remove(0))
6846 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6847 check_added_monitors!(nodes[1], 0);
6848 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6849 expect_pending_htlcs_forwardable!(nodes[1]);
6850 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
6851 assert_eq!(events_2.len(), 1);
6852 check_added_monitors!(nodes[1], 1);
6853 payment_event = SendEvent::from_event(events_2.remove(0));
6854 assert_eq!(payment_event.msgs.len(), 1);
6857 payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6858 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
6859 check_added_monitors!(nodes[2], 0);
6860 commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
6862 let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
6863 assert_eq!(events_3.len(), 1);
6864 let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
6866 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 } } => {
6867 assert!(update_add_htlcs.is_empty());
6868 assert!(update_fulfill_htlcs.is_empty());
6869 assert!(update_fail_htlcs.is_empty());
6870 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6871 assert!(update_fee.is_none());
6872 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
6874 _ => panic!("Unexpected event"),
6878 nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
6880 check_added_monitors!(nodes[1], 0);
6881 commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
6882 expect_pending_htlcs_forwardable!(nodes[1]);
6883 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
6884 assert_eq!(events_4.len(), 1);
6886 //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
6888 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, .. } } => {
6889 assert!(update_add_htlcs.is_empty());
6890 assert!(update_fulfill_htlcs.is_empty());
6891 assert_eq!(update_fail_htlcs.len(), 1);
6892 assert!(update_fail_malformed_htlcs.is_empty());
6893 assert!(update_fee.is_none());
6895 _ => panic!("Unexpected event"),
6898 check_added_monitors!(nodes[1], 1);
6901 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
6902 // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
6903 // 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
6904 // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
6906 let mut chanmon_cfgs = create_chanmon_cfgs(2);
6907 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
6908 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6909 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6910 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6911 let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6913 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
6915 // We route 2 dust-HTLCs between A and B
6916 let (_, payment_hash_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6917 let (_, payment_hash_2) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6918 route_payment(&nodes[0], &[&nodes[1]], 1000000);
6920 // Cache one local commitment tx as previous
6921 let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6923 // Fail one HTLC to prune it in the will-be-latest-local commitment tx
6924 assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2, &None));
6925 check_added_monitors!(nodes[1], 0);
6926 expect_pending_htlcs_forwardable!(nodes[1]);
6927 check_added_monitors!(nodes[1], 1);
6929 let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6930 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
6931 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
6932 check_added_monitors!(nodes[0], 1);
6934 // Cache one local commitment tx as lastest
6935 let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6937 let events = nodes[0].node.get_and_clear_pending_msg_events();
6939 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
6940 assert_eq!(node_id, nodes[1].node.get_our_node_id());
6942 _ => panic!("Unexpected event"),
6945 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
6946 assert_eq!(node_id, nodes[1].node.get_our_node_id());
6948 _ => panic!("Unexpected event"),
6951 assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
6952 // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
6953 if announce_latest {
6954 mine_transaction(&nodes[0], &as_last_commitment_tx[0]);
6956 mine_transaction(&nodes[0], &as_prev_commitment_tx[0]);
6959 check_closed_broadcast!(nodes[0], true);
6960 check_added_monitors!(nodes[0], 1);
6962 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6963 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
6964 let events = nodes[0].node.get_and_clear_pending_events();
6965 // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
6966 assert_eq!(events.len(), 2);
6967 let mut first_failed = false;
6968 for event in events {
6970 Event::PaymentFailed { payment_hash, .. } => {
6971 if payment_hash == payment_hash_1 {
6972 assert!(!first_failed);
6973 first_failed = true;
6975 assert_eq!(payment_hash, payment_hash_2);
6978 _ => panic!("Unexpected event"),
6984 fn test_failure_delay_dust_htlc_local_commitment() {
6985 do_test_failure_delay_dust_htlc_local_commitment(true);
6986 do_test_failure_delay_dust_htlc_local_commitment(false);
6989 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
6990 // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
6991 // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
6992 // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
6993 // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
6994 // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
6995 // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
6997 let chanmon_cfgs = create_chanmon_cfgs(3);
6998 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6999 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7000 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7001 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7003 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7005 let (_payment_preimage_1, dust_hash) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7006 let (_payment_preimage_2, non_dust_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7008 let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7009 let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
7011 // We revoked bs_commitment_tx
7013 let (payment_preimage_3, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7014 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 1_000_000);
7017 let mut timeout_tx = Vec::new();
7019 // We fail dust-HTLC 1 by broadcast of local commitment tx
7020 mine_transaction(&nodes[0], &as_commitment_tx[0]);
7021 check_closed_broadcast!(nodes[0], true);
7022 check_added_monitors!(nodes[0], 1);
7023 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7024 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
7025 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7026 expect_payment_failed!(nodes[0], dust_hash, true);
7027 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7028 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
7029 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7030 mine_transaction(&nodes[0], &timeout_tx[0]);
7031 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7032 expect_payment_failed!(nodes[0], non_dust_hash, true);
7034 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
7035 mine_transaction(&nodes[0], &bs_commitment_tx[0]);
7036 check_closed_broadcast!(nodes[0], true);
7037 check_added_monitors!(nodes[0], 1);
7038 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7039 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
7040 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7042 expect_payment_failed!(nodes[0], dust_hash, true);
7043 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7044 // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
7045 mine_transaction(&nodes[0], &timeout_tx[0]);
7046 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7047 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7048 expect_payment_failed!(nodes[0], non_dust_hash, true);
7050 // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
7052 let events = nodes[0].node.get_and_clear_pending_events();
7053 assert_eq!(events.len(), 2);
7056 Event::PaymentFailed { payment_hash, .. } => {
7057 if payment_hash == dust_hash { first = true; }
7058 else { first = false; }
7060 _ => panic!("Unexpected event"),
7063 Event::PaymentFailed { payment_hash, .. } => {
7064 if first { assert_eq!(payment_hash, non_dust_hash); }
7065 else { assert_eq!(payment_hash, dust_hash); }
7067 _ => panic!("Unexpected event"),
7074 fn test_sweep_outbound_htlc_failure_update() {
7075 do_test_sweep_outbound_htlc_failure_update(false, true);
7076 do_test_sweep_outbound_htlc_failure_update(false, false);
7077 do_test_sweep_outbound_htlc_failure_update(true, false);
7081 fn test_upfront_shutdown_script() {
7082 // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
7083 // enforce it at shutdown message
7085 let mut config = UserConfig::default();
7086 config.channel_options.announced_channel = true;
7087 config.peer_channel_config_limits.force_announced_channel_preference = false;
7088 config.channel_options.commit_upfront_shutdown_pubkey = false;
7089 let user_cfgs = [None, Some(config), None];
7090 let chanmon_cfgs = create_chanmon_cfgs(3);
7091 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7092 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7093 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7095 // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
7096 let flags = InitFeatures::known();
7097 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7098 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7099 let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7100 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7101 // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that we disconnect peer
7102 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7103 assert!(regex::Regex::new(r"Got shutdown request with a scriptpubkey \([A-Fa-f0-9]+\) which did not match their previous scriptpubkey.").unwrap().is_match(check_closed_broadcast!(nodes[2], true).unwrap().data.as_str()));
7104 check_added_monitors!(nodes[2], 1);
7106 // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
7107 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7108 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7109 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7110 // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
7111 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7112 let events = nodes[2].node.get_and_clear_pending_msg_events();
7113 assert_eq!(events.len(), 1);
7115 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7116 _ => panic!("Unexpected event"),
7119 // We test that if case of peer non-signaling we don't enforce committed script at channel opening
7120 let flags_no = InitFeatures::known().clear_upfront_shutdown_script();
7121 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
7122 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7123 let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
7124 node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7125 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
7126 let events = nodes[1].node.get_and_clear_pending_msg_events();
7127 assert_eq!(events.len(), 1);
7129 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7130 _ => panic!("Unexpected event"),
7133 // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7134 // channel smoothly, opt-out is from channel initiator here
7135 let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
7136 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7137 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7138 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7139 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7140 let events = nodes[0].node.get_and_clear_pending_msg_events();
7141 assert_eq!(events.len(), 1);
7143 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7144 _ => panic!("Unexpected event"),
7147 //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7148 //// channel smoothly
7149 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
7150 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7151 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7152 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7153 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7154 let events = nodes[0].node.get_and_clear_pending_msg_events();
7155 assert_eq!(events.len(), 2);
7157 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7158 _ => panic!("Unexpected event"),
7161 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7162 _ => panic!("Unexpected event"),
7167 fn test_upfront_shutdown_script_unsupport_segwit() {
7168 // We test that channel is closed early
7169 // if a segwit program is passed as upfront shutdown script,
7170 // but the peer does not support segwit.
7171 let chanmon_cfgs = create_chanmon_cfgs(2);
7172 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7173 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7174 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7176 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
7178 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7179 open_channel.shutdown_scriptpubkey = Present(Builder::new().push_int(16)
7180 .push_slice(&[0, 0])
7183 let features = InitFeatures::known().clear_shutdown_anysegwit();
7184 nodes[0].node.handle_open_channel(&nodes[0].node.get_our_node_id(), features, &open_channel);
7186 let events = nodes[0].node.get_and_clear_pending_msg_events();
7187 assert_eq!(events.len(), 1);
7189 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7190 assert_eq!(node_id, nodes[0].node.get_our_node_id());
7191 assert!(regex::Regex::new(r"Peer is signaling upfront_shutdown but has provided a non-accepted scriptpubkey format. script: (\([A-Fa-f0-9]+\))").unwrap().is_match(&*msg.data));
7193 _ => panic!("Unexpected event"),
7198 fn test_shutdown_script_any_segwit_allowed() {
7199 let mut config = UserConfig::default();
7200 config.channel_options.announced_channel = true;
7201 config.peer_channel_config_limits.force_announced_channel_preference = false;
7202 config.channel_options.commit_upfront_shutdown_pubkey = false;
7203 let user_cfgs = [None, Some(config), None];
7204 let chanmon_cfgs = create_chanmon_cfgs(3);
7205 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7206 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7207 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7209 //// We test if the remote peer accepts opt_shutdown_anysegwit, a witness program can be used on shutdown
7210 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7211 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7212 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7213 node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7214 .push_slice(&[0, 0])
7216 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7217 let events = nodes[0].node.get_and_clear_pending_msg_events();
7218 assert_eq!(events.len(), 2);
7220 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7221 _ => panic!("Unexpected event"),
7224 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7225 _ => panic!("Unexpected event"),
7230 fn test_shutdown_script_any_segwit_not_allowed() {
7231 let mut config = UserConfig::default();
7232 config.channel_options.announced_channel = true;
7233 config.peer_channel_config_limits.force_announced_channel_preference = false;
7234 config.channel_options.commit_upfront_shutdown_pubkey = false;
7235 let user_cfgs = [None, Some(config), None];
7236 let chanmon_cfgs = create_chanmon_cfgs(3);
7237 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7238 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7239 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7241 //// We test that if the remote peer does not accept opt_shutdown_anysegwit, the witness program cannot be used on shutdown
7242 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7243 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7244 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7245 // Make an any segwit version script
7246 node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7247 .push_slice(&[0, 0])
7249 let flags_no = InitFeatures::known().clear_shutdown_anysegwit();
7250 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &flags_no, &node_0_shutdown);
7251 let events = nodes[0].node.get_and_clear_pending_msg_events();
7252 assert_eq!(events.len(), 2);
7254 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7255 assert_eq!(node_id, nodes[1].node.get_our_node_id());
7256 assert_eq!(msg.data, "Got a nonstandard scriptpubkey (60020000) from remote peer".to_owned())
7258 _ => panic!("Unexpected event"),
7260 check_added_monitors!(nodes[0], 1);
7264 fn test_shutdown_script_segwit_but_not_anysegwit() {
7265 let mut config = UserConfig::default();
7266 config.channel_options.announced_channel = true;
7267 config.peer_channel_config_limits.force_announced_channel_preference = false;
7268 config.channel_options.commit_upfront_shutdown_pubkey = false;
7269 let user_cfgs = [None, Some(config), None];
7270 let chanmon_cfgs = create_chanmon_cfgs(3);
7271 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7272 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7273 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7275 //// We test that if shutdown any segwit is supported and we send a witness script with 0 version, this is not accepted
7276 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7277 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7278 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7279 // Make a segwit script that is not a valid as any segwit
7280 node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
7281 .push_slice(&[0, 0])
7283 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7284 let events = nodes[0].node.get_and_clear_pending_msg_events();
7285 assert_eq!(events.len(), 2);
7287 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7288 assert_eq!(node_id, nodes[1].node.get_our_node_id());
7289 assert_eq!(msg.data, "Got a nonstandard scriptpubkey (00020000) from remote peer".to_owned())
7291 _ => panic!("Unexpected event"),
7293 check_added_monitors!(nodes[0], 1);
7297 fn test_user_configurable_csv_delay() {
7298 // We test our channel constructors yield errors when we pass them absurd csv delay
7300 let mut low_our_to_self_config = UserConfig::default();
7301 low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
7302 let mut high_their_to_self_config = UserConfig::default();
7303 high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
7304 let user_cfgs = [Some(high_their_to_self_config.clone()), None];
7305 let chanmon_cfgs = create_chanmon_cfgs(2);
7306 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7307 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
7308 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7310 // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
7311 if let Err(error) = Channel::new_outbound(&&test_utils::TestFeeEstimator { sat_per_kw: 253 }, &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), 1000000, 1000000, 0, &low_our_to_self_config) {
7313 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())); },
7314 _ => panic!("Unexpected event"),
7316 } else { assert!(false) }
7318 // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
7319 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7320 let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7321 open_channel.to_self_delay = 200;
7322 if let Err(error) = Channel::new_from_req(&&test_utils::TestFeeEstimator { sat_per_kw: 253 }, &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), InitFeatures::known(), &open_channel, 0, &low_our_to_self_config) {
7324 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())); },
7325 _ => panic!("Unexpected event"),
7327 } else { assert!(false); }
7329 // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
7330 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7331 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id()));
7332 let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7333 accept_channel.to_self_delay = 200;
7334 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7335 if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
7337 &ErrorAction::SendErrorMessage { ref msg } => {
7338 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()));
7340 _ => { assert!(false); }
7342 } else { assert!(false); }
7344 // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
7345 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7346 let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7347 open_channel.to_self_delay = 200;
7348 if let Err(error) = Channel::new_from_req(&&test_utils::TestFeeEstimator { sat_per_kw: 253 }, &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), InitFeatures::known(), &open_channel, 0, &high_their_to_self_config) {
7350 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())); },
7351 _ => panic!("Unexpected event"),
7353 } else { assert!(false); }
7357 fn test_data_loss_protect() {
7358 // We want to be sure that :
7359 // * we don't broadcast our Local Commitment Tx in case of fallen behind
7360 // (but this is not quite true - we broadcast during Drop because chanmon is out of sync with chanmgr)
7361 // * we close channel in case of detecting other being fallen behind
7362 // * we are able to claim our own outputs thanks to to_remote being static
7363 // TODO: this test is incomplete and the data_loss_protect implementation is incomplete - see issue #775
7369 let mut chanmon_cfgs = create_chanmon_cfgs(2);
7370 // We broadcast during Drop because chanmon is out of sync with chanmgr, which would cause a panic
7371 // during signing due to revoked tx
7372 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7373 let keys_manager = &chanmon_cfgs[0].keys_manager;
7376 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7377 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7378 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7380 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7382 // Cache node A state before any channel update
7383 let previous_node_state = nodes[0].node.encode();
7384 let mut previous_chain_monitor_state = test_utils::TestVecWriter(Vec::new());
7385 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut previous_chain_monitor_state).unwrap();
7387 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
7388 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
7390 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7391 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7393 // Restore node A from previous state
7394 logger = test_utils::TestLogger::with_id(format!("node {}", 0));
7395 let mut chain_monitor = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut ::std::io::Cursor::new(previous_chain_monitor_state.0), keys_manager).unwrap().1;
7396 chain_source = test_utils::TestChainSource::new(Network::Testnet);
7397 tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())};
7398 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
7399 persister = test_utils::TestPersister::new();
7400 monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &fee_estimator, &persister, keys_manager);
7402 let mut channel_monitors = HashMap::new();
7403 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chain_monitor);
7404 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut ::std::io::Cursor::new(previous_node_state), ChannelManagerReadArgs {
7405 keys_manager: keys_manager,
7406 fee_estimator: &fee_estimator,
7407 chain_monitor: &monitor,
7409 tx_broadcaster: &tx_broadcaster,
7410 default_config: UserConfig::default(),
7414 nodes[0].node = &node_state_0;
7415 assert!(monitor.watch_channel(OutPoint { txid: chan.3.txid(), index: 0 }, chain_monitor).is_ok());
7416 nodes[0].chain_monitor = &monitor;
7417 nodes[0].chain_source = &chain_source;
7419 check_added_monitors!(nodes[0], 1);
7421 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7422 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7424 let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7426 // Check we don't broadcast any transactions following learning of per_commitment_point from B
7427 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
7428 check_added_monitors!(nodes[0], 1);
7431 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7432 assert_eq!(node_txn.len(), 0);
7435 let mut reestablish_1 = Vec::with_capacity(1);
7436 for msg in nodes[0].node.get_and_clear_pending_msg_events() {
7437 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
7438 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7439 reestablish_1.push(msg.clone());
7440 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
7441 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
7443 &ErrorAction::SendErrorMessage { ref msg } => {
7444 assert_eq!(msg.data, "We have fallen behind - we have received proof that if we broadcast remote is going to claim our funds - we can't do any automated broadcasting");
7446 _ => panic!("Unexpected event!"),
7449 panic!("Unexpected event")
7453 // Check we close channel detecting A is fallen-behind
7454 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7455 assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
7456 check_added_monitors!(nodes[1], 1);
7459 // Check A is able to claim to_remote output
7460 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7461 assert_eq!(node_txn.len(), 1);
7462 check_spends!(node_txn[0], chan.3);
7463 assert_eq!(node_txn[0].output.len(), 2);
7464 mine_transaction(&nodes[0], &node_txn[0]);
7465 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7466 let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 1000000);
7467 assert_eq!(spend_txn.len(), 1);
7468 check_spends!(spend_txn[0], node_txn[0]);
7472 fn test_check_htlc_underpaying() {
7473 // Send payment through A -> B but A is maliciously
7474 // sending a probe payment (i.e less than expected value0
7475 // to B, B should refuse payment.
7477 let chanmon_cfgs = create_chanmon_cfgs(2);
7478 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7479 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7480 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7482 // Create some initial channels
7483 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7485 let (payment_preimage, payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 10_000);
7487 // Node 3 is expecting payment of 100_000 but receive 10_000,
7488 // fail htlc like we didn't know the preimage.
7489 nodes[1].node.claim_funds(payment_preimage, &None, 100_000);
7490 nodes[1].node.process_pending_htlc_forwards();
7492 let events = nodes[1].node.get_and_clear_pending_msg_events();
7493 assert_eq!(events.len(), 1);
7494 let (update_fail_htlc, commitment_signed) = match events[0] {
7495 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 } } => {
7496 assert!(update_add_htlcs.is_empty());
7497 assert!(update_fulfill_htlcs.is_empty());
7498 assert_eq!(update_fail_htlcs.len(), 1);
7499 assert!(update_fail_malformed_htlcs.is_empty());
7500 assert!(update_fee.is_none());
7501 (update_fail_htlcs[0].clone(), commitment_signed)
7503 _ => panic!("Unexpected event"),
7505 check_added_monitors!(nodes[1], 1);
7507 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
7508 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
7510 // 10_000 msat as u64, followed by a height of CHAN_CONFIRM_DEPTH as u32
7511 let mut expected_failure_data = byte_utils::be64_to_array(10_000).to_vec();
7512 expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(CHAN_CONFIRM_DEPTH));
7513 expect_payment_failed!(nodes[0], payment_hash, true, 0x4000|15, &expected_failure_data[..]);
7514 nodes[1].node.get_and_clear_pending_events();
7518 fn test_announce_disable_channels() {
7519 // Create 2 channels between A and B. Disconnect B. Call timer_tick_occurred and check for generated
7520 // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
7522 let chanmon_cfgs = create_chanmon_cfgs(2);
7523 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7524 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7525 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7527 let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7528 let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7529 let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7532 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7533 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7535 nodes[0].node.timer_tick_occurred(); // dirty -> stagged
7536 nodes[0].node.timer_tick_occurred(); // staged -> fresh
7537 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7538 assert_eq!(msg_events.len(), 3);
7539 for e in msg_events {
7541 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7542 let short_id = msg.contents.short_channel_id;
7543 // Check generated channel_update match list in PendingChannelUpdate
7544 if short_id != short_id_1 && short_id != short_id_2 && short_id != short_id_3 {
7545 panic!("Generated ChannelUpdate for wrong chan!");
7548 _ => panic!("Unexpected event"),
7552 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7553 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7554 assert_eq!(reestablish_1.len(), 3);
7555 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7556 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7557 assert_eq!(reestablish_2.len(), 3);
7559 // Reestablish chan_1
7560 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7561 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7562 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7563 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7564 // Reestablish chan_2
7565 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
7566 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7567 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
7568 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7569 // Reestablish chan_3
7570 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
7571 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7572 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
7573 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7575 nodes[0].node.timer_tick_occurred();
7576 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7580 fn test_bump_penalty_txn_on_revoked_commitment() {
7581 // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
7582 // we're able to claim outputs on revoked commitment transaction before timelocks expiration
7584 let chanmon_cfgs = create_chanmon_cfgs(2);
7585 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7586 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7587 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7589 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7590 let logger = test_utils::TestLogger::new();
7592 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7593 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
7594 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), None, None, &Vec::new(), 3000000, 30, &logger).unwrap();
7595 send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
7597 let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
7598 // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7599 assert_eq!(revoked_txn[0].output.len(), 4);
7600 assert_eq!(revoked_txn[0].input.len(), 1);
7601 assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
7602 let revoked_txid = revoked_txn[0].txid();
7604 let mut penalty_sum = 0;
7605 for outp in revoked_txn[0].output.iter() {
7606 if outp.script_pubkey.is_v0_p2wsh() {
7607 penalty_sum += outp.value;
7611 // Connect blocks to change height_timer range to see if we use right soonest_timelock
7612 let header_114 = connect_blocks(&nodes[1], 14);
7614 // Actually revoke tx by claiming a HTLC
7615 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
7616 let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7617 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_txn[0].clone()] });
7618 check_added_monitors!(nodes[1], 1);
7620 // One or more justice tx should have been broadcast, check it
7624 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7625 assert_eq!(node_txn.len(), 3); // justice tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout (broadcasted from ChannelManager)
7626 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7627 assert_eq!(node_txn[0].output.len(), 1);
7628 check_spends!(node_txn[0], revoked_txn[0]);
7629 let fee_1 = penalty_sum - node_txn[0].output[0].value;
7630 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
7631 penalty_1 = node_txn[0].txid();
7635 // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
7636 connect_blocks(&nodes[1], 15);
7637 let mut penalty_2 = penalty_1;
7638 let mut feerate_2 = 0;
7640 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7641 assert_eq!(node_txn.len(), 1);
7642 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7643 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7644 assert_eq!(node_txn[0].output.len(), 1);
7645 check_spends!(node_txn[0], revoked_txn[0]);
7646 penalty_2 = node_txn[0].txid();
7647 // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7648 assert_ne!(penalty_2, penalty_1);
7649 let fee_2 = penalty_sum - node_txn[0].output[0].value;
7650 feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7651 // Verify 25% bump heuristic
7652 assert!(feerate_2 * 100 >= feerate_1 * 125);
7656 assert_ne!(feerate_2, 0);
7658 // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
7659 connect_blocks(&nodes[1], 1);
7661 let mut feerate_3 = 0;
7663 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7664 assert_eq!(node_txn.len(), 1);
7665 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7666 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7667 assert_eq!(node_txn[0].output.len(), 1);
7668 check_spends!(node_txn[0], revoked_txn[0]);
7669 penalty_3 = node_txn[0].txid();
7670 // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7671 assert_ne!(penalty_3, penalty_2);
7672 let fee_3 = penalty_sum - node_txn[0].output[0].value;
7673 feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
7674 // Verify 25% bump heuristic
7675 assert!(feerate_3 * 100 >= feerate_2 * 125);
7679 assert_ne!(feerate_3, 0);
7681 nodes[1].node.get_and_clear_pending_events();
7682 nodes[1].node.get_and_clear_pending_msg_events();
7686 fn test_bump_penalty_txn_on_revoked_htlcs() {
7687 // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
7688 // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
7690 let mut chanmon_cfgs = create_chanmon_cfgs(2);
7691 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
7692 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7693 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7694 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7696 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7697 // Lock HTLC in both directions
7698 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3_000_000).0;
7699 route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7701 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7702 assert_eq!(revoked_local_txn[0].input.len(), 1);
7703 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7705 // Revoke local commitment tx
7706 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
7708 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7709 // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
7710 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] });
7711 check_closed_broadcast!(nodes[1], true);
7712 check_added_monitors!(nodes[1], 1);
7714 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7715 assert_eq!(revoked_htlc_txn.len(), 4);
7716 if revoked_htlc_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7717 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7718 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7719 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7720 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7721 assert_eq!(revoked_htlc_txn[1].output.len(), 1);
7722 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7723 } else if revoked_htlc_txn[1].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7724 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7725 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7726 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7727 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7728 assert_eq!(revoked_htlc_txn[0].output.len(), 1);
7729 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7732 // Broadcast set of revoked txn on A
7733 let hash_128 = connect_blocks(&nodes[0], 40);
7734 let header_11 = BlockHeader { version: 0x20000000, prev_blockhash: hash_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7735 connect_block(&nodes[0], &Block { header: header_11, txdata: vec![revoked_local_txn[0].clone()] });
7736 let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_11.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7737 connect_block(&nodes[0], &Block { header: header_129, txdata: vec![revoked_htlc_txn[0].clone(), revoked_htlc_txn[1].clone()] });
7738 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
7743 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7744 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
7745 // Verify claim tx are spending revoked HTLC txn
7747 // node_txn 0-2 each spend a separate revoked output from revoked_local_txn[0]
7748 // Note that node_txn[0] and node_txn[1] are bogus - they double spend the revoked_htlc_txn
7749 // which are included in the same block (they are broadcasted because we scan the
7750 // transactions linearly and generate claims as we go, they likely should be removed in the
7752 assert_eq!(node_txn[0].input.len(), 1);
7753 check_spends!(node_txn[0], revoked_local_txn[0]);
7754 assert_eq!(node_txn[1].input.len(), 1);
7755 check_spends!(node_txn[1], revoked_local_txn[0]);
7756 assert_eq!(node_txn[2].input.len(), 1);
7757 check_spends!(node_txn[2], revoked_local_txn[0]);
7759 // Each of the three justice transactions claim a separate (single) output of the three
7760 // available, which we check here:
7761 assert_ne!(node_txn[0].input[0].previous_output, node_txn[1].input[0].previous_output);
7762 assert_ne!(node_txn[0].input[0].previous_output, node_txn[2].input[0].previous_output);
7763 assert_ne!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
7765 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
7766 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
7768 // node_txn[3] is the local commitment tx broadcast just because (and somewhat in case of
7769 // reorgs, though its not clear its ever worth broadcasting conflicting txn like this when
7770 // a remote commitment tx has already been confirmed).
7771 check_spends!(node_txn[3], chan.3);
7773 // node_txn[4] spends the revoked outputs from the revoked_htlc_txn (which only have one
7774 // output, checked above).
7775 assert_eq!(node_txn[4].input.len(), 2);
7776 assert_eq!(node_txn[4].output.len(), 1);
7777 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7779 first = node_txn[4].txid();
7780 // Store both feerates for later comparison
7781 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[4].output[0].value;
7782 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
7783 penalty_txn = vec![node_txn[2].clone()];
7787 // Connect one more block to see if bumped penalty are issued for HTLC txn
7788 let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7789 connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
7790 let header_131 = BlockHeader { version: 0x20000000, prev_blockhash: header_130.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7791 connect_block(&nodes[0], &Block { header: header_131, txdata: Vec::new() });
7793 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7794 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
7796 check_spends!(node_txn[0], revoked_local_txn[0]);
7797 check_spends!(node_txn[1], revoked_local_txn[0]);
7798 // Note that these are both bogus - they spend outputs already claimed in block 129:
7799 if node_txn[0].input[0].previous_output == revoked_htlc_txn[0].input[0].previous_output {
7800 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
7802 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
7803 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
7809 // Few more blocks to confirm penalty txn
7810 connect_blocks(&nodes[0], 4);
7811 assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
7812 let header_144 = connect_blocks(&nodes[0], 9);
7814 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7815 assert_eq!(node_txn.len(), 1);
7817 assert_eq!(node_txn[0].input.len(), 2);
7818 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7819 // Verify bumped tx is different and 25% bump heuristic
7820 assert_ne!(first, node_txn[0].txid());
7821 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[0].output[0].value;
7822 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7823 assert!(feerate_2 * 100 > feerate_1 * 125);
7824 let txn = vec![node_txn[0].clone()];
7828 // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
7829 let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7830 connect_block(&nodes[0], &Block { header: header_145, txdata: node_txn });
7831 connect_blocks(&nodes[0], 20);
7833 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7834 // We verify than no new transaction has been broadcast because previously
7835 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
7836 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
7837 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
7838 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
7839 // up bumped justice generation.
7840 assert_eq!(node_txn.len(), 0);
7843 check_closed_broadcast!(nodes[0], true);
7844 check_added_monitors!(nodes[0], 1);
7848 fn test_bump_penalty_txn_on_remote_commitment() {
7849 // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
7850 // we're able to claim outputs on remote commitment transaction before timelocks expiration
7853 // Provide preimage for one
7854 // Check aggregation
7856 let chanmon_cfgs = create_chanmon_cfgs(2);
7857 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7858 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7859 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7861 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7862 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7863 route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
7865 // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7866 let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
7867 assert_eq!(remote_txn[0].output.len(), 4);
7868 assert_eq!(remote_txn[0].input.len(), 1);
7869 assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
7871 // Claim a HTLC without revocation (provide B monitor with preimage)
7872 nodes[1].node.claim_funds(payment_preimage, &None, 3_000_000);
7873 mine_transaction(&nodes[1], &remote_txn[0]);
7874 check_added_monitors!(nodes[1], 2);
7876 // One or more claim tx should have been broadcast, check it
7879 let feerate_timeout;
7880 let feerate_preimage;
7882 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7883 assert_eq!(node_txn.len(), 5); // 2 * claim tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout + local HTLC-success (broadcasted from ChannelManager)
7884 assert_eq!(node_txn[0].input.len(), 1);
7885 assert_eq!(node_txn[1].input.len(), 1);
7886 check_spends!(node_txn[0], remote_txn[0]);
7887 check_spends!(node_txn[1], remote_txn[0]);
7888 check_spends!(node_txn[2], chan.3);
7889 check_spends!(node_txn[3], node_txn[2]);
7890 check_spends!(node_txn[4], node_txn[2]);
7891 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7892 timeout = node_txn[0].txid();
7893 let index = node_txn[0].input[0].previous_output.vout;
7894 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7895 feerate_timeout = fee * 1000 / node_txn[0].get_weight() as u64;
7897 preimage = node_txn[1].txid();
7898 let index = node_txn[1].input[0].previous_output.vout;
7899 let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7900 feerate_preimage = fee * 1000 / node_txn[1].get_weight() as u64;
7902 timeout = node_txn[1].txid();
7903 let index = node_txn[1].input[0].previous_output.vout;
7904 let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7905 feerate_timeout = fee * 1000 / node_txn[1].get_weight() as u64;
7907 preimage = node_txn[0].txid();
7908 let index = node_txn[0].input[0].previous_output.vout;
7909 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7910 feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
7914 assert_ne!(feerate_timeout, 0);
7915 assert_ne!(feerate_preimage, 0);
7917 // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
7918 connect_blocks(&nodes[1], 15);
7920 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7921 assert_eq!(node_txn.len(), 2);
7922 assert_eq!(node_txn[0].input.len(), 1);
7923 assert_eq!(node_txn[1].input.len(), 1);
7924 check_spends!(node_txn[0], remote_txn[0]);
7925 check_spends!(node_txn[1], remote_txn[0]);
7926 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7927 let index = node_txn[0].input[0].previous_output.vout;
7928 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7929 let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
7930 assert!(new_feerate * 100 > feerate_timeout * 125);
7931 assert_ne!(timeout, node_txn[0].txid());
7933 let index = node_txn[1].input[0].previous_output.vout;
7934 let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7935 let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
7936 assert!(new_feerate * 100 > feerate_preimage * 125);
7937 assert_ne!(preimage, node_txn[1].txid());
7939 let index = node_txn[1].input[0].previous_output.vout;
7940 let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7941 let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
7942 assert!(new_feerate * 100 > feerate_timeout * 125);
7943 assert_ne!(timeout, node_txn[1].txid());
7945 let index = node_txn[0].input[0].previous_output.vout;
7946 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7947 let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
7948 assert!(new_feerate * 100 > feerate_preimage * 125);
7949 assert_ne!(preimage, node_txn[0].txid());
7954 nodes[1].node.get_and_clear_pending_events();
7955 nodes[1].node.get_and_clear_pending_msg_events();
7959 fn test_counterparty_raa_skip_no_crash() {
7960 // Previously, if our counterparty sent two RAAs in a row without us having provided a
7961 // commitment transaction, we would have happily carried on and provided them the next
7962 // commitment transaction based on one RAA forward. This would probably eventually have led to
7963 // channel closure, but it would not have resulted in funds loss. Still, our
7964 // EnforcingSigner would have paniced as it doesn't like jumps into the future. Here, we
7965 // check simply that the channel is closed in response to such an RAA, but don't check whether
7966 // we decide to punish our counterparty for revoking their funds (as we don't currently
7968 let chanmon_cfgs = create_chanmon_cfgs(2);
7969 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7970 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7971 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7972 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
7974 let mut guard = nodes[0].node.channel_state.lock().unwrap();
7975 let keys = &guard.by_id.get_mut(&channel_id).unwrap().get_signer();
7976 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
7977 let per_commitment_secret = keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER);
7978 // Must revoke without gaps
7979 keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 1);
7980 let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
7981 &SecretKey::from_slice(&keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
7983 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
7984 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
7985 assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
7986 check_added_monitors!(nodes[1], 1);
7990 fn test_bump_txn_sanitize_tracking_maps() {
7991 // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
7992 // verify we clean then right after expiration of ANTI_REORG_DELAY.
7994 let chanmon_cfgs = create_chanmon_cfgs(2);
7995 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7996 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7997 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7999 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8000 // Lock HTLC in both directions
8001 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8002 route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
8004 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8005 assert_eq!(revoked_local_txn[0].input.len(), 1);
8006 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8008 // Revoke local commitment tx
8009 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 9_000_000);
8011 // Broadcast set of revoked txn on A
8012 connect_blocks(&nodes[0], 52 - CHAN_CONFIRM_DEPTH);
8013 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8014 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 0);
8016 mine_transaction(&nodes[0], &revoked_local_txn[0]);
8017 check_closed_broadcast!(nodes[0], true);
8018 check_added_monitors!(nodes[0], 1);
8020 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8021 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
8022 check_spends!(node_txn[0], revoked_local_txn[0]);
8023 check_spends!(node_txn[1], revoked_local_txn[0]);
8024 check_spends!(node_txn[2], revoked_local_txn[0]);
8025 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
8029 let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8030 connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8031 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8033 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8034 if let Some(monitor) = monitors.get(&OutPoint { txid: chan.3.txid(), index: 0 }) {
8035 assert!(monitor.inner.lock().unwrap().onchain_tx_handler.pending_claim_requests.is_empty());
8036 assert!(monitor.inner.lock().unwrap().onchain_tx_handler.claimable_outpoints.is_empty());
8042 fn test_override_channel_config() {
8043 let chanmon_cfgs = create_chanmon_cfgs(2);
8044 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8045 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8046 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8048 // Node0 initiates a channel to node1 using the override config.
8049 let mut override_config = UserConfig::default();
8050 override_config.own_channel_config.our_to_self_delay = 200;
8052 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
8054 // Assert the channel created by node0 is using the override config.
8055 let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8056 assert_eq!(res.channel_flags, 0);
8057 assert_eq!(res.to_self_delay, 200);
8061 fn test_override_0msat_htlc_minimum() {
8062 let mut zero_config = UserConfig::default();
8063 zero_config.own_channel_config.our_htlc_minimum_msat = 0;
8064 let chanmon_cfgs = create_chanmon_cfgs(2);
8065 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8066 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
8067 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8069 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
8070 let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8071 assert_eq!(res.htlc_minimum_msat, 1);
8073 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &res);
8074 let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8075 assert_eq!(res.htlc_minimum_msat, 1);
8079 fn test_simple_payment_secret() {
8080 // Simple test of sending a payment with a payment_secret present. This does not use any AMP
8081 // features, however.
8082 let chanmon_cfgs = create_chanmon_cfgs(3);
8083 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8084 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8085 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8087 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8088 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
8089 let logger = test_utils::TestLogger::new();
8091 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(&nodes[0]);
8092 let payment_secret = PaymentSecret([0xdb; 32]);
8093 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8094 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), None, None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
8095 send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2]]], 100000, payment_hash, Some(payment_secret.clone()));
8096 // Claiming with all the correct values but the wrong secret should result in nothing...
8097 assert_eq!(nodes[2].node.claim_funds(payment_preimage, &None, 100_000), false);
8098 assert_eq!(nodes[2].node.claim_funds(payment_preimage, &Some(PaymentSecret([42; 32])), 100_000), false);
8099 // ...but with the right secret we should be able to claim all the way back
8100 claim_payment_along_route_with_secret(&nodes[0], &[&[&nodes[1], &nodes[2]]], false, payment_preimage, Some(payment_secret.clone()), 100_000);
8104 fn test_simple_mpp() {
8105 // Simple test of sending a multi-path payment.
8106 let chanmon_cfgs = create_chanmon_cfgs(4);
8107 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8108 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8109 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8111 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8112 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8113 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8114 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8115 let logger = test_utils::TestLogger::new();
8117 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(&nodes[0]);
8118 let payment_secret = PaymentSecret([0xdb; 32]);
8119 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8120 let mut route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[3].node.get_our_node_id(), None, None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
8121 let path = route.paths[0].clone();
8122 route.paths.push(path);
8123 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8124 route.paths[0][0].short_channel_id = chan_1_id;
8125 route.paths[0][1].short_channel_id = chan_3_id;
8126 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8127 route.paths[1][0].short_channel_id = chan_2_id;
8128 route.paths[1][1].short_channel_id = chan_4_id;
8129 send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, Some(payment_secret.clone()));
8130 // Claiming with all the correct values but the wrong secret should result in nothing...
8131 assert_eq!(nodes[3].node.claim_funds(payment_preimage, &None, 200_000), false);
8132 assert_eq!(nodes[3].node.claim_funds(payment_preimage, &Some(PaymentSecret([42; 32])), 200_000), false);
8133 // ...but with the right secret we should be able to claim all the way back
8134 claim_payment_along_route_with_secret(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage, Some(payment_secret), 200_000);
8138 fn test_update_err_monitor_lockdown() {
8139 // Our monitor will lock update of local commitment transaction if a broadcastion condition
8140 // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
8141 // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateErr.
8143 // This scenario may happen in a watchtower setup, where watchtower process a block height
8144 // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
8145 // commitment at same time.
8147 let chanmon_cfgs = create_chanmon_cfgs(2);
8148 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8149 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8150 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8152 // Create some initial channel
8153 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8154 let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8156 // Rebalance the network to generate htlc in the two directions
8157 send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000, 10_000_000);
8159 // Route a HTLC from node 0 to node 1 (but don't settle)
8160 let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8162 // Copy ChainMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
8163 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8164 let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
8165 let persister = test_utils::TestPersister::new();
8167 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8168 let monitor = monitors.get(&outpoint).unwrap();
8169 let mut w = test_utils::TestVecWriter(Vec::new());
8170 monitor.write(&mut w).unwrap();
8171 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8172 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8173 assert!(new_monitor == *monitor);
8174 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);
8175 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8178 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8179 watchtower.chain_monitor.block_connected(&Block { header, txdata: vec![] }, 200);
8181 // Try to update ChannelMonitor
8182 assert!(nodes[1].node.claim_funds(preimage, &None, 9_000_000));
8183 check_added_monitors!(nodes[1], 1);
8184 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8185 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8186 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8187 if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8188 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8189 if let Err(_) = watchtower.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8190 if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8191 } else { assert!(false); }
8192 } else { assert!(false); };
8193 // Our local monitor is in-sync and hasn't processed yet timeout
8194 check_added_monitors!(nodes[0], 1);
8195 let events = nodes[0].node.get_and_clear_pending_events();
8196 assert_eq!(events.len(), 1);
8200 fn test_concurrent_monitor_claim() {
8201 // Watchtower A receives block, broadcasts state N, then channel receives new state N+1,
8202 // sending it to both watchtowers, Bob accepts N+1, then receives block and broadcasts
8203 // the latest state N+1, Alice rejects state N+1, but Bob has already broadcast it,
8204 // state N+1 confirms. Alice claims output from state N+1.
8206 let chanmon_cfgs = create_chanmon_cfgs(2);
8207 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8208 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8209 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8211 // Create some initial channel
8212 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8213 let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8215 // Rebalance the network to generate htlc in the two directions
8216 send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000, 10_000_000);
8218 // Route a HTLC from node 0 to node 1 (but don't settle)
8219 route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8221 // Copy ChainMonitor to simulate watchtower Alice and update block height her ChannelMonitor timeout HTLC onchain
8222 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8223 let logger = test_utils::TestLogger::with_id(format!("node {}", "Alice"));
8224 let persister = test_utils::TestPersister::new();
8225 let watchtower_alice = {
8226 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8227 let monitor = monitors.get(&outpoint).unwrap();
8228 let mut w = test_utils::TestVecWriter(Vec::new());
8229 monitor.write(&mut w).unwrap();
8230 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8231 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8232 assert!(new_monitor == *monitor);
8233 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);
8234 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8237 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8238 watchtower_alice.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8240 // Watchtower Alice should have broadcast a commitment/HTLC-timeout
8242 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8243 assert_eq!(txn.len(), 2);
8247 // Copy ChainMonitor to simulate watchtower Bob and make it receive a commitment update first.
8248 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8249 let logger = test_utils::TestLogger::with_id(format!("node {}", "Bob"));
8250 let persister = test_utils::TestPersister::new();
8251 let watchtower_bob = {
8252 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8253 let monitor = monitors.get(&outpoint).unwrap();
8254 let mut w = test_utils::TestVecWriter(Vec::new());
8255 monitor.write(&mut w).unwrap();
8256 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8257 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8258 assert!(new_monitor == *monitor);
8259 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);
8260 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8263 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8264 watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8266 // Route another payment to generate another update with still previous HTLC pending
8267 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
8269 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
8270 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), None, None, &Vec::new(), 3000000 , TEST_FINAL_CLTV, &logger).unwrap();
8271 nodes[1].node.send_payment(&route, payment_hash, &None).unwrap();
8273 check_added_monitors!(nodes[1], 1);
8275 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8276 assert_eq!(updates.update_add_htlcs.len(), 1);
8277 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &updates.update_add_htlcs[0]);
8278 if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8279 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8280 // Watchtower Alice should already have seen the block and reject the update
8281 if let Err(_) = watchtower_alice.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8282 if let Ok(_) = watchtower_bob.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8283 if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8284 } else { assert!(false); }
8285 } else { assert!(false); };
8286 // Our local monitor is in-sync and hasn't processed yet timeout
8287 check_added_monitors!(nodes[0], 1);
8289 //// Provide one more block to watchtower Bob, expect broadcast of commitment and HTLC-Timeout
8290 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8291 watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8293 // Watchtower Bob should have broadcast a commitment/HTLC-timeout
8296 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8297 assert_eq!(txn.len(), 2);
8298 bob_state_y = txn[0].clone();
8302 // We confirm Bob's state Y on Alice, she should broadcast a HTLC-timeout
8303 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8304 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);
8306 let htlc_txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8307 // We broadcast twice the transaction, once due to the HTLC-timeout, once due
8308 // the onchain detection of the HTLC output
8309 assert_eq!(htlc_txn.len(), 2);
8310 check_spends!(htlc_txn[0], bob_state_y);
8311 check_spends!(htlc_txn[1], bob_state_y);
8316 fn test_pre_lockin_no_chan_closed_update() {
8317 // Test that if a peer closes a channel in response to a funding_created message we don't
8318 // generate a channel update (as the channel cannot appear on chain without a funding_signed
8321 // Doing so would imply a channel monitor update before the initial channel monitor
8322 // registration, violating our API guarantees.
8324 // Previously, full_stack_target managed to hit this case by opening then closing a channel,
8325 // then opening a second channel with the same funding output as the first (which is not
8326 // rejected because the first channel does not exist in the ChannelManager) and closing it
8327 // before receiving funding_signed.
8328 let chanmon_cfgs = create_chanmon_cfgs(2);
8329 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8330 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8331 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8333 // Create an initial channel
8334 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8335 let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8336 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8337 let accept_chan_msg = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8338 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_chan_msg);
8340 // Move the first channel through the funding flow...
8341 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], 100000, 42);
8343 nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
8344 check_added_monitors!(nodes[0], 0);
8346 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8347 let channel_id = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
8348 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id, data: "Hi".to_owned() });
8349 assert!(nodes[0].chain_monitor.added_monitors.lock().unwrap().is_empty());
8353 fn test_htlc_no_detection() {
8354 // This test is a mutation to underscore the detection logic bug we had
8355 // before #653. HTLC value routed is above the remaining balance, thus
8356 // inverting HTLC and `to_remote` output. HTLC will come second and
8357 // it wouldn't be seen by pre-#653 detection as we were enumerate()'ing
8358 // on a watched outputs vector (Vec<TxOut>) thus implicitly relying on
8359 // outputs order detection for correct spending children filtring.
8361 let chanmon_cfgs = create_chanmon_cfgs(2);
8362 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8363 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8364 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8366 // Create some initial channels
8367 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8369 send_payment(&nodes[0], &vec!(&nodes[1])[..], 1_000_000, 1_000_000);
8370 let (_, our_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 2_000_000);
8371 let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
8372 assert_eq!(local_txn[0].input.len(), 1);
8373 assert_eq!(local_txn[0].output.len(), 3);
8374 check_spends!(local_txn[0], chan_1.3);
8376 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
8377 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8378 connect_block(&nodes[0], &Block { header, txdata: vec![local_txn[0].clone()] });
8379 // We deliberately connect the local tx twice as this should provoke a failure calling
8380 // this test before #653 fix.
8381 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);
8382 check_closed_broadcast!(nodes[0], true);
8383 check_added_monitors!(nodes[0], 1);
8385 let htlc_timeout = {
8386 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8387 assert_eq!(node_txn[0].input.len(), 1);
8388 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8389 check_spends!(node_txn[0], local_txn[0]);
8393 let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8394 connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] });
8395 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8396 expect_payment_failed!(nodes[0], our_payment_hash, true);
8399 fn do_test_onchain_htlc_settlement_after_close(broadcast_alice: bool, go_onchain_before_fulfill: bool) {
8400 // If we route an HTLC, then learn the HTLC's preimage after the upstream channel has been
8401 // force-closed, we must claim that HTLC on-chain. (Given an HTLC forwarded from Alice --> Bob -->
8402 // Carol, Alice would be the upstream node, and Carol the downstream.)
8404 // Steps of the test:
8405 // 1) Alice sends a HTLC to Carol through Bob.
8406 // 2) Carol doesn't settle the HTLC.
8407 // 3) If broadcast_alice is true, Alice force-closes her channel with Bob. Else Bob force closes.
8408 // Steps 4 and 5 may be reordered depending on go_onchain_before_fulfill.
8409 // 4) Bob sees the Alice's commitment on his chain or vice versa. An offered output is present
8410 // but can't be claimed as Bob doesn't have yet knowledge of the preimage.
8411 // 5) Carol release the preimage to Bob off-chain.
8412 // 6) Bob claims the offered output on the broadcasted commitment.
8413 let chanmon_cfgs = create_chanmon_cfgs(3);
8414 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8415 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8416 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8418 // Create some initial channels
8419 let chan_ab = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8420 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8422 // Steps (1) and (2):
8423 // Send an HTLC Alice --> Bob --> Carol, but Carol doesn't settle the HTLC back.
8424 let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3_000_000);
8426 // Check that Alice's commitment transaction now contains an output for this HTLC.
8427 let alice_txn = get_local_commitment_txn!(nodes[0], chan_ab.2);
8428 check_spends!(alice_txn[0], chan_ab.3);
8429 assert_eq!(alice_txn[0].output.len(), 2);
8430 check_spends!(alice_txn[1], alice_txn[0]); // 2nd transaction is a non-final HTLC-timeout
8431 assert_eq!(alice_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8432 assert_eq!(alice_txn.len(), 2);
8434 // Steps (3) and (4):
8435 // If `go_onchain_before_fufill`, broadcast the relevant commitment transaction and check that Bob
8436 // responds by (1) broadcasting a channel update and (2) adding a new ChannelMonitor.
8437 let mut force_closing_node = 0; // Alice force-closes
8438 if !broadcast_alice { force_closing_node = 1; } // Bob force-closes
8439 nodes[force_closing_node].node.force_close_channel(&chan_ab.2).unwrap();
8440 check_closed_broadcast!(nodes[force_closing_node], true);
8441 check_added_monitors!(nodes[force_closing_node], 1);
8442 if go_onchain_before_fulfill {
8443 let txn_to_broadcast = match broadcast_alice {
8444 true => alice_txn.clone(),
8445 false => get_local_commitment_txn!(nodes[1], chan_ab.2)
8447 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8448 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8449 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8450 if broadcast_alice {
8451 check_closed_broadcast!(nodes[1], true);
8452 check_added_monitors!(nodes[1], 1);
8454 assert_eq!(bob_txn.len(), 1);
8455 check_spends!(bob_txn[0], chan_ab.3);
8459 // Carol then claims the funds and sends an update_fulfill message to Bob, and they go through the
8460 // process of removing the HTLC from their commitment transactions.
8461 assert!(nodes[2].node.claim_funds(payment_preimage, &None, 3_000_000));
8462 check_added_monitors!(nodes[2], 1);
8463 let carol_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
8464 assert!(carol_updates.update_add_htlcs.is_empty());
8465 assert!(carol_updates.update_fail_htlcs.is_empty());
8466 assert!(carol_updates.update_fail_malformed_htlcs.is_empty());
8467 assert!(carol_updates.update_fee.is_none());
8468 assert_eq!(carol_updates.update_fulfill_htlcs.len(), 1);
8470 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &carol_updates.update_fulfill_htlcs[0]);
8471 // If Alice broadcasted but Bob doesn't know yet, here he prepares to tell her about the preimage.
8472 if !go_onchain_before_fulfill && broadcast_alice {
8473 let events = nodes[1].node.get_and_clear_pending_msg_events();
8474 assert_eq!(events.len(), 1);
8476 MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
8477 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
8479 _ => panic!("Unexpected event"),
8482 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &carol_updates.commitment_signed);
8483 // One monitor update for the preimage to update the Bob<->Alice channel, one monitor update
8484 // Carol<->Bob's updated commitment transaction info.
8485 check_added_monitors!(nodes[1], 2);
8487 let events = nodes[1].node.get_and_clear_pending_msg_events();
8488 assert_eq!(events.len(), 2);
8489 let bob_revocation = match events[0] {
8490 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8491 assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8494 _ => panic!("Unexpected event"),
8496 let bob_updates = match events[1] {
8497 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
8498 assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8501 _ => panic!("Unexpected event"),
8504 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bob_revocation);
8505 check_added_monitors!(nodes[2], 1);
8506 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bob_updates.commitment_signed);
8507 check_added_monitors!(nodes[2], 1);
8509 let events = nodes[2].node.get_and_clear_pending_msg_events();
8510 assert_eq!(events.len(), 1);
8511 let carol_revocation = match events[0] {
8512 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8513 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
8516 _ => panic!("Unexpected event"),
8518 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &carol_revocation);
8519 check_added_monitors!(nodes[1], 1);
8521 // If this test requires the force-closed channel to not be on-chain until after the fulfill,
8522 // here's where we put said channel's commitment tx on-chain.
8523 let mut txn_to_broadcast = alice_txn.clone();
8524 if !broadcast_alice { txn_to_broadcast = get_local_commitment_txn!(nodes[1], chan_ab.2); }
8525 if !go_onchain_before_fulfill {
8526 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8527 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8528 // If Bob was the one to force-close, he will have already passed these checks earlier.
8529 if broadcast_alice {
8530 check_closed_broadcast!(nodes[1], true);
8531 check_added_monitors!(nodes[1], 1);
8533 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8534 if broadcast_alice {
8535 // In `connect_block()`, the ChainMonitor and ChannelManager are separately notified about a
8536 // new block being connected. The ChannelManager being notified triggers a monitor update,
8537 // which triggers broadcasting our commitment tx and an HTLC-claiming tx. The ChainMonitor
8538 // being notified triggers the HTLC-claiming tx redundantly, resulting in 3 total txs being
8540 assert_eq!(bob_txn.len(), 3);
8541 check_spends!(bob_txn[1], chan_ab.3);
8543 assert_eq!(bob_txn.len(), 2);
8544 check_spends!(bob_txn[0], chan_ab.3);
8549 // Finally, check that Bob broadcasted a preimage-claiming transaction for the HTLC output on the
8550 // broadcasted commitment transaction.
8552 let bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
8553 if go_onchain_before_fulfill {
8554 // Bob should now have an extra broadcasted tx, for the preimage-claiming transaction.
8555 assert_eq!(bob_txn.len(), 2);
8557 let script_weight = match broadcast_alice {
8558 true => OFFERED_HTLC_SCRIPT_WEIGHT,
8559 false => ACCEPTED_HTLC_SCRIPT_WEIGHT
8561 // If Alice force-closed and Bob didn't receive her commitment transaction until after he
8562 // received Carol's fulfill, he broadcasts the HTLC-output-claiming transaction first. Else if
8563 // Bob force closed or if he found out about Alice's commitment tx before receiving Carol's
8564 // fulfill, then he broadcasts the HTLC-output-claiming transaction second.
8565 if broadcast_alice && !go_onchain_before_fulfill {
8566 check_spends!(bob_txn[0], txn_to_broadcast[0]);
8567 assert_eq!(bob_txn[0].input[0].witness.last().unwrap().len(), script_weight);
8569 check_spends!(bob_txn[1], txn_to_broadcast[0]);
8570 assert_eq!(bob_txn[1].input[0].witness.last().unwrap().len(), script_weight);
8576 fn test_onchain_htlc_settlement_after_close() {
8577 do_test_onchain_htlc_settlement_after_close(true, true);
8578 do_test_onchain_htlc_settlement_after_close(false, true); // Technically redundant, but may as well
8579 do_test_onchain_htlc_settlement_after_close(true, false);
8580 do_test_onchain_htlc_settlement_after_close(false, false);
8584 fn test_duplicate_chan_id() {
8585 // Test that if a given peer tries to open a channel with the same channel_id as one that is
8586 // already open we reject it and keep the old channel.
8588 // Previously, full_stack_target managed to figure out that if you tried to open two channels
8589 // with the same funding output (ie post-funding channel_id), we'd create a monitor update for
8590 // the existing channel when we detect the duplicate new channel, screwing up our monitor
8591 // updating logic for the existing channel.
8592 let chanmon_cfgs = create_chanmon_cfgs(2);
8593 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8594 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8595 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8597 // Create an initial channel
8598 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8599 let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8600 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8601 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id()));
8603 // Try to create a second channel with the same temporary_channel_id as the first and check
8604 // that it is rejected.
8605 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8607 let events = nodes[1].node.get_and_clear_pending_msg_events();
8608 assert_eq!(events.len(), 1);
8610 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8611 // Technically, at this point, nodes[1] would be justified in thinking both the
8612 // first (valid) and second (invalid) channels are closed, given they both have
8613 // the same non-temporary channel_id. However, currently we do not, so we just
8614 // move forward with it.
8615 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
8616 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8618 _ => panic!("Unexpected event"),
8622 // Move the first channel through the funding flow...
8623 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
8625 nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
8626 check_added_monitors!(nodes[0], 0);
8628 let mut funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8629 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
8631 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
8632 assert_eq!(added_monitors.len(), 1);
8633 assert_eq!(added_monitors[0].0, funding_output);
8634 added_monitors.clear();
8636 let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
8638 let funding_outpoint = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index };
8639 let channel_id = funding_outpoint.to_channel_id();
8641 // Now we have the first channel past funding_created (ie it has a txid-based channel_id, not a
8644 // First try to open a second channel with a temporary channel id equal to the txid-based one.
8645 // Technically this is allowed by the spec, but we don't support it and there's little reason
8646 // to. Still, it shouldn't cause any other issues.
8647 open_chan_msg.temporary_channel_id = channel_id;
8648 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8650 let events = nodes[1].node.get_and_clear_pending_msg_events();
8651 assert_eq!(events.len(), 1);
8653 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8654 // Technically, at this point, nodes[1] would be justified in thinking both
8655 // channels are closed, but currently we do not, so we just move forward with it.
8656 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
8657 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8659 _ => panic!("Unexpected event"),
8663 // Now try to create a second channel which has a duplicate funding output.
8664 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8665 let open_chan_2_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8666 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_2_msg);
8667 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id()));
8668 create_funding_transaction(&nodes[0], 100000, 42); // Get and check the FundingGenerationReady event
8670 let funding_created = {
8671 let mut a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
8672 let mut as_chan = a_channel_lock.by_id.get_mut(&open_chan_2_msg.temporary_channel_id).unwrap();
8673 let logger = test_utils::TestLogger::new();
8674 as_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).unwrap()
8676 check_added_monitors!(nodes[0], 0);
8677 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
8678 // At this point we'll try to add a duplicate channel monitor, which will be rejected, but
8679 // still needs to be cleared here.
8680 check_added_monitors!(nodes[1], 1);
8682 // ...still, nodes[1] will reject the duplicate channel.
8684 let events = nodes[1].node.get_and_clear_pending_msg_events();
8685 assert_eq!(events.len(), 1);
8687 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8688 // Technically, at this point, nodes[1] would be justified in thinking both
8689 // channels are closed, but currently we do not, so we just move forward with it.
8690 assert_eq!(msg.channel_id, channel_id);
8691 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8693 _ => panic!("Unexpected event"),
8697 // finally, finish creating the original channel and send a payment over it to make sure
8698 // everything is functional.
8699 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
8701 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
8702 assert_eq!(added_monitors.len(), 1);
8703 assert_eq!(added_monitors[0].0, funding_output);
8704 added_monitors.clear();
8707 let events_4 = nodes[0].node.get_and_clear_pending_events();
8708 assert_eq!(events_4.len(), 0);
8709 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
8710 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
8712 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
8713 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
8714 update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
8715 send_payment(&nodes[0], &[&nodes[1]], 8000000, 8_000_000);
8719 fn test_error_chans_closed() {
8720 // Test that we properly handle error messages, closing appropriate channels.
8722 // Prior to #787 we'd allow a peer to make us force-close a channel we had with a different
8723 // peer. The "real" fix for that is to index channels with peers_ids, however in the mean time
8724 // we can test various edge cases around it to ensure we don't regress.
8725 let chanmon_cfgs = create_chanmon_cfgs(3);
8726 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8727 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8728 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8730 // Create some initial channels
8731 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8732 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8733 let chan_3 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8735 assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
8736 assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
8737 assert_eq!(nodes[2].node.list_usable_channels().len(), 1);
8739 // Closing a channel from a different peer has no effect
8740 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_3.2, data: "ERR".to_owned() });
8741 assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
8743 // Closing one channel doesn't impact others
8744 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_2.2, data: "ERR".to_owned() });
8745 check_added_monitors!(nodes[0], 1);
8746 check_closed_broadcast!(nodes[0], false);
8747 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
8748 assert_eq!(nodes[0].node.list_usable_channels().len(), 2);
8749 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);
8750 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);
8752 // A null channel ID should close all channels
8753 let _chan_4 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8754 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: [0; 32], data: "ERR".to_owned() });
8755 check_added_monitors!(nodes[0], 2);
8756 let events = nodes[0].node.get_and_clear_pending_msg_events();
8757 assert_eq!(events.len(), 2);
8759 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
8760 assert_eq!(msg.contents.flags & 2, 2);
8762 _ => panic!("Unexpected event"),
8765 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
8766 assert_eq!(msg.contents.flags & 2, 2);
8768 _ => panic!("Unexpected event"),
8770 // Note that at this point users of a standard PeerHandler will end up calling
8771 // peer_disconnected with no_connection_possible set to false, duplicating the
8772 // close-all-channels logic. That's OK, we don't want to end up not force-closing channels for
8773 // users with their own peer handling logic. We duplicate the call here, however.
8774 assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
8775 assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
8777 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), true);
8778 assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
8779 assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
8783 fn test_invalid_funding_tx() {
8784 // Test that we properly handle invalid funding transactions sent to us from a peer.
8786 // Previously, all other major lightning implementations had failed to properly sanitize
8787 // funding transactions from their counterparties, leading to a multi-implementation critical
8788 // security vulnerability (though we always sanitized properly, we've previously had
8789 // un-released crashes in the sanitization process).
8790 let chanmon_cfgs = create_chanmon_cfgs(2);
8791 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8792 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8793 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8795 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 10_000, 42, None).unwrap();
8796 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id()));
8797 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id()));
8799 let (temporary_channel_id, mut tx, _) = create_funding_transaction(&nodes[0], 100_000, 42);
8800 for output in tx.output.iter_mut() {
8801 // Make the confirmed funding transaction have a bogus script_pubkey
8802 output.script_pubkey = bitcoin::Script::new();
8805 nodes[0].node.funding_transaction_generated_unchecked(&temporary_channel_id, tx.clone(), 0).unwrap();
8806 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()));
8807 check_added_monitors!(nodes[1], 1);
8809 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()));
8810 check_added_monitors!(nodes[0], 1);
8812 let events_1 = nodes[0].node.get_and_clear_pending_events();
8813 assert_eq!(events_1.len(), 0);
8815 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
8816 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
8817 nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
8819 confirm_transaction_at(&nodes[1], &tx, 1);
8820 check_added_monitors!(nodes[1], 1);
8821 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
8822 assert_eq!(events_2.len(), 1);
8823 if let MessageSendEvent::HandleError { node_id, action } = &events_2[0] {
8824 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
8825 if let msgs::ErrorAction::SendErrorMessage { msg } = action {
8826 assert_eq!(msg.data, "funding tx had wrong script/value or output index");
8827 } else { panic!(); }
8828 } else { panic!(); }
8829 assert_eq!(nodes[1].node.list_channels().len(), 0);