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.
16 use chain::channelmonitor;
17 use chain::channelmonitor::{ChannelMonitor, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY};
18 use chain::transaction::OutPoint;
19 use chain::keysinterface::{Sign, KeysInterface};
20 use ln::channel::{COMMITMENT_TX_BASE_WEIGHT, COMMITMENT_TX_WEIGHT_PER_HTLC};
21 use ln::channelmanager::{ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentPreimage, PaymentHash, PaymentSecret, PaymentSendFailure, BREAKDOWN_TIMEOUT};
22 use ln::channel::{Channel, ChannelError};
23 use ln::{chan_utils, onion_utils};
24 use routing::router::{Route, RouteHop, get_route};
25 use ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
27 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler,HTLCFailChannelUpdate, ErrorAction};
28 use util::enforcing_trait_impls::EnforcingSigner;
29 use util::{byte_utils, test_utils};
30 use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
31 use util::errors::APIError;
32 use util::ser::{Writeable, ReadableArgs};
33 use util::config::UserConfig;
35 use bitcoin::hashes::sha256d::Hash as Sha256dHash;
36 use bitcoin::hash_types::{Txid, BlockHash};
37 use bitcoin::blockdata::block::{Block, BlockHeader};
38 use bitcoin::blockdata::script::Builder;
39 use bitcoin::blockdata::opcodes;
40 use bitcoin::blockdata::constants::genesis_block;
41 use bitcoin::network::constants::Network;
43 use bitcoin::hashes::sha256::Hash as Sha256;
44 use bitcoin::hashes::Hash;
46 use bitcoin::secp256k1::{Secp256k1, Message};
47 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
51 use std::collections::{BTreeSet, HashMap, HashSet};
52 use std::default::Default;
54 use std::sync::atomic::Ordering;
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);
398 fn test_1_conf_open() {
399 // Previously, if the minium_depth config was set to 1, we'd never send a funding_locked. This
400 // tests that we properly send one in that case.
401 let mut alice_config = UserConfig::default();
402 alice_config.own_channel_config.minimum_depth = 1;
403 alice_config.channel_options.announced_channel = true;
404 alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
405 let mut bob_config = UserConfig::default();
406 bob_config.own_channel_config.minimum_depth = 1;
407 bob_config.channel_options.announced_channel = true;
408 bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
409 let chanmon_cfgs = create_chanmon_cfgs(2);
410 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
411 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(alice_config), Some(bob_config)]);
412 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
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 do_test_sanity_on_in_flight_opens(steps: u8) {
430 // Previously, we had issues deserializing channels when we hadn't connected the first block
431 // after creation. To catch that and similar issues, we lean on the Node::drop impl to test
432 // serialization round-trips and simply do steps towards opening a channel and then drop the
435 let chanmon_cfgs = create_chanmon_cfgs(2);
436 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
437 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
438 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
440 if steps & 0b1000_0000 != 0{
442 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
445 connect_block(&nodes[0], &block, 1);
446 connect_block(&nodes[1], &block, 1);
449 if steps & 0x0f == 0 { return; }
450 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
451 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
453 if steps & 0x0f == 1 { return; }
454 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
455 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
457 if steps & 0x0f == 2 { return; }
458 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
460 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
462 if steps & 0x0f == 3 { return; }
463 nodes[0].node.funding_transaction_generated(&temporary_channel_id, funding_output);
464 check_added_monitors!(nodes[0], 0);
465 let funding_created = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
467 if steps & 0x0f == 4 { return; }
468 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
470 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
471 assert_eq!(added_monitors.len(), 1);
472 assert_eq!(added_monitors[0].0, funding_output);
473 added_monitors.clear();
475 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
477 if steps & 0x0f == 5 { return; }
478 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
480 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
481 assert_eq!(added_monitors.len(), 1);
482 assert_eq!(added_monitors[0].0, funding_output);
483 added_monitors.clear();
486 let events_4 = nodes[0].node.get_and_clear_pending_events();
487 assert_eq!(events_4.len(), 1);
489 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
490 assert_eq!(user_channel_id, 42);
491 assert_eq!(*funding_txo, funding_output);
493 _ => panic!("Unexpected event"),
496 if steps & 0x0f == 6 { return; }
497 create_chan_between_nodes_with_value_confirm_first(&nodes[0], &nodes[1], &tx, 2);
499 if steps & 0x0f == 7 { return; }
500 confirm_transaction_at(&nodes[0], &tx, 2);
501 connect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH, 2, false, Default::default());
502 create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
506 fn test_sanity_on_in_flight_opens() {
507 do_test_sanity_on_in_flight_opens(0);
508 do_test_sanity_on_in_flight_opens(0 | 0b1000_0000);
509 do_test_sanity_on_in_flight_opens(1);
510 do_test_sanity_on_in_flight_opens(1 | 0b1000_0000);
511 do_test_sanity_on_in_flight_opens(2);
512 do_test_sanity_on_in_flight_opens(2 | 0b1000_0000);
513 do_test_sanity_on_in_flight_opens(3);
514 do_test_sanity_on_in_flight_opens(3 | 0b1000_0000);
515 do_test_sanity_on_in_flight_opens(4);
516 do_test_sanity_on_in_flight_opens(4 | 0b1000_0000);
517 do_test_sanity_on_in_flight_opens(5);
518 do_test_sanity_on_in_flight_opens(5 | 0b1000_0000);
519 do_test_sanity_on_in_flight_opens(6);
520 do_test_sanity_on_in_flight_opens(6 | 0b1000_0000);
521 do_test_sanity_on_in_flight_opens(7);
522 do_test_sanity_on_in_flight_opens(7 | 0b1000_0000);
523 do_test_sanity_on_in_flight_opens(8);
524 do_test_sanity_on_in_flight_opens(8 | 0b1000_0000);
528 fn test_update_fee_vanilla() {
529 let chanmon_cfgs = create_chanmon_cfgs(2);
530 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
531 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
532 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
533 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
534 let channel_id = chan.2;
536 let feerate = get_feerate!(nodes[0], channel_id);
537 nodes[0].node.update_fee(channel_id, feerate+25).unwrap();
538 check_added_monitors!(nodes[0], 1);
540 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
541 assert_eq!(events_0.len(), 1);
542 let (update_msg, commitment_signed) = match events_0[0] {
543 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 } } => {
544 (update_fee.as_ref(), commitment_signed)
546 _ => panic!("Unexpected event"),
548 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
550 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
551 let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
552 check_added_monitors!(nodes[1], 1);
554 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
555 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
556 check_added_monitors!(nodes[0], 1);
558 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
559 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
560 // No commitment_signed so get_event_msg's assert(len == 1) passes
561 check_added_monitors!(nodes[0], 1);
563 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
564 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
565 check_added_monitors!(nodes[1], 1);
569 fn test_update_fee_that_funder_cannot_afford() {
570 let chanmon_cfgs = create_chanmon_cfgs(2);
571 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
572 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
573 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
574 let channel_value = 1888;
575 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000, InitFeatures::known(), InitFeatures::known());
576 let channel_id = chan.2;
579 nodes[0].node.update_fee(channel_id, feerate).unwrap();
580 check_added_monitors!(nodes[0], 1);
581 let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
583 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap());
585 commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
587 //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
588 //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
590 let commitment_tx = get_local_commitment_txn!(nodes[1], channel_id)[0].clone();
592 //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
593 let num_htlcs = commitment_tx.output.len() - 2;
594 let total_fee: u64 = feerate as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
595 let mut actual_fee = commitment_tx.output.iter().fold(0, |acc, output| acc + output.value);
596 actual_fee = channel_value - actual_fee;
597 assert_eq!(total_fee, actual_fee);
600 //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
601 //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
602 nodes[0].node.update_fee(channel_id, feerate+2).unwrap();
603 check_added_monitors!(nodes[0], 1);
605 let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
607 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap());
609 //While producing the commitment_signed response after handling a received update_fee request the
610 //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
611 //Should produce and error.
612 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed);
613 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Funding remote cannot afford proposed new fee".to_string(), 1);
614 check_added_monitors!(nodes[1], 1);
615 check_closed_broadcast!(nodes[1], true);
619 fn test_update_fee_with_fundee_update_add_htlc() {
620 let chanmon_cfgs = create_chanmon_cfgs(2);
621 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
622 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
623 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
624 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
625 let channel_id = chan.2;
626 let logger = test_utils::TestLogger::new();
629 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
631 let feerate = get_feerate!(nodes[0], channel_id);
632 nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
633 check_added_monitors!(nodes[0], 1);
635 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
636 assert_eq!(events_0.len(), 1);
637 let (update_msg, commitment_signed) = match events_0[0] {
638 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 } } => {
639 (update_fee.as_ref(), commitment_signed)
641 _ => panic!("Unexpected event"),
643 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
644 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
645 let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
646 check_added_monitors!(nodes[1], 1);
648 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[1]);
649 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
650 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();
652 // nothing happens since node[1] is in AwaitingRemoteRevoke
653 nodes[1].node.send_payment(&route, our_payment_hash, &None).unwrap();
655 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
656 assert_eq!(added_monitors.len(), 0);
657 added_monitors.clear();
659 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
660 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
661 // node[1] has nothing to do
663 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
664 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
665 check_added_monitors!(nodes[0], 1);
667 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
668 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
669 // No commitment_signed so get_event_msg's assert(len == 1) passes
670 check_added_monitors!(nodes[0], 1);
671 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
672 check_added_monitors!(nodes[1], 1);
673 // AwaitingRemoteRevoke ends here
675 let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
676 assert_eq!(commitment_update.update_add_htlcs.len(), 1);
677 assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
678 assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
679 assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
680 assert_eq!(commitment_update.update_fee.is_none(), true);
682 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]);
683 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
684 check_added_monitors!(nodes[0], 1);
685 let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
687 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke);
688 check_added_monitors!(nodes[1], 1);
689 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
691 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
692 check_added_monitors!(nodes[1], 1);
693 let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
694 // No commitment_signed so get_event_msg's assert(len == 1) passes
696 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke);
697 check_added_monitors!(nodes[0], 1);
698 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
700 expect_pending_htlcs_forwardable!(nodes[0]);
702 let events = nodes[0].node.get_and_clear_pending_events();
703 assert_eq!(events.len(), 1);
705 Event::PaymentReceived { .. } => { },
706 _ => panic!("Unexpected event"),
709 claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage, 800_000);
711 send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000, 800_000);
712 send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000, 800_000);
713 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
717 fn test_update_fee() {
718 let chanmon_cfgs = create_chanmon_cfgs(2);
719 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
720 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
721 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
722 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
723 let channel_id = chan.2;
726 // (1) update_fee/commitment_signed ->
727 // <- (2) revoke_and_ack
728 // .- send (3) commitment_signed
729 // (4) update_fee/commitment_signed ->
730 // .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
731 // <- (3) commitment_signed delivered
732 // send (6) revoke_and_ack -.
733 // <- (5) deliver revoke_and_ack
734 // (6) deliver revoke_and_ack ->
735 // .- send (7) commitment_signed in response to (4)
736 // <- (7) deliver commitment_signed
739 // Create and deliver (1)...
740 let feerate = get_feerate!(nodes[0], channel_id);
741 nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
742 check_added_monitors!(nodes[0], 1);
744 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
745 assert_eq!(events_0.len(), 1);
746 let (update_msg, commitment_signed) = match events_0[0] {
747 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 } } => {
748 (update_fee.as_ref(), commitment_signed)
750 _ => panic!("Unexpected event"),
752 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
754 // Generate (2) and (3):
755 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
756 let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
757 check_added_monitors!(nodes[1], 1);
760 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
761 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
762 check_added_monitors!(nodes[0], 1);
764 // Create and deliver (4)...
765 nodes[0].node.update_fee(channel_id, feerate+30).unwrap();
766 check_added_monitors!(nodes[0], 1);
767 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
768 assert_eq!(events_0.len(), 1);
769 let (update_msg, commitment_signed) = match events_0[0] {
770 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 } } => {
771 (update_fee.as_ref(), commitment_signed)
773 _ => panic!("Unexpected event"),
776 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
777 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
778 check_added_monitors!(nodes[1], 1);
780 let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
781 // No commitment_signed so get_event_msg's assert(len == 1) passes
783 // Handle (3), creating (6):
784 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0);
785 check_added_monitors!(nodes[0], 1);
786 let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
787 // No commitment_signed so get_event_msg's assert(len == 1) passes
790 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
791 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
792 check_added_monitors!(nodes[0], 1);
794 // Deliver (6), creating (7):
795 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0);
796 let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
797 assert!(commitment_update.update_add_htlcs.is_empty());
798 assert!(commitment_update.update_fulfill_htlcs.is_empty());
799 assert!(commitment_update.update_fail_htlcs.is_empty());
800 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
801 assert!(commitment_update.update_fee.is_none());
802 check_added_monitors!(nodes[1], 1);
805 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
806 check_added_monitors!(nodes[0], 1);
807 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
808 // No commitment_signed so get_event_msg's assert(len == 1) passes
810 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
811 check_added_monitors!(nodes[1], 1);
812 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
814 assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
815 assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
816 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
820 fn pre_funding_lock_shutdown_test() {
821 // Test sending a shutdown prior to funding_locked after funding generation
822 let chanmon_cfgs = create_chanmon_cfgs(2);
823 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
824 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
825 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
826 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0, InitFeatures::known(), InitFeatures::known());
827 mine_transaction(&nodes[0], &tx);
828 mine_transaction(&nodes[1], &tx);
830 nodes[0].node.close_channel(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id()).unwrap();
831 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
832 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
833 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
834 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
836 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
837 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
838 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
839 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
840 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
841 assert!(node_0_none.is_none());
843 assert!(nodes[0].node.list_channels().is_empty());
844 assert!(nodes[1].node.list_channels().is_empty());
848 fn updates_shutdown_wait() {
849 // Test sending a shutdown with outstanding updates pending
850 let chanmon_cfgs = create_chanmon_cfgs(3);
851 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
852 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
853 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
854 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
855 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
856 let logger = test_utils::TestLogger::new();
858 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
860 nodes[0].node.close_channel(&chan_1.2).unwrap();
861 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
862 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
863 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
864 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
866 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
867 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
869 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
871 let net_graph_msg_handler0 = &nodes[0].net_graph_msg_handler;
872 let net_graph_msg_handler1 = &nodes[1].net_graph_msg_handler;
873 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();
874 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();
875 unwrap_send_err!(nodes[0].node.send_payment(&route_1, payment_hash, &None), true, APIError::ChannelUnavailable {..}, {});
876 unwrap_send_err!(nodes[1].node.send_payment(&route_2, payment_hash, &None), true, APIError::ChannelUnavailable {..}, {});
878 assert!(nodes[2].node.claim_funds(our_payment_preimage, &None, 100_000));
879 check_added_monitors!(nodes[2], 1);
880 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
881 assert!(updates.update_add_htlcs.is_empty());
882 assert!(updates.update_fail_htlcs.is_empty());
883 assert!(updates.update_fail_malformed_htlcs.is_empty());
884 assert!(updates.update_fee.is_none());
885 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
886 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
887 check_added_monitors!(nodes[1], 1);
888 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
889 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
891 assert!(updates_2.update_add_htlcs.is_empty());
892 assert!(updates_2.update_fail_htlcs.is_empty());
893 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
894 assert!(updates_2.update_fee.is_none());
895 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
896 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
897 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
899 let events = nodes[0].node.get_and_clear_pending_events();
900 assert_eq!(events.len(), 1);
902 Event::PaymentSent { ref payment_preimage } => {
903 assert_eq!(our_payment_preimage, *payment_preimage);
905 _ => panic!("Unexpected event"),
908 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
909 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
910 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
911 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
912 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
913 assert!(node_0_none.is_none());
915 assert!(nodes[0].node.list_channels().is_empty());
917 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
918 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
919 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
920 assert!(nodes[1].node.list_channels().is_empty());
921 assert!(nodes[2].node.list_channels().is_empty());
925 fn htlc_fail_async_shutdown() {
926 // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
927 let chanmon_cfgs = create_chanmon_cfgs(3);
928 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
929 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
930 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
931 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
932 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
933 let logger = test_utils::TestLogger::new();
935 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
936 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
937 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();
938 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
939 check_added_monitors!(nodes[0], 1);
940 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
941 assert_eq!(updates.update_add_htlcs.len(), 1);
942 assert!(updates.update_fulfill_htlcs.is_empty());
943 assert!(updates.update_fail_htlcs.is_empty());
944 assert!(updates.update_fail_malformed_htlcs.is_empty());
945 assert!(updates.update_fee.is_none());
947 nodes[1].node.close_channel(&chan_1.2).unwrap();
948 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
949 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
950 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
952 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
953 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
954 check_added_monitors!(nodes[1], 1);
955 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
956 commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
958 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
959 assert!(updates_2.update_add_htlcs.is_empty());
960 assert!(updates_2.update_fulfill_htlcs.is_empty());
961 assert_eq!(updates_2.update_fail_htlcs.len(), 1);
962 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
963 assert!(updates_2.update_fee.is_none());
965 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
966 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
968 expect_payment_failed!(nodes[0], our_payment_hash, false);
970 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
971 assert_eq!(msg_events.len(), 2);
972 let node_0_closing_signed = match msg_events[0] {
973 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
974 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
977 _ => panic!("Unexpected event"),
979 match msg_events[1] {
980 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
981 assert_eq!(msg.contents.short_channel_id, chan_1.0.contents.short_channel_id);
983 _ => panic!("Unexpected event"),
986 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
987 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
988 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
989 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
990 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
991 assert!(node_0_none.is_none());
993 assert!(nodes[0].node.list_channels().is_empty());
995 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
996 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
997 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
998 assert!(nodes[1].node.list_channels().is_empty());
999 assert!(nodes[2].node.list_channels().is_empty());
1002 fn do_test_shutdown_rebroadcast(recv_count: u8) {
1003 // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
1004 // messages delivered prior to disconnect
1005 let chanmon_cfgs = create_chanmon_cfgs(3);
1006 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1007 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1008 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1009 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1010 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1012 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
1014 nodes[1].node.close_channel(&chan_1.2).unwrap();
1015 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1017 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
1018 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1020 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
1024 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1025 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1027 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1028 let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1029 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1030 let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1032 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
1033 let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1034 assert!(node_1_shutdown == node_1_2nd_shutdown);
1036 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
1037 let node_0_2nd_shutdown = if recv_count > 0 {
1038 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1039 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_2nd_shutdown);
1042 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1043 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_2nd_shutdown);
1044 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
1046 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_2nd_shutdown);
1048 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1049 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1051 assert!(nodes[2].node.claim_funds(our_payment_preimage, &None, 100_000));
1052 check_added_monitors!(nodes[2], 1);
1053 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1054 assert!(updates.update_add_htlcs.is_empty());
1055 assert!(updates.update_fail_htlcs.is_empty());
1056 assert!(updates.update_fail_malformed_htlcs.is_empty());
1057 assert!(updates.update_fee.is_none());
1058 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1059 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1060 check_added_monitors!(nodes[1], 1);
1061 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1062 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1064 assert!(updates_2.update_add_htlcs.is_empty());
1065 assert!(updates_2.update_fail_htlcs.is_empty());
1066 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
1067 assert!(updates_2.update_fee.is_none());
1068 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
1069 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
1070 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
1072 let events = nodes[0].node.get_and_clear_pending_events();
1073 assert_eq!(events.len(), 1);
1075 Event::PaymentSent { ref payment_preimage } => {
1076 assert_eq!(our_payment_preimage, *payment_preimage);
1078 _ => panic!("Unexpected event"),
1081 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1083 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1084 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1085 assert!(node_1_closing_signed.is_some());
1088 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1089 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1091 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1092 let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1093 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1094 if recv_count == 0 {
1095 // If all closing_signeds weren't delivered we can just resume where we left off...
1096 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1098 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
1099 let node_0_3rd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1100 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
1102 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1103 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1104 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
1106 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_3rd_shutdown);
1107 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1109 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_3rd_shutdown);
1110 let node_0_2nd_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1111 assert!(node_0_closing_signed == node_0_2nd_closing_signed);
1113 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
1114 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1115 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
1116 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1117 assert!(node_0_none.is_none());
1119 // If one node, however, received + responded with an identical closing_signed we end
1120 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
1121 // There isn't really anything better we can do simply, but in the future we might
1122 // explore storing a set of recently-closed channels that got disconnected during
1123 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
1124 // give our counterparty enough time to (potentially) broadcast a cooperative closing
1126 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1128 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1129 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
1130 assert_eq!(msg_events.len(), 1);
1131 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
1133 &ErrorAction::SendErrorMessage { ref msg } => {
1134 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msg);
1135 assert_eq!(msg.channel_id, chan_1.2);
1137 _ => panic!("Unexpected event!"),
1139 } else { panic!("Needed SendErrorMessage close"); }
1141 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
1142 // checks it, but in this case nodes[0] didn't ever get a chance to receive a
1143 // closing_signed so we do it ourselves
1144 check_closed_broadcast!(nodes[0], false);
1145 check_added_monitors!(nodes[0], 1);
1148 assert!(nodes[0].node.list_channels().is_empty());
1150 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1151 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1152 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1153 assert!(nodes[1].node.list_channels().is_empty());
1154 assert!(nodes[2].node.list_channels().is_empty());
1158 fn test_shutdown_rebroadcast() {
1159 do_test_shutdown_rebroadcast(0);
1160 do_test_shutdown_rebroadcast(1);
1161 do_test_shutdown_rebroadcast(2);
1165 fn fake_network_test() {
1166 // Simple test which builds a network of ChannelManagers, connects them to each other, and
1167 // tests that payments get routed and transactions broadcast in semi-reasonable ways.
1168 let chanmon_cfgs = create_chanmon_cfgs(4);
1169 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1170 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1171 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1173 // Create some initial channels
1174 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1175 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1176 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1178 // Rebalance the network a bit by relaying one payment through all the channels...
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);
1182 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1184 // Send some more payments
1185 send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000, 1_000_000);
1186 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000, 1_000_000);
1187 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000, 1_000_000);
1189 // Test failure packets
1190 let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
1191 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
1193 // Add a new channel that skips 3
1194 let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1196 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000, 1_000_000);
1197 send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000, 1_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);
1202 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1204 // Do some rebalance loop payments, simultaneously
1205 let mut hops = Vec::with_capacity(3);
1206 hops.push(RouteHop {
1207 pubkey: nodes[2].node.get_our_node_id(),
1208 node_features: NodeFeatures::empty(),
1209 short_channel_id: chan_2.0.contents.short_channel_id,
1210 channel_features: ChannelFeatures::empty(),
1212 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
1214 hops.push(RouteHop {
1215 pubkey: nodes[3].node.get_our_node_id(),
1216 node_features: NodeFeatures::empty(),
1217 short_channel_id: chan_3.0.contents.short_channel_id,
1218 channel_features: ChannelFeatures::empty(),
1220 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
1222 hops.push(RouteHop {
1223 pubkey: nodes[1].node.get_our_node_id(),
1224 node_features: NodeFeatures::empty(),
1225 short_channel_id: chan_4.0.contents.short_channel_id,
1226 channel_features: ChannelFeatures::empty(),
1228 cltv_expiry_delta: TEST_FINAL_CLTV,
1230 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;
1231 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;
1232 let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
1234 let mut hops = Vec::with_capacity(3);
1235 hops.push(RouteHop {
1236 pubkey: nodes[3].node.get_our_node_id(),
1237 node_features: NodeFeatures::empty(),
1238 short_channel_id: chan_4.0.contents.short_channel_id,
1239 channel_features: ChannelFeatures::empty(),
1241 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
1243 hops.push(RouteHop {
1244 pubkey: nodes[2].node.get_our_node_id(),
1245 node_features: NodeFeatures::empty(),
1246 short_channel_id: chan_3.0.contents.short_channel_id,
1247 channel_features: ChannelFeatures::empty(),
1249 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
1251 hops.push(RouteHop {
1252 pubkey: nodes[1].node.get_our_node_id(),
1253 node_features: NodeFeatures::empty(),
1254 short_channel_id: chan_2.0.contents.short_channel_id,
1255 channel_features: ChannelFeatures::empty(),
1257 cltv_expiry_delta: TEST_FINAL_CLTV,
1259 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;
1260 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;
1261 let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1263 // Claim the rebalances...
1264 fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1265 claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1, 1_000_000);
1267 // Add a duplicate new channel from 2 to 4
1268 let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1270 // Send some payments across both channels
1271 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1272 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1273 let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1276 route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
1277 let events = nodes[0].node.get_and_clear_pending_msg_events();
1278 assert_eq!(events.len(), 0);
1279 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);
1281 //TODO: Test that routes work again here as we've been notified that the channel is full
1283 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3, 3_000_000);
1284 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4, 3_000_000);
1285 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5, 3_000_000);
1287 // Close down the channels...
1288 close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1289 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1290 close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1291 close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1292 close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
1296 fn holding_cell_htlc_counting() {
1297 // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1298 // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1299 // commitment dance rounds.
1300 let chanmon_cfgs = create_chanmon_cfgs(3);
1301 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1302 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1303 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1304 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1305 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1306 let logger = test_utils::TestLogger::new();
1308 let mut payments = Vec::new();
1309 for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1310 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1311 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1312 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();
1313 nodes[1].node.send_payment(&route, payment_hash, &None).unwrap();
1314 payments.push((payment_preimage, payment_hash));
1316 check_added_monitors!(nodes[1], 1);
1318 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1319 assert_eq!(events.len(), 1);
1320 let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1321 assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1323 // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1324 // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1326 let (_, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
1328 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1329 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();
1330 unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash_1, &None), true, APIError::ChannelUnavailable { ref err },
1331 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
1332 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1333 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1336 // This should also be true if we try to forward a payment.
1337 let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
1339 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1340 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();
1341 nodes[0].node.send_payment(&route, payment_hash_2, &None).unwrap();
1342 check_added_monitors!(nodes[0], 1);
1345 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1346 assert_eq!(events.len(), 1);
1347 let payment_event = SendEvent::from_event(events.pop().unwrap());
1348 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1350 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1351 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1352 // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1353 // fails), the second will process the resulting failure and fail the HTLC backward.
1354 expect_pending_htlcs_forwardable!(nodes[1]);
1355 expect_pending_htlcs_forwardable!(nodes[1]);
1356 check_added_monitors!(nodes[1], 1);
1358 let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1359 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1360 commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1362 let events = nodes[0].node.get_and_clear_pending_msg_events();
1363 assert_eq!(events.len(), 1);
1365 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
1366 assert_eq!(msg.contents.short_channel_id, chan_2.0.contents.short_channel_id);
1368 _ => panic!("Unexpected event"),
1371 expect_payment_failed!(nodes[0], payment_hash_2, false);
1373 // Now forward all the pending HTLCs and claim them back
1374 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1375 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1376 check_added_monitors!(nodes[2], 1);
1378 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1379 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1380 check_added_monitors!(nodes[1], 1);
1381 let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1383 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1384 check_added_monitors!(nodes[1], 1);
1385 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1387 for ref update in as_updates.update_add_htlcs.iter() {
1388 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1390 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1391 check_added_monitors!(nodes[2], 1);
1392 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1393 check_added_monitors!(nodes[2], 1);
1394 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1396 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1397 check_added_monitors!(nodes[1], 1);
1398 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1399 check_added_monitors!(nodes[1], 1);
1400 let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1402 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1403 check_added_monitors!(nodes[2], 1);
1405 expect_pending_htlcs_forwardable!(nodes[2]);
1407 let events = nodes[2].node.get_and_clear_pending_events();
1408 assert_eq!(events.len(), payments.len());
1409 for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1411 &Event::PaymentReceived { ref payment_hash, .. } => {
1412 assert_eq!(*payment_hash, *hash);
1414 _ => panic!("Unexpected event"),
1418 for (preimage, _) in payments.drain(..) {
1419 claim_payment(&nodes[1], &[&nodes[2]], preimage, 100_000);
1422 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000, 1_000_000);
1426 fn duplicate_htlc_test() {
1427 // Test that we accept duplicate payment_hash HTLCs across the network and that
1428 // claiming/failing them are all separate and don't affect each other
1429 let chanmon_cfgs = create_chanmon_cfgs(6);
1430 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1431 let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1432 let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1434 // Create some initial channels to route via 3 to 4/5 from 0/1/2
1435 create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
1436 create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1437 create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1438 create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
1439 create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
1441 let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1443 *nodes[0].network_payment_count.borrow_mut() -= 1;
1444 assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1446 *nodes[0].network_payment_count.borrow_mut() -= 1;
1447 assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1449 claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage, 1_000_000);
1450 fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1451 claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage, 1_000_000);
1455 fn test_duplicate_htlc_different_direction_onchain() {
1456 // Test that ChannelMonitor doesn't generate 2 preimage txn
1457 // when we have 2 HTLCs with same preimage that go across a node
1458 // in opposite directions.
1459 let chanmon_cfgs = create_chanmon_cfgs(2);
1460 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1461 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1462 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1464 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1465 let logger = test_utils::TestLogger::new();
1468 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
1470 let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1472 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1473 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();
1474 send_along_route_with_hash(&nodes[1], route, &vec!(&nodes[0])[..], 800_000, payment_hash);
1476 // Provide preimage to node 0 by claiming payment
1477 nodes[0].node.claim_funds(payment_preimage, &None, 800_000);
1478 check_added_monitors!(nodes[0], 1);
1480 // Broadcast node 1 commitment txn
1481 let remote_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
1483 assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1484 let mut has_both_htlcs = 0; // check htlcs match ones committed
1485 for outp in remote_txn[0].output.iter() {
1486 if outp.value == 800_000 / 1000 {
1487 has_both_htlcs += 1;
1488 } else if outp.value == 900_000 / 1000 {
1489 has_both_htlcs += 1;
1492 assert_eq!(has_both_htlcs, 2);
1494 mine_transaction(&nodes[0], &remote_txn[0]);
1495 check_added_monitors!(nodes[0], 1);
1497 // Check we only broadcast 1 timeout tx
1498 let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1499 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()) };
1500 assert_eq!(claim_txn.len(), 5);
1501 check_spends!(claim_txn[2], chan_1.3);
1502 check_spends!(claim_txn[3], claim_txn[2]);
1503 assert_eq!(htlc_pair.0.input.len(), 1);
1504 assert_eq!(htlc_pair.0.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1505 check_spends!(htlc_pair.0, remote_txn[0]);
1506 assert_eq!(htlc_pair.1.input.len(), 1);
1507 assert_eq!(htlc_pair.1.input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1508 check_spends!(htlc_pair.1, remote_txn[0]);
1510 let events = nodes[0].node.get_and_clear_pending_msg_events();
1511 assert_eq!(events.len(), 2);
1514 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1515 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, .. } } => {
1516 assert!(update_add_htlcs.is_empty());
1517 assert!(update_fail_htlcs.is_empty());
1518 assert_eq!(update_fulfill_htlcs.len(), 1);
1519 assert!(update_fail_malformed_htlcs.is_empty());
1520 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1522 _ => panic!("Unexpected event"),
1528 fn test_basic_channel_reserve() {
1529 let chanmon_cfgs = create_chanmon_cfgs(2);
1530 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1531 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1532 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1533 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1534 let logger = test_utils::TestLogger::new();
1536 let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1537 let channel_reserve = chan_stat.channel_reserve_msat;
1539 // The 2* and +1 are for the fee spike reserve.
1540 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
1541 let commit_tx_fee = 2 * commit_tx_fee_msat(get_feerate!(nodes[0], chan.2), 1 + 1);
1542 let max_can_send = 5000000 - channel_reserve - commit_tx_fee;
1543 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1544 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();
1545 let err = nodes[0].node.send_payment(&route, our_payment_hash, &None).err().unwrap();
1547 PaymentSendFailure::AllFailedRetrySafe(ref fails) => {
1549 &APIError::ChannelUnavailable{ref err} =>
1550 assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)),
1551 _ => panic!("Unexpected error variant"),
1554 _ => panic!("Unexpected error variant"),
1556 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1557 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);
1559 send_payment(&nodes[0], &vec![&nodes[1]], max_can_send, max_can_send);
1563 fn test_fee_spike_violation_fails_htlc() {
1564 let chanmon_cfgs = create_chanmon_cfgs(2);
1565 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1566 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1567 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1568 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1569 let logger = test_utils::TestLogger::new();
1571 macro_rules! get_route_and_payment_hash {
1572 ($recv_value: expr) => {{
1573 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[1]);
1574 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler.network_graph.read().unwrap();
1575 let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes.last().unwrap().node.get_our_node_id(), None, None, &Vec::new(), $recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1576 (route, payment_hash, payment_preimage)
1580 let (route, payment_hash, _) = get_route_and_payment_hash!(3460001);
1581 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1582 let secp_ctx = Secp256k1::new();
1583 let session_priv = SecretKey::from_slice(&[42; 32]).expect("RNG is bad!");
1585 let cur_height = nodes[1].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1587 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1588 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3460001, &None, cur_height).unwrap();
1589 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1590 let msg = msgs::UpdateAddHTLC {
1593 amount_msat: htlc_msat,
1594 payment_hash: payment_hash,
1595 cltv_expiry: htlc_cltv,
1596 onion_routing_packet: onion_packet,
1599 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1601 // Now manually create the commitment_signed message corresponding to the update_add
1602 // nodes[0] just sent. In the code for construction of this message, "local" refers
1603 // to the sender of the message, and "remote" refers to the receiver.
1605 let feerate_per_kw = get_feerate!(nodes[0], chan.2);
1607 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
1609 // Get the EnforcingSigner for each channel, which will be used to (1) get the keys
1610 // needed to sign the new commitment tx and (2) sign the new commitment tx.
1611 let (local_revocation_basepoint, local_htlc_basepoint, local_secret, next_local_point) = {
1612 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
1613 let local_chan = chan_lock.by_id.get(&chan.2).unwrap();
1614 let chan_signer = local_chan.get_signer();
1615 let pubkeys = chan_signer.pubkeys();
1616 (pubkeys.revocation_basepoint, pubkeys.htlc_basepoint,
1617 chan_signer.release_commitment_secret(INITIAL_COMMITMENT_NUMBER),
1618 chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 2, &secp_ctx))
1620 let (remote_delayed_payment_basepoint, remote_htlc_basepoint,remote_point) = {
1621 let chan_lock = nodes[1].node.channel_state.lock().unwrap();
1622 let remote_chan = chan_lock.by_id.get(&chan.2).unwrap();
1623 let chan_signer = remote_chan.get_signer();
1624 let pubkeys = chan_signer.pubkeys();
1625 (pubkeys.delayed_payment_basepoint, pubkeys.htlc_basepoint,
1626 chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 1, &secp_ctx))
1629 // Assemble the set of keys we can use for signatures for our commitment_signed message.
1630 let commit_tx_keys = chan_utils::TxCreationKeys::derive_new(&secp_ctx, &remote_point, &remote_delayed_payment_basepoint,
1631 &remote_htlc_basepoint, &local_revocation_basepoint, &local_htlc_basepoint).unwrap();
1633 // Build the remote commitment transaction so we can sign it, and then later use the
1634 // signature for the commitment_signed message.
1635 let local_chan_balance = 1313;
1637 let accepted_htlc_info = chan_utils::HTLCOutputInCommitment {
1639 amount_msat: 3460001,
1640 cltv_expiry: htlc_cltv,
1642 transaction_output_index: Some(1),
1645 let commitment_number = INITIAL_COMMITMENT_NUMBER - 1;
1648 let local_chan_lock = nodes[0].node.channel_state.lock().unwrap();
1649 let local_chan = local_chan_lock.by_id.get(&chan.2).unwrap();
1650 let local_chan_signer = local_chan.get_signer();
1651 let commitment_tx = CommitmentTransaction::new_with_auxiliary_htlc_data(
1655 commit_tx_keys.clone(),
1657 &mut vec![(accepted_htlc_info, ())],
1658 &local_chan.channel_transaction_parameters.as_counterparty_broadcastable()
1660 local_chan_signer.sign_counterparty_commitment(&commitment_tx, &secp_ctx).unwrap()
1663 let commit_signed_msg = msgs::CommitmentSigned {
1666 htlc_signatures: res.1
1669 // Send the commitment_signed message to the nodes[1].
1670 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commit_signed_msg);
1671 let _ = nodes[1].node.get_and_clear_pending_msg_events();
1673 // Send the RAA to nodes[1].
1674 let raa_msg = msgs::RevokeAndACK {
1676 per_commitment_secret: local_secret,
1677 next_per_commitment_point: next_local_point
1679 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_msg);
1681 let events = nodes[1].node.get_and_clear_pending_msg_events();
1682 assert_eq!(events.len(), 1);
1683 // Make sure the HTLC failed in the way we expect.
1685 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, .. }, .. } => {
1686 assert_eq!(update_fail_htlcs.len(), 1);
1687 update_fail_htlcs[0].clone()
1689 _ => panic!("Unexpected event"),
1691 nodes[1].logger.assert_log("lightning::ln::channel".to_string(), "Attempting to fail HTLC due to fee spike buffer violation".to_string(), 1);
1693 check_added_monitors!(nodes[1], 2);
1697 fn test_chan_reserve_violation_outbound_htlc_inbound_chan() {
1698 let mut chanmon_cfgs = create_chanmon_cfgs(2);
1699 // Set the fee rate for the channel very high, to the point where the fundee
1700 // sending any above-dust amount would result in a channel reserve violation.
1701 // In this test we check that we would be prevented from sending an HTLC in
1703 chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1704 chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1705 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1706 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1707 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1708 let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1709 let logger = test_utils::TestLogger::new();
1711 macro_rules! get_route_and_payment_hash {
1712 ($recv_value: expr) => {{
1713 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[1]);
1714 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1715 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes.first().unwrap().node.get_our_node_id(), None, None, &Vec::new(), $recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1716 (route, payment_hash, payment_preimage)
1720 let (route, our_payment_hash, _) = get_route_and_payment_hash!(4843000);
1721 unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
1722 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1723 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1724 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);
1728 fn test_chan_reserve_violation_inbound_htlc_outbound_channel() {
1729 let mut chanmon_cfgs = create_chanmon_cfgs(2);
1730 // Set the fee rate for the channel very high, to the point where the funder
1731 // receiving 1 update_add_htlc would result in them closing the channel due
1732 // to channel reserve violation. This close could also happen if the fee went
1733 // up a more realistic amount, but many HTLCs were outstanding at the time of
1734 // the update_add_htlc.
1735 chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1736 chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1737 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1738 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1739 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1740 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1741 let logger = test_utils::TestLogger::new();
1743 macro_rules! get_route_and_payment_hash {
1744 ($recv_value: expr) => {{
1745 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[1]);
1746 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1747 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes.first().unwrap().node.get_our_node_id(), None, None, &Vec::new(), $recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1748 (route, payment_hash, payment_preimage)
1752 let (route, payment_hash, _) = get_route_and_payment_hash!(1000);
1753 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1754 let secp_ctx = Secp256k1::new();
1755 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1756 let cur_height = nodes[1].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1757 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1758 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 1000, &None, cur_height).unwrap();
1759 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1760 let msg = msgs::UpdateAddHTLC {
1763 amount_msat: htlc_msat + 1,
1764 payment_hash: payment_hash,
1765 cltv_expiry: htlc_cltv,
1766 onion_routing_packet: onion_packet,
1769 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &msg);
1770 // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1771 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);
1772 assert_eq!(nodes[0].node.list_channels().len(), 0);
1773 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
1774 assert_eq!(err_msg.data, "Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value");
1775 check_added_monitors!(nodes[0], 1);
1779 fn test_chan_reserve_dust_inbound_htlcs_outbound_chan() {
1780 // Test that if we receive many dust HTLCs over an outbound channel, they don't count when
1781 // calculating our commitment transaction fee (this was previously broken).
1782 let chanmon_cfgs = create_chanmon_cfgs(2);
1783 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1784 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1785 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1787 // Set nodes[0]'s balance such that they will consider any above-dust received HTLC to be a
1788 // channel reserve violation (so their balance is channel reserve (1000 sats) + commitment
1789 // transaction fee with 0 HTLCs (183 sats)).
1790 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98817000, InitFeatures::known(), InitFeatures::known());
1792 let dust_amt = 546000; // Dust amount
1793 // In the previous code, routing this dust payment would cause nodes[0] to perceive a channel
1794 // reserve violation even though it's a dust HTLC and therefore shouldn't count towards the
1795 // commitment transaction fee.
1796 let (_, _) = route_payment(&nodes[1], &[&nodes[0]], dust_amt);
1800 fn test_chan_reserve_dust_inbound_htlcs_inbound_chan() {
1801 // Test that if we receive many dust HTLCs over an inbound channel, they don't count when
1802 // calculating our counterparty's commitment transaction fee (this was previously broken).
1803 let chanmon_cfgs = create_chanmon_cfgs(2);
1804 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1805 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1806 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1807 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98000000, InitFeatures::known(), InitFeatures::known());
1809 let payment_amt = 46000; // Dust amount
1810 // In the previous code, these first four payments would succeed.
1811 let (_, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1812 let (_, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1813 let (_, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1814 let (_, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1816 // Then these next 5 would be interpreted by nodes[1] as violating the fee spike buffer.
1817 let (_, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1818 let (_, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1819 let (_, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1820 let (_, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1821 let (_, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1823 // And this last payment previously resulted in nodes[1] closing on its inbound-channel
1824 // counterparty, because it counted all the previous dust HTLCs against nodes[0]'s commitment
1825 // transaction fee and therefore perceived this next payment as a channel reserve violation.
1826 let (_, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1830 fn test_chan_reserve_violation_inbound_htlc_inbound_chan() {
1831 let chanmon_cfgs = create_chanmon_cfgs(3);
1832 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1833 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1834 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1835 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1836 let _ = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1837 let logger = test_utils::TestLogger::new();
1839 macro_rules! get_route_and_payment_hash {
1840 ($recv_value: expr) => {{
1841 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1842 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1843 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(), $recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1844 (route, payment_hash, payment_preimage)
1849 let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1850 let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1851 let feerate = get_feerate!(nodes[0], chan.2);
1853 // Add a 2* and +1 for the fee spike reserve.
1854 let commit_tx_fee_2_htlc = 2*commit_tx_fee_msat(feerate, 2 + 1);
1855 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;
1856 let amt_msat_1 = recv_value_1 + total_routing_fee_msat;
1858 // Add a pending HTLC.
1859 let (route_1, our_payment_hash_1, _) = get_route_and_payment_hash!(amt_msat_1);
1860 let payment_event_1 = {
1861 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &None).unwrap();
1862 check_added_monitors!(nodes[0], 1);
1864 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1865 assert_eq!(events.len(), 1);
1866 SendEvent::from_event(events.remove(0))
1868 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1870 // Attempt to trigger a channel reserve violation --> payment failure.
1871 let commit_tx_fee_2_htlcs = commit_tx_fee_msat(feerate, 2);
1872 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;
1873 let amt_msat_2 = recv_value_2 + total_routing_fee_msat;
1874 let (route_2, _, _) = get_route_and_payment_hash!(amt_msat_2);
1876 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1877 let secp_ctx = Secp256k1::new();
1878 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1879 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1880 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route_2.paths[0], &session_priv).unwrap();
1881 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route_2.paths[0], recv_value_2, &None, cur_height).unwrap();
1882 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash_1);
1883 let msg = msgs::UpdateAddHTLC {
1886 amount_msat: htlc_msat + 1,
1887 payment_hash: our_payment_hash_1,
1888 cltv_expiry: htlc_cltv,
1889 onion_routing_packet: onion_packet,
1892 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1893 // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1894 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote HTLC add would put them under remote reserve value".to_string(), 1);
1895 assert_eq!(nodes[1].node.list_channels().len(), 1);
1896 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1897 assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
1898 check_added_monitors!(nodes[1], 1);
1902 fn test_inbound_outbound_capacity_is_not_zero() {
1903 let chanmon_cfgs = create_chanmon_cfgs(2);
1904 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1905 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1906 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1907 let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1908 let channels0 = node_chanmgrs[0].list_channels();
1909 let channels1 = node_chanmgrs[1].list_channels();
1910 assert_eq!(channels0.len(), 1);
1911 assert_eq!(channels1.len(), 1);
1913 assert_eq!(channels0[0].inbound_capacity_msat, 95000000);
1914 assert_eq!(channels1[0].outbound_capacity_msat, 95000000);
1916 assert_eq!(channels0[0].outbound_capacity_msat, 100000 * 1000 - 95000000);
1917 assert_eq!(channels1[0].inbound_capacity_msat, 100000 * 1000 - 95000000);
1920 fn commit_tx_fee_msat(feerate: u32, num_htlcs: u64) -> u64 {
1921 (COMMITMENT_TX_BASE_WEIGHT + num_htlcs * COMMITMENT_TX_WEIGHT_PER_HTLC) * feerate as u64 / 1000 * 1000
1925 fn test_channel_reserve_holding_cell_htlcs() {
1926 let chanmon_cfgs = create_chanmon_cfgs(3);
1927 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1928 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1929 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1930 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1931 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1932 let logger = test_utils::TestLogger::new();
1934 let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1935 let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1937 let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1938 let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1940 macro_rules! get_route_and_payment_hash {
1941 ($recv_value: expr) => {{
1942 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1943 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1944 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(), $recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1945 (route, payment_hash, payment_preimage)
1949 macro_rules! expect_forward {
1951 let mut events = $node.node.get_and_clear_pending_msg_events();
1952 assert_eq!(events.len(), 1);
1953 check_added_monitors!($node, 1);
1954 let payment_event = SendEvent::from_event(events.remove(0));
1959 let feemsat = 239; // somehow we know?
1960 let total_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1961 let feerate = get_feerate!(nodes[0], chan_1.2);
1963 let recv_value_0 = stat01.counterparty_max_htlc_value_in_flight_msat - total_fee_msat;
1965 // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1967 let (mut route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_0);
1968 route.paths[0].last_mut().unwrap().fee_msat += 1;
1969 assert!(route.paths[0].iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1970 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
1971 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)));
1972 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1973 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);
1976 // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1977 // nodes[0]'s wealth
1979 let amt_msat = recv_value_0 + total_fee_msat;
1980 // 3 for the 3 HTLCs that will be sent, 2* and +1 for the fee spike reserve.
1981 // Also, ensure that each payment has enough to be over the dust limit to
1982 // ensure it'll be included in each commit tx fee calculation.
1983 let commit_tx_fee_all_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1984 let ensure_htlc_amounts_above_dust_buffer = 3 * (stat01.counterparty_dust_limit_msat + 1000);
1985 if stat01.value_to_self_msat < stat01.channel_reserve_msat + commit_tx_fee_all_htlcs + ensure_htlc_amounts_above_dust_buffer + amt_msat {
1988 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0, recv_value_0);
1990 let (stat01_, stat11_, stat12_, stat22_) = (
1991 get_channel_value_stat!(nodes[0], chan_1.2),
1992 get_channel_value_stat!(nodes[1], chan_1.2),
1993 get_channel_value_stat!(nodes[1], chan_2.2),
1994 get_channel_value_stat!(nodes[2], chan_2.2),
1997 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1998 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1999 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
2000 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
2001 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
2004 // adding pending output.
2005 // 2* and +1 HTLCs on the commit tx fee for the fee spike reserve.
2006 // The reason we're dividing by two here is as follows: the dividend is the total outbound liquidity
2007 // after fees, the channel reserve, and the fee spike buffer are removed. We eventually want to
2008 // divide this quantity into 3 portions, that will each be sent in an HTLC. This allows us
2009 // to test channel channel reserve policy at the edges of what amount is sendable, i.e.
2010 // cases where 1 msat over X amount will cause a payment failure, but anything less than
2011 // that can be sent successfully. So, dividing by two is a somewhat arbitrary way of getting
2012 // the amount of the first of these aforementioned 3 payments. The reason we split into 3 payments
2013 // is to test the behavior of the holding cell with respect to channel reserve and commit tx fee
2015 let commit_tx_fee_2_htlcs = 2*commit_tx_fee_msat(feerate, 2 + 1);
2016 let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs)/2;
2017 let amt_msat_1 = recv_value_1 + total_fee_msat;
2019 let (route_1, our_payment_hash_1, our_payment_preimage_1) = get_route_and_payment_hash!(recv_value_1);
2020 let payment_event_1 = {
2021 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &None).unwrap();
2022 check_added_monitors!(nodes[0], 1);
2024 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2025 assert_eq!(events.len(), 1);
2026 SendEvent::from_event(events.remove(0))
2028 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
2030 // channel reserve test with htlc pending output > 0
2031 let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs;
2033 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
2034 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
2035 assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
2036 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2039 // split the rest to test holding cell
2040 let commit_tx_fee_3_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
2041 let additional_htlc_cost_msat = commit_tx_fee_3_htlcs - commit_tx_fee_2_htlcs;
2042 let recv_value_21 = recv_value_2/2 - additional_htlc_cost_msat/2;
2043 let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat - additional_htlc_cost_msat;
2045 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
2046 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);
2049 // now see if they go through on both sides
2050 let (route_21, our_payment_hash_21, our_payment_preimage_21) = get_route_and_payment_hash!(recv_value_21);
2051 // but this will stuck in the holding cell
2052 nodes[0].node.send_payment(&route_21, our_payment_hash_21, &None).unwrap();
2053 check_added_monitors!(nodes[0], 0);
2054 let events = nodes[0].node.get_and_clear_pending_events();
2055 assert_eq!(events.len(), 0);
2057 // test with outbound holding cell amount > 0
2059 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_22+1);
2060 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
2061 assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
2062 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2063 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);
2066 let (route_22, our_payment_hash_22, our_payment_preimage_22) = get_route_and_payment_hash!(recv_value_22);
2067 // this will also stuck in the holding cell
2068 nodes[0].node.send_payment(&route_22, our_payment_hash_22, &None).unwrap();
2069 check_added_monitors!(nodes[0], 0);
2070 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
2071 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2073 // flush the pending htlc
2074 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
2075 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2076 check_added_monitors!(nodes[1], 1);
2078 // the pending htlc should be promoted to committed
2079 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
2080 check_added_monitors!(nodes[0], 1);
2081 let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2083 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
2084 let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2085 // No commitment_signed so get_event_msg's assert(len == 1) passes
2086 check_added_monitors!(nodes[0], 1);
2088 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
2089 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2090 check_added_monitors!(nodes[1], 1);
2092 expect_pending_htlcs_forwardable!(nodes[1]);
2094 let ref payment_event_11 = expect_forward!(nodes[1]);
2095 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
2096 commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
2098 expect_pending_htlcs_forwardable!(nodes[2]);
2099 expect_payment_received!(nodes[2], our_payment_hash_1, recv_value_1);
2101 // flush the htlcs in the holding cell
2102 assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
2103 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
2104 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
2105 commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
2106 expect_pending_htlcs_forwardable!(nodes[1]);
2108 let ref payment_event_3 = expect_forward!(nodes[1]);
2109 assert_eq!(payment_event_3.msgs.len(), 2);
2110 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
2111 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
2113 commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
2114 expect_pending_htlcs_forwardable!(nodes[2]);
2116 let events = nodes[2].node.get_and_clear_pending_events();
2117 assert_eq!(events.len(), 2);
2119 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
2120 assert_eq!(our_payment_hash_21, *payment_hash);
2121 assert_eq!(*payment_secret, None);
2122 assert_eq!(recv_value_21, amt);
2124 _ => panic!("Unexpected event"),
2127 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
2128 assert_eq!(our_payment_hash_22, *payment_hash);
2129 assert_eq!(None, *payment_secret);
2130 assert_eq!(recv_value_22, amt);
2132 _ => panic!("Unexpected event"),
2135 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1, recv_value_1);
2136 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21, recv_value_21);
2137 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22, recv_value_22);
2139 let commit_tx_fee_0_htlcs = 2*commit_tx_fee_msat(feerate, 1);
2140 let recv_value_3 = commit_tx_fee_2_htlcs - commit_tx_fee_0_htlcs - total_fee_msat;
2141 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_3, recv_value_3);
2143 let commit_tx_fee_1_htlc = 2*commit_tx_fee_msat(feerate, 1 + 1);
2144 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);
2145 let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
2146 assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
2147 assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat + commit_tx_fee_1_htlc);
2149 let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
2150 assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22 + recv_value_3);
2154 fn channel_reserve_in_flight_removes() {
2155 // In cases where one side claims an HTLC, it thinks it has additional available funds that it
2156 // can send to its counterparty, but due to update ordering, the other side may not yet have
2157 // considered those HTLCs fully removed.
2158 // This tests that we don't count HTLCs which will not be included in the next remote
2159 // commitment transaction towards the reserve value (as it implies no commitment transaction
2160 // will be generated which violates the remote reserve value).
2161 // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
2163 // * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
2164 // you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
2165 // you only consider the value of the first HTLC, it may not),
2166 // * start routing a third HTLC from A to B,
2167 // * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
2168 // the other claim in its holding cell, as it immediately goes into AwaitingRAA),
2169 // * deliver the first fulfill from B
2170 // * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
2172 // * deliver A's response CS and RAA.
2173 // This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
2174 // removed it fully. B now has the push_msat plus the first two HTLCs in value.
2175 // * Now B happily sends another HTLC, potentially violating its reserve value from A's point
2176 // of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
2177 let chanmon_cfgs = create_chanmon_cfgs(2);
2178 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2179 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2180 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2181 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2182 let logger = test_utils::TestLogger::new();
2184 let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
2185 // Route the first two HTLCs.
2186 let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
2187 let (payment_preimage_2, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
2189 // Start routing the third HTLC (this is just used to get everyone in the right state).
2190 let (payment_preimage_3, payment_hash_3) = get_payment_preimage_hash!(nodes[0]);
2192 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
2193 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();
2194 nodes[0].node.send_payment(&route, payment_hash_3, &None).unwrap();
2195 check_added_monitors!(nodes[0], 1);
2196 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2197 assert_eq!(events.len(), 1);
2198 SendEvent::from_event(events.remove(0))
2201 // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
2202 // initial fulfill/CS.
2203 assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000));
2204 check_added_monitors!(nodes[1], 1);
2205 let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2207 // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
2208 // remove the second HTLC when we send the HTLC back from B to A.
2209 assert!(nodes[1].node.claim_funds(payment_preimage_2, &None, 20000));
2210 check_added_monitors!(nodes[1], 1);
2211 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2213 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
2214 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
2215 check_added_monitors!(nodes[0], 1);
2216 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2217 expect_payment_sent!(nodes[0], payment_preimage_1);
2219 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
2220 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
2221 check_added_monitors!(nodes[1], 1);
2222 // B is already AwaitingRAA, so cant generate a CS here
2223 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2225 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2226 check_added_monitors!(nodes[1], 1);
2227 let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2229 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2230 check_added_monitors!(nodes[0], 1);
2231 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2233 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2234 check_added_monitors!(nodes[1], 1);
2235 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2237 // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
2238 // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
2239 // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
2240 // can no longer broadcast a commitment transaction with it and B has the preimage so can go
2241 // on-chain as necessary).
2242 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
2243 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
2244 check_added_monitors!(nodes[0], 1);
2245 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2246 expect_payment_sent!(nodes[0], payment_preimage_2);
2248 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2249 check_added_monitors!(nodes[1], 1);
2250 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2252 expect_pending_htlcs_forwardable!(nodes[1]);
2253 expect_payment_received!(nodes[1], payment_hash_3, 100000);
2255 // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
2256 // resolve the second HTLC from A's point of view.
2257 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2258 check_added_monitors!(nodes[0], 1);
2259 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2261 // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
2262 // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
2263 let (payment_preimage_4, payment_hash_4) = get_payment_preimage_hash!(nodes[1]);
2265 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
2266 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();
2267 nodes[1].node.send_payment(&route, payment_hash_4, &None).unwrap();
2268 check_added_monitors!(nodes[1], 1);
2269 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
2270 assert_eq!(events.len(), 1);
2271 SendEvent::from_event(events.remove(0))
2274 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
2275 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
2276 check_added_monitors!(nodes[0], 1);
2277 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2279 // Now just resolve all the outstanding messages/HTLCs for completeness...
2281 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2282 check_added_monitors!(nodes[1], 1);
2283 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2285 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2286 check_added_monitors!(nodes[1], 1);
2288 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2289 check_added_monitors!(nodes[0], 1);
2290 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2292 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2293 check_added_monitors!(nodes[1], 1);
2294 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2296 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2297 check_added_monitors!(nodes[0], 1);
2299 expect_pending_htlcs_forwardable!(nodes[0]);
2300 expect_payment_received!(nodes[0], payment_hash_4, 10000);
2302 claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4, 10_000);
2303 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3, 100_000);
2307 fn channel_monitor_network_test() {
2308 // Simple test which builds a network of ChannelManagers, connects them to each other, and
2309 // tests that ChannelMonitor is able to recover from various states.
2310 let chanmon_cfgs = create_chanmon_cfgs(5);
2311 let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
2312 let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
2313 let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
2315 // Create some initial channels
2316 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2317 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2318 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
2319 let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
2321 // Make sure all nodes are at the same starting height
2322 connect_blocks(&nodes[0], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1, nodes[0].best_block_info().1, false, Default::default());
2323 connect_blocks(&nodes[1], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1, nodes[1].best_block_info().1, false, Default::default());
2324 connect_blocks(&nodes[2], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1, nodes[2].best_block_info().1, false, Default::default());
2325 connect_blocks(&nodes[3], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[3].best_block_info().1, nodes[3].best_block_info().1, false, Default::default());
2326 connect_blocks(&nodes[4], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[4].best_block_info().1, nodes[4].best_block_info().1, false, Default::default());
2328 // Rebalance the network a bit by relaying one payment through all the channels...
2329 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2330 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2331 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2332 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2334 // Simple case with no pending HTLCs:
2335 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
2336 check_added_monitors!(nodes[1], 1);
2338 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
2339 assert_eq!(node_txn.len(), 1);
2340 mine_transaction(&nodes[0], &node_txn[0]);
2341 check_added_monitors!(nodes[0], 1);
2342 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
2344 get_announce_close_broadcast_events(&nodes, 0, 1);
2345 assert_eq!(nodes[0].node.list_channels().len(), 0);
2346 assert_eq!(nodes[1].node.list_channels().len(), 1);
2348 // One pending HTLC is discarded by the force-close:
2349 let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
2351 // Simple case of one pending HTLC to HTLC-Timeout
2352 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
2353 check_added_monitors!(nodes[1], 1);
2355 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
2356 mine_transaction(&nodes[2], &node_txn[0]);
2357 check_added_monitors!(nodes[2], 1);
2358 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
2360 get_announce_close_broadcast_events(&nodes, 1, 2);
2361 assert_eq!(nodes[1].node.list_channels().len(), 0);
2362 assert_eq!(nodes[2].node.list_channels().len(), 1);
2364 macro_rules! claim_funds {
2365 ($node: expr, $prev_node: expr, $preimage: expr, $amount: expr) => {
2367 assert!($node.node.claim_funds($preimage, &None, $amount));
2368 check_added_monitors!($node, 1);
2370 let events = $node.node.get_and_clear_pending_msg_events();
2371 assert_eq!(events.len(), 1);
2373 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2374 assert!(update_add_htlcs.is_empty());
2375 assert!(update_fail_htlcs.is_empty());
2376 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2378 _ => panic!("Unexpected event"),
2384 // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2385 // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2386 nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2387 check_added_monitors!(nodes[2], 1);
2388 let node2_commitment_txid;
2390 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2391 node2_commitment_txid = node_txn[0].txid();
2393 // Claim the payment on nodes[3], giving it knowledge of the preimage
2394 claim_funds!(nodes[3], nodes[2], payment_preimage_1, 3_000_000);
2395 mine_transaction(&nodes[3], &node_txn[0]);
2396 check_added_monitors!(nodes[3], 1);
2397 check_preimage_claim(&nodes[3], &node_txn);
2399 get_announce_close_broadcast_events(&nodes, 2, 3);
2400 assert_eq!(nodes[2].node.list_channels().len(), 0);
2401 assert_eq!(nodes[3].node.list_channels().len(), 1);
2403 // Drop the ChannelMonitor for the previous channel to avoid it broadcasting transactions and
2404 // confusing us in the following tests.
2405 let chan_3_mon = nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().remove(&OutPoint { txid: chan_3.3.txid(), index: 0 }).unwrap();
2407 // One pending HTLC to time out:
2408 let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2409 // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2412 let (close_chan_update_1, close_chan_update_2) = {
2413 connect_blocks(&nodes[3], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1, nodes[3].best_block_info().1, false, Default::default());
2414 let events = nodes[3].node.get_and_clear_pending_msg_events();
2415 assert_eq!(events.len(), 1);
2416 let close_chan_update_1 = match events[0] {
2417 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2420 _ => panic!("Unexpected event"),
2422 check_added_monitors!(nodes[3], 1);
2424 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2426 let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2427 node_txn.retain(|tx| {
2428 if tx.input[0].previous_output.txid == node2_commitment_txid {
2434 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2436 // Claim the payment on nodes[4], giving it knowledge of the preimage
2437 claim_funds!(nodes[4], nodes[3], payment_preimage_2, 3_000_000);
2439 connect_blocks(&nodes[4], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + 2, nodes[4].best_block_info().1, false, Default::default());
2440 let events = nodes[4].node.get_and_clear_pending_msg_events();
2441 assert_eq!(events.len(), 1);
2442 let close_chan_update_2 = match events[0] {
2443 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2446 _ => panic!("Unexpected event"),
2448 check_added_monitors!(nodes[4], 1);
2449 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2451 mine_transaction(&nodes[4], &node_txn[0]);
2452 check_preimage_claim(&nodes[4], &node_txn);
2453 (close_chan_update_1, close_chan_update_2)
2455 nodes[3].net_graph_msg_handler.handle_channel_update(&close_chan_update_2).unwrap();
2456 nodes[4].net_graph_msg_handler.handle_channel_update(&close_chan_update_1).unwrap();
2457 assert_eq!(nodes[3].node.list_channels().len(), 0);
2458 assert_eq!(nodes[4].node.list_channels().len(), 0);
2460 nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().insert(OutPoint { txid: chan_3.3.txid(), index: 0 }, chan_3_mon);
2464 fn test_justice_tx() {
2465 // Test justice txn built on revoked HTLC-Success tx, against both sides
2466 let mut alice_config = UserConfig::default();
2467 alice_config.channel_options.announced_channel = true;
2468 alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2469 alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2470 let mut bob_config = UserConfig::default();
2471 bob_config.channel_options.announced_channel = true;
2472 bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2473 bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2474 let user_cfgs = [Some(alice_config), Some(bob_config)];
2475 let mut chanmon_cfgs = create_chanmon_cfgs(2);
2476 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2477 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
2478 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2479 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2480 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2481 // Create some new channels:
2482 let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2484 // A pending HTLC which will be revoked:
2485 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2486 // Get the will-be-revoked local txn from nodes[0]
2487 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2488 assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2489 assert_eq!(revoked_local_txn[0].input.len(), 1);
2490 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2491 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2492 assert_eq!(revoked_local_txn[1].input.len(), 1);
2493 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2494 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2495 // Revoke the old state
2496 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 3_000_000);
2499 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2501 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2502 assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2503 assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2505 check_spends!(node_txn[0], revoked_local_txn[0]);
2506 node_txn.swap_remove(0);
2507 node_txn.truncate(1);
2509 check_added_monitors!(nodes[1], 1);
2510 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2512 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2513 // Verify broadcast of revoked HTLC-timeout
2514 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2515 check_added_monitors!(nodes[0], 1);
2516 // Broadcast revoked HTLC-timeout on node 1
2517 mine_transaction(&nodes[1], &node_txn[1]);
2518 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2520 get_announce_close_broadcast_events(&nodes, 0, 1);
2522 assert_eq!(nodes[0].node.list_channels().len(), 0);
2523 assert_eq!(nodes[1].node.list_channels().len(), 0);
2525 // We test justice_tx build by A on B's revoked HTLC-Success tx
2526 // Create some new channels:
2527 let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2529 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2533 // A pending HTLC which will be revoked:
2534 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2535 // Get the will-be-revoked local txn from B
2536 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2537 assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2538 assert_eq!(revoked_local_txn[0].input.len(), 1);
2539 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2540 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2541 // Revoke the old state
2542 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4, 3_000_000);
2544 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2546 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2547 assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2548 assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2550 check_spends!(node_txn[0], revoked_local_txn[0]);
2551 node_txn.swap_remove(0);
2553 check_added_monitors!(nodes[0], 1);
2554 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2556 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2557 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2558 check_added_monitors!(nodes[1], 1);
2559 mine_transaction(&nodes[0], &node_txn[1]);
2560 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2562 get_announce_close_broadcast_events(&nodes, 0, 1);
2563 assert_eq!(nodes[0].node.list_channels().len(), 0);
2564 assert_eq!(nodes[1].node.list_channels().len(), 0);
2568 fn revoked_output_claim() {
2569 // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2570 // transaction is broadcast by its counterparty
2571 let chanmon_cfgs = create_chanmon_cfgs(2);
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);
2575 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2576 // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2577 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2578 assert_eq!(revoked_local_txn.len(), 1);
2579 // Only output is the full channel value back to nodes[0]:
2580 assert_eq!(revoked_local_txn[0].output.len(), 1);
2581 // Send a payment through, updating everyone's latest commitment txn
2582 send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000, 5_000_000);
2584 // Inform nodes[1] that nodes[0] broadcast a stale tx
2585 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2586 check_added_monitors!(nodes[1], 1);
2587 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2588 assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2590 check_spends!(node_txn[0], revoked_local_txn[0]);
2591 check_spends!(node_txn[1], chan_1.3);
2593 // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2594 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2595 get_announce_close_broadcast_events(&nodes, 0, 1);
2596 check_added_monitors!(nodes[0], 1)
2600 fn claim_htlc_outputs_shared_tx() {
2601 // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2602 let mut chanmon_cfgs = create_chanmon_cfgs(2);
2603 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2604 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2605 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2606 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2608 // Create some new channel:
2609 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2611 // Rebalance the network to generate htlc in the two directions
2612 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2613 // 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
2614 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2615 let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2617 // Get the will-be-revoked local txn from node[0]
2618 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2619 assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2620 assert_eq!(revoked_local_txn[0].input.len(), 1);
2621 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2622 assert_eq!(revoked_local_txn[1].input.len(), 1);
2623 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2624 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2625 check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2627 //Revoke the old state
2628 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2631 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2632 check_added_monitors!(nodes[0], 1);
2633 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2634 check_added_monitors!(nodes[1], 1);
2635 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, CHAN_CONFIRM_DEPTH + 1, false, Default::default());
2636 expect_payment_failed!(nodes[1], payment_hash_2, true);
2638 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2639 assert_eq!(node_txn.len(), 3); // ChannelMonitor: penalty tx, ChannelManager: local commitment + HTLC-timeout
2641 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2642 check_spends!(node_txn[0], revoked_local_txn[0]);
2644 let mut witness_lens = BTreeSet::new();
2645 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2646 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2647 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2648 assert_eq!(witness_lens.len(), 3);
2649 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2650 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2651 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2653 // Next nodes[1] broadcasts its current local tx state:
2654 assert_eq!(node_txn[1].input.len(), 1);
2655 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2657 assert_eq!(node_txn[2].input.len(), 1);
2658 let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
2659 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2660 assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
2661 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2662 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
2664 get_announce_close_broadcast_events(&nodes, 0, 1);
2665 assert_eq!(nodes[0].node.list_channels().len(), 0);
2666 assert_eq!(nodes[1].node.list_channels().len(), 0);
2670 fn claim_htlc_outputs_single_tx() {
2671 // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2672 let mut chanmon_cfgs = create_chanmon_cfgs(2);
2673 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2674 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2675 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2676 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2678 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2680 // Rebalance the network to generate htlc in the two directions
2681 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2682 // 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
2683 // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2684 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2685 let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2687 // Get the will-be-revoked local txn from node[0]
2688 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2690 //Revoke the old state
2691 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2694 confirm_transaction_at(&nodes[0], &revoked_local_txn[0], 100);
2695 check_added_monitors!(nodes[0], 1);
2696 confirm_transaction_at(&nodes[1], &revoked_local_txn[0], 100);
2697 check_added_monitors!(nodes[1], 1);
2698 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
2700 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, nodes[1].best_block_info().1, false, Default::default());
2701 expect_payment_failed!(nodes[1], payment_hash_2, true);
2703 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2704 assert_eq!(node_txn.len(), 9);
2705 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2706 // ChannelManager: local commmitment + local HTLC-timeout (2)
2707 // 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)
2708 // ChannelMonitor: local commitment + local HTLC-timeout (2)
2710 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2711 assert_eq!(node_txn[0].input.len(), 1);
2712 check_spends!(node_txn[0], chan_1.3);
2713 assert_eq!(node_txn[1].input.len(), 1);
2714 let witness_script = node_txn[1].input[0].witness.last().unwrap();
2715 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2716 check_spends!(node_txn[1], node_txn[0]);
2718 // Justice transactions are indices 1-2-4
2719 assert_eq!(node_txn[2].input.len(), 1);
2720 assert_eq!(node_txn[3].input.len(), 1);
2721 assert_eq!(node_txn[4].input.len(), 1);
2723 check_spends!(node_txn[2], revoked_local_txn[0]);
2724 check_spends!(node_txn[3], revoked_local_txn[0]);
2725 check_spends!(node_txn[4], revoked_local_txn[0]);
2727 let mut witness_lens = BTreeSet::new();
2728 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2729 witness_lens.insert(node_txn[3].input[0].witness.last().unwrap().len());
2730 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2731 assert_eq!(witness_lens.len(), 3);
2732 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2733 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2734 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2736 get_announce_close_broadcast_events(&nodes, 0, 1);
2737 assert_eq!(nodes[0].node.list_channels().len(), 0);
2738 assert_eq!(nodes[1].node.list_channels().len(), 0);
2742 fn test_htlc_on_chain_success() {
2743 // Test that in case of a unilateral close onchain, we detect the state of output and pass
2744 // the preimage backward accordingly. So here we test that ChannelManager is
2745 // broadcasting the right event to other nodes in payment path.
2746 // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2747 // A --------------------> B ----------------------> C (preimage)
2748 // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2749 // commitment transaction was broadcast.
2750 // Then, B should learn the preimage from said transactions, attempting to claim backwards
2752 // B should be able to claim via preimage if A then broadcasts its local tx.
2753 // Finally, when A sees B's latest local commitment transaction it should be able to claim
2754 // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2755 // PaymentSent event).
2757 let chanmon_cfgs = create_chanmon_cfgs(3);
2758 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2759 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2760 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2762 // Create some initial channels
2763 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2764 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2766 // Rebalance the network a bit by relaying one payment through all the channels...
2767 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2768 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2770 let (our_payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2771 let (our_payment_preimage_2, _payment_hash_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2773 // Broadcast legit commitment tx from C on B's chain
2774 // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2775 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2776 assert_eq!(commitment_tx.len(), 1);
2777 check_spends!(commitment_tx[0], chan_2.3);
2778 nodes[2].node.claim_funds(our_payment_preimage, &None, 3_000_000);
2779 nodes[2].node.claim_funds(our_payment_preimage_2, &None, 3_000_000);
2780 check_added_monitors!(nodes[2], 2);
2781 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2782 assert!(updates.update_add_htlcs.is_empty());
2783 assert!(updates.update_fail_htlcs.is_empty());
2784 assert!(updates.update_fail_malformed_htlcs.is_empty());
2785 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2787 mine_transaction(&nodes[2], &commitment_tx[0]);
2788 check_closed_broadcast!(nodes[2], false);
2789 check_added_monitors!(nodes[2], 1);
2790 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)
2791 assert_eq!(node_txn.len(), 5);
2792 assert_eq!(node_txn[0], node_txn[3]);
2793 assert_eq!(node_txn[1], node_txn[4]);
2794 assert_eq!(node_txn[2], commitment_tx[0]);
2795 check_spends!(node_txn[0], commitment_tx[0]);
2796 check_spends!(node_txn[1], commitment_tx[0]);
2797 assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2798 assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2799 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2800 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2801 assert_eq!(node_txn[0].lock_time, 0);
2802 assert_eq!(node_txn[1].lock_time, 0);
2804 // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2805 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2806 connect_block(&nodes[1], &Block { header, txdata: node_txn}, nodes[1].best_block_info().1 + 1);
2808 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2809 assert_eq!(added_monitors.len(), 1);
2810 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2811 added_monitors.clear();
2813 let events = nodes[1].node.get_and_clear_pending_msg_events();
2815 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2816 assert_eq!(added_monitors.len(), 2);
2817 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2818 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2819 added_monitors.clear();
2821 assert_eq!(events.len(), 2);
2823 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2824 _ => panic!("Unexpected event"),
2827 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, .. } } => {
2828 assert!(update_add_htlcs.is_empty());
2829 assert!(update_fail_htlcs.is_empty());
2830 assert_eq!(update_fulfill_htlcs.len(), 1);
2831 assert!(update_fail_malformed_htlcs.is_empty());
2832 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2834 _ => panic!("Unexpected event"),
2836 macro_rules! check_tx_local_broadcast {
2837 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2838 let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2839 assert_eq!(node_txn.len(), 5);
2840 // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2841 // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout
2842 check_spends!(node_txn[0], $commitment_tx);
2843 check_spends!(node_txn[1], $commitment_tx);
2844 assert_ne!(node_txn[0].lock_time, 0);
2845 assert_ne!(node_txn[1].lock_time, 0);
2847 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2848 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2849 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2850 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2852 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2853 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2854 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2855 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2857 check_spends!(node_txn[2], $chan_tx);
2858 check_spends!(node_txn[3], node_txn[2]);
2859 check_spends!(node_txn[4], node_txn[2]);
2860 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), 71);
2861 assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2862 assert_eq!(node_txn[4].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2863 assert!(node_txn[3].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2864 assert!(node_txn[4].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2865 assert_ne!(node_txn[3].lock_time, 0);
2866 assert_ne!(node_txn[4].lock_time, 0);
2870 // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2871 // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2872 // timeout-claim of the output that nodes[2] just claimed via success.
2873 check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2875 // Broadcast legit commitment tx from A on B's chain
2876 // Broadcast preimage tx by B on offered output from A commitment tx on A's chain
2877 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2878 check_spends!(commitment_tx[0], chan_1.3);
2879 mine_transaction(&nodes[1], &commitment_tx[0]);
2880 check_closed_broadcast!(nodes[1], false);
2881 check_added_monitors!(nodes[1], 1);
2882 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 1 (HTLC-Success)
2883 assert_eq!(node_txn.len(), 4);
2884 check_spends!(node_txn[0], commitment_tx[0]);
2885 assert_eq!(node_txn[0].input.len(), 2);
2886 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2887 assert_eq!(node_txn[0].input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2888 assert_eq!(node_txn[0].lock_time, 0);
2889 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2890 check_spends!(node_txn[1], chan_1.3);
2891 assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2892 check_spends!(node_txn[2], node_txn[1]);
2893 check_spends!(node_txn[3], node_txn[1]);
2894 // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2895 // we already checked the same situation with A.
2897 // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2898 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2899 connect_block(&nodes[0], &Block { header, txdata: vec![commitment_tx[0].clone(), node_txn[0].clone()] }, nodes[0].best_block_info().1 + 1);
2900 check_closed_broadcast!(nodes[0], false);
2901 check_added_monitors!(nodes[0], 1);
2902 let events = nodes[0].node.get_and_clear_pending_events();
2903 assert_eq!(events.len(), 2);
2904 let mut first_claimed = false;
2905 for event in events {
2907 Event::PaymentSent { payment_preimage } => {
2908 if payment_preimage == our_payment_preimage {
2909 assert!(!first_claimed);
2910 first_claimed = true;
2912 assert_eq!(payment_preimage, our_payment_preimage_2);
2915 _ => panic!("Unexpected event"),
2918 check_tx_local_broadcast!(nodes[0], true, commitment_tx[0], chan_1.3);
2922 fn test_htlc_on_chain_timeout() {
2923 // Test that in case of a unilateral close onchain, we detect the state of output and
2924 // timeout the HTLC backward accordingly. So here we test that ChannelManager is
2925 // broadcasting the right event to other nodes in payment path.
2926 // A ------------------> B ----------------------> C (timeout)
2927 // B's commitment tx C's commitment tx
2929 // B's HTLC timeout tx B's timeout tx
2931 let chanmon_cfgs = create_chanmon_cfgs(3);
2932 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2933 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2934 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2936 // Create some intial channels
2937 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2938 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2940 // Rebalance the network a bit by relaying one payment thorugh all the channels...
2941 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2942 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2944 let (_payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2946 // Broadcast legit commitment tx from C on B's chain
2947 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2948 check_spends!(commitment_tx[0], chan_2.3);
2949 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
2950 check_added_monitors!(nodes[2], 0);
2951 expect_pending_htlcs_forwardable!(nodes[2]);
2952 check_added_monitors!(nodes[2], 1);
2954 let events = nodes[2].node.get_and_clear_pending_msg_events();
2955 assert_eq!(events.len(), 1);
2957 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, .. } } => {
2958 assert!(update_add_htlcs.is_empty());
2959 assert!(!update_fail_htlcs.is_empty());
2960 assert!(update_fulfill_htlcs.is_empty());
2961 assert!(update_fail_malformed_htlcs.is_empty());
2962 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2964 _ => panic!("Unexpected event"),
2966 let last_block = nodes[2].best_block_info();
2967 mine_transaction(&nodes[2], &commitment_tx[0]);
2968 check_closed_broadcast!(nodes[2], false);
2969 check_added_monitors!(nodes[2], 1);
2970 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2971 assert_eq!(node_txn.len(), 1);
2972 check_spends!(node_txn[0], chan_2.3);
2973 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2975 // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2976 // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2977 connect_blocks(&nodes[1], 200 - last_block.1 - 1, last_block.1, false, Default::default());
2978 mine_transaction(&nodes[1], &commitment_tx[0]);
2981 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2982 assert_eq!(node_txn.len(), 5); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (local commitment tx + HTLC-timeout), 1 timeout tx
2983 assert_eq!(node_txn[0], node_txn[3]);
2984 assert_eq!(node_txn[1], node_txn[4]);
2986 check_spends!(node_txn[2], commitment_tx[0]);
2987 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2989 check_spends!(node_txn[0], chan_2.3);
2990 check_spends!(node_txn[1], node_txn[0]);
2991 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
2992 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2994 timeout_tx = node_txn[2].clone();
2998 mine_transaction(&nodes[1], &timeout_tx);
2999 check_added_monitors!(nodes[1], 1);
3000 check_closed_broadcast!(nodes[1], false);
3002 // B will rebroadcast a fee-bumped timeout transaction here.
3003 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3004 assert_eq!(node_txn.len(), 1);
3005 check_spends!(node_txn[0], commitment_tx[0]);
3008 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 201, false, Default::default());
3010 // B will rebroadcast its own holder commitment transaction here...just because
3011 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3012 assert_eq!(node_txn.len(), 1);
3013 check_spends!(node_txn[0], chan_2.3);
3016 expect_pending_htlcs_forwardable!(nodes[1]);
3017 check_added_monitors!(nodes[1], 1);
3018 let events = nodes[1].node.get_and_clear_pending_msg_events();
3019 assert_eq!(events.len(), 1);
3021 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, .. } } => {
3022 assert!(update_add_htlcs.is_empty());
3023 assert!(!update_fail_htlcs.is_empty());
3024 assert!(update_fulfill_htlcs.is_empty());
3025 assert!(update_fail_malformed_htlcs.is_empty());
3026 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3028 _ => panic!("Unexpected event"),
3031 // Broadcast legit commitment tx from B on A's chain
3032 let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
3033 check_spends!(commitment_tx[0], chan_1.3);
3035 mine_transaction(&nodes[0], &commitment_tx[0]);
3037 check_closed_broadcast!(nodes[0], false);
3038 check_added_monitors!(nodes[0], 1);
3039 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 1 timeout tx
3040 assert_eq!(node_txn.len(), 3);
3041 check_spends!(node_txn[0], commitment_tx[0]);
3042 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3043 check_spends!(node_txn[1], chan_1.3);
3044 check_spends!(node_txn[2], node_txn[1]);
3045 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
3046 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3050 fn test_simple_commitment_revoked_fail_backward() {
3051 // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
3052 // and fail backward accordingly.
3054 let chanmon_cfgs = create_chanmon_cfgs(3);
3055 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3056 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3057 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3059 // Create some initial channels
3060 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3061 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3063 let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3064 // Get the will-be-revoked local txn from nodes[2]
3065 let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3066 // Revoke the old state
3067 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, 3_000_000);
3069 let (_, payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3071 mine_transaction(&nodes[1], &revoked_local_txn[0]);
3072 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, nodes[1].best_block_info().1, false, Default::default());
3073 check_added_monitors!(nodes[1], 1);
3074 check_closed_broadcast!(nodes[1], false);
3076 expect_pending_htlcs_forwardable!(nodes[1]);
3077 check_added_monitors!(nodes[1], 1);
3078 let events = nodes[1].node.get_and_clear_pending_msg_events();
3079 assert_eq!(events.len(), 1);
3081 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, .. } } => {
3082 assert!(update_add_htlcs.is_empty());
3083 assert_eq!(update_fail_htlcs.len(), 1);
3084 assert!(update_fulfill_htlcs.is_empty());
3085 assert!(update_fail_malformed_htlcs.is_empty());
3086 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3088 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3089 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3091 let events = nodes[0].node.get_and_clear_pending_msg_events();
3092 assert_eq!(events.len(), 1);
3094 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3095 _ => panic!("Unexpected event"),
3097 expect_payment_failed!(nodes[0], payment_hash, false);
3099 _ => panic!("Unexpected event"),
3103 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
3104 // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
3105 // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
3106 // commitment transaction anymore.
3107 // To do this, we have the peer which will broadcast a revoked commitment transaction send
3108 // a number of update_fail/commitment_signed updates without ever sending the RAA in
3109 // response to our commitment_signed. This is somewhat misbehavior-y, though not
3110 // technically disallowed and we should probably handle it reasonably.
3111 // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
3112 // failed/fulfilled backwards must be in at least one of the latest two remote commitment
3114 // * Once we move it out of our holding cell/add it, we will immediately include it in a
3115 // commitment_signed (implying it will be in the latest remote commitment transaction).
3116 // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
3117 // and once they revoke the previous commitment transaction (allowing us to send a new
3118 // commitment_signed) we will be free to fail/fulfill the HTLC backwards.
3119 let chanmon_cfgs = create_chanmon_cfgs(3);
3120 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3121 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3122 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3124 // Create some initial channels
3125 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3126 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3128 let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], if no_to_remote { 10_000 } else { 3_000_000 });
3129 // Get the will-be-revoked local txn from nodes[2]
3130 let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3131 assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
3132 // Revoke the old state
3133 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, if no_to_remote { 10_000 } else { 3_000_000});
3135 let value = if use_dust {
3136 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
3137 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
3138 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().holder_dust_limit_satoshis * 1000
3141 let (_, first_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3142 let (_, second_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3143 let (_, third_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3145 assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash, &None));
3146 expect_pending_htlcs_forwardable!(nodes[2]);
3147 check_added_monitors!(nodes[2], 1);
3148 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3149 assert!(updates.update_add_htlcs.is_empty());
3150 assert!(updates.update_fulfill_htlcs.is_empty());
3151 assert!(updates.update_fail_malformed_htlcs.is_empty());
3152 assert_eq!(updates.update_fail_htlcs.len(), 1);
3153 assert!(updates.update_fee.is_none());
3154 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3155 let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
3156 // Drop the last RAA from 3 -> 2
3158 assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash, &None));
3159 expect_pending_htlcs_forwardable!(nodes[2]);
3160 check_added_monitors!(nodes[2], 1);
3161 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3162 assert!(updates.update_add_htlcs.is_empty());
3163 assert!(updates.update_fulfill_htlcs.is_empty());
3164 assert!(updates.update_fail_malformed_htlcs.is_empty());
3165 assert_eq!(updates.update_fail_htlcs.len(), 1);
3166 assert!(updates.update_fee.is_none());
3167 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
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 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 assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash, &None));
3176 expect_pending_htlcs_forwardable!(nodes[2]);
3177 check_added_monitors!(nodes[2], 1);
3178 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3179 assert!(updates.update_add_htlcs.is_empty());
3180 assert!(updates.update_fulfill_htlcs.is_empty());
3181 assert!(updates.update_fail_malformed_htlcs.is_empty());
3182 assert_eq!(updates.update_fail_htlcs.len(), 1);
3183 assert!(updates.update_fee.is_none());
3184 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3185 // At this point first_payment_hash has dropped out of the latest two commitment
3186 // transactions that nodes[1] is tracking...
3187 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3188 check_added_monitors!(nodes[1], 1);
3189 // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
3190 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3191 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3192 check_added_monitors!(nodes[2], 1);
3194 // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
3195 // on nodes[2]'s RAA.
3196 let (_, fourth_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3197 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3198 let logger = test_utils::TestLogger::new();
3199 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();
3200 nodes[1].node.send_payment(&route, fourth_payment_hash, &None).unwrap();
3201 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3202 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3203 check_added_monitors!(nodes[1], 0);
3206 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
3207 // One monitor for the new revocation preimage, no second on as we won't generate a new
3208 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
3209 check_added_monitors!(nodes[1], 1);
3210 let events = nodes[1].node.get_and_clear_pending_events();
3211 assert_eq!(events.len(), 1);
3213 Event::PendingHTLCsForwardable { .. } => { },
3214 _ => panic!("Unexpected event"),
3216 // Deliberately don't process the pending fail-back so they all fail back at once after
3217 // block connection just like the !deliver_bs_raa case
3220 let mut failed_htlcs = HashSet::new();
3221 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3223 mine_transaction(&nodes[1], &revoked_local_txn[0]);
3224 check_added_monitors!(nodes[1], 1);
3225 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, nodes[1].best_block_info().1, false, Default::default());
3227 let events = nodes[1].node.get_and_clear_pending_events();
3228 assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
3230 Event::PaymentFailed { ref payment_hash, .. } => {
3231 assert_eq!(*payment_hash, fourth_payment_hash);
3233 _ => panic!("Unexpected event"),
3235 if !deliver_bs_raa {
3237 Event::PendingHTLCsForwardable { .. } => { },
3238 _ => panic!("Unexpected event"),
3241 nodes[1].node.process_pending_htlc_forwards();
3242 check_added_monitors!(nodes[1], 1);
3244 let events = nodes[1].node.get_and_clear_pending_msg_events();
3245 assert_eq!(events.len(), if deliver_bs_raa { 3 } else { 2 });
3246 match events[if deliver_bs_raa { 1 } else { 0 }] {
3247 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
3248 _ => panic!("Unexpected event"),
3252 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, .. } } => {
3253 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
3254 assert_eq!(update_add_htlcs.len(), 1);
3255 assert!(update_fulfill_htlcs.is_empty());
3256 assert!(update_fail_htlcs.is_empty());
3257 assert!(update_fail_malformed_htlcs.is_empty());
3259 _ => panic!("Unexpected event"),
3262 match events[if deliver_bs_raa { 2 } else { 1 }] {
3263 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, .. } } => {
3264 assert!(update_add_htlcs.is_empty());
3265 assert_eq!(update_fail_htlcs.len(), 3);
3266 assert!(update_fulfill_htlcs.is_empty());
3267 assert!(update_fail_malformed_htlcs.is_empty());
3268 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3270 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3271 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
3272 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
3274 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3276 let events = nodes[0].node.get_and_clear_pending_msg_events();
3277 // If we delivered B's RAA we got an unknown preimage error, not something
3278 // that we should update our routing table for.
3279 assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
3280 for event in events {
3282 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3283 _ => panic!("Unexpected event"),
3286 let events = nodes[0].node.get_and_clear_pending_events();
3287 assert_eq!(events.len(), 3);
3289 Event::PaymentFailed { ref payment_hash, .. } => {
3290 assert!(failed_htlcs.insert(payment_hash.0));
3292 _ => panic!("Unexpected event"),
3295 Event::PaymentFailed { ref payment_hash, .. } => {
3296 assert!(failed_htlcs.insert(payment_hash.0));
3298 _ => panic!("Unexpected event"),
3301 Event::PaymentFailed { ref payment_hash, .. } => {
3302 assert!(failed_htlcs.insert(payment_hash.0));
3304 _ => panic!("Unexpected event"),
3307 _ => panic!("Unexpected event"),
3310 assert!(failed_htlcs.contains(&first_payment_hash.0));
3311 assert!(failed_htlcs.contains(&second_payment_hash.0));
3312 assert!(failed_htlcs.contains(&third_payment_hash.0));
3316 fn test_commitment_revoked_fail_backward_exhaustive_a() {
3317 do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
3318 do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
3319 do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
3320 do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
3324 fn test_commitment_revoked_fail_backward_exhaustive_b() {
3325 do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
3326 do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
3327 do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
3328 do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
3332 fn fail_backward_pending_htlc_upon_channel_failure() {
3333 let chanmon_cfgs = create_chanmon_cfgs(2);
3334 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3335 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3336 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3337 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
3338 let logger = test_utils::TestLogger::new();
3340 // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
3342 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
3343 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3344 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();
3345 nodes[0].node.send_payment(&route, payment_hash, &None).unwrap();
3346 check_added_monitors!(nodes[0], 1);
3348 let payment_event = {
3349 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3350 assert_eq!(events.len(), 1);
3351 SendEvent::from_event(events.remove(0))
3353 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3354 assert_eq!(payment_event.msgs.len(), 1);
3357 // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3358 let (_, failed_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3360 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3361 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();
3362 nodes[0].node.send_payment(&route, failed_payment_hash, &None).unwrap();
3363 check_added_monitors!(nodes[0], 0);
3365 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3368 // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3370 let (_, payment_hash) = get_payment_preimage_hash!(nodes[1]);
3372 let secp_ctx = Secp256k1::new();
3373 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
3374 let current_height = nodes[1].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
3375 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3376 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();
3377 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &None, current_height).unwrap();
3378 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3379 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3381 // Send a 0-msat update_add_htlc to fail the channel.
3382 let update_add_htlc = msgs::UpdateAddHTLC {
3388 onion_routing_packet,
3390 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3393 // Check that Alice fails backward the pending HTLC from the second payment.
3394 expect_payment_failed!(nodes[0], failed_payment_hash, true);
3395 check_closed_broadcast!(nodes[0], true);
3396 check_added_monitors!(nodes[0], 1);
3400 fn test_htlc_ignore_latest_remote_commitment() {
3401 // Test that HTLC transactions spending the latest remote commitment transaction are simply
3402 // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3403 let chanmon_cfgs = create_chanmon_cfgs(2);
3404 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3405 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3406 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3407 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3409 route_payment(&nodes[0], &[&nodes[1]], 10000000);
3410 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
3411 check_closed_broadcast!(nodes[0], false);
3412 check_added_monitors!(nodes[0], 1);
3414 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3415 assert_eq!(node_txn.len(), 2);
3417 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3418 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, nodes[1].best_block_info().1 + 1);
3419 check_closed_broadcast!(nodes[1], false);
3420 check_added_monitors!(nodes[1], 1);
3422 // Duplicate the connect_block call since this may happen due to other listeners
3423 // registering new transactions
3424 header.prev_blockhash = header.block_hash();
3425 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, nodes[1].best_block_info().1 + 1);
3429 fn test_force_close_fail_back() {
3430 // Check which HTLCs are failed-backwards on channel force-closure
3431 let chanmon_cfgs = create_chanmon_cfgs(3);
3432 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3433 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3434 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3435 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3436 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3437 let logger = test_utils::TestLogger::new();
3439 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3441 let mut payment_event = {
3442 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3443 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();
3444 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
3445 check_added_monitors!(nodes[0], 1);
3447 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3448 assert_eq!(events.len(), 1);
3449 SendEvent::from_event(events.remove(0))
3452 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3453 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3455 expect_pending_htlcs_forwardable!(nodes[1]);
3457 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3458 assert_eq!(events_2.len(), 1);
3459 payment_event = SendEvent::from_event(events_2.remove(0));
3460 assert_eq!(payment_event.msgs.len(), 1);
3462 check_added_monitors!(nodes[1], 1);
3463 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3464 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3465 check_added_monitors!(nodes[2], 1);
3466 let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3468 // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3469 // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3470 // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3472 nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id).unwrap();
3473 check_closed_broadcast!(nodes[2], false);
3474 check_added_monitors!(nodes[2], 1);
3476 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3477 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3478 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3479 // back to nodes[1] upon timeout otherwise.
3480 assert_eq!(node_txn.len(), 1);
3484 mine_transaction(&nodes[1], &tx);
3486 // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3487 check_closed_broadcast!(nodes[1], false);
3488 check_added_monitors!(nodes[1], 1);
3490 // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3492 let mut monitors = nodes[2].chain_monitor.chain_monitor.monitors.read().unwrap();
3493 monitors.get(&OutPoint{ txid: Txid::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), index: 0 }).unwrap()
3494 .provide_payment_preimage(&our_payment_hash, &our_payment_preimage, &node_cfgs[2].tx_broadcaster, &node_cfgs[2].fee_estimator, &&logger);
3496 mine_transaction(&nodes[2], &tx);
3497 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3498 assert_eq!(node_txn.len(), 1);
3499 assert_eq!(node_txn[0].input.len(), 1);
3500 assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3501 assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3502 assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3504 check_spends!(node_txn[0], tx);
3508 fn test_simple_peer_disconnect() {
3509 // Test that we can reconnect when there are no lost messages
3510 let chanmon_cfgs = create_chanmon_cfgs(3);
3511 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3512 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3513 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3514 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3515 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3517 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3518 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3519 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3521 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3522 let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3523 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3524 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1, 1_000_000);
3526 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3527 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3528 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3530 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3531 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3532 let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3533 let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3535 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3536 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3538 claim_payment_along_route(&nodes[0], &vec!(&nodes[1], &nodes[2]), true, payment_preimage_3, 1_000_000);
3539 fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3541 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3543 let events = nodes[0].node.get_and_clear_pending_events();
3544 assert_eq!(events.len(), 2);
3546 Event::PaymentSent { payment_preimage } => {
3547 assert_eq!(payment_preimage, payment_preimage_3);
3549 _ => panic!("Unexpected event"),
3552 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3553 assert_eq!(payment_hash, payment_hash_5);
3554 assert!(rejected_by_dest);
3556 _ => panic!("Unexpected event"),
3560 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4, 1_000_000);
3561 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3564 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
3565 // Test that we can reconnect when in-flight HTLC updates get dropped
3566 let chanmon_cfgs = create_chanmon_cfgs(2);
3567 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3568 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3569 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3570 if messages_delivered == 0 {
3571 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3572 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3574 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3577 let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
3579 let logger = test_utils::TestLogger::new();
3580 let payment_event = {
3581 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3582 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3583 &nodes[1].node.get_our_node_id(), None, Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3584 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3585 nodes[0].node.send_payment(&route, payment_hash_1, &None).unwrap();
3586 check_added_monitors!(nodes[0], 1);
3588 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3589 assert_eq!(events.len(), 1);
3590 SendEvent::from_event(events.remove(0))
3592 assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3594 if messages_delivered < 2 {
3595 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3597 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3598 if messages_delivered >= 3 {
3599 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3600 check_added_monitors!(nodes[1], 1);
3601 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3603 if messages_delivered >= 4 {
3604 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3605 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3606 check_added_monitors!(nodes[0], 1);
3608 if messages_delivered >= 5 {
3609 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3610 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3611 // No commitment_signed so get_event_msg's assert(len == 1) passes
3612 check_added_monitors!(nodes[0], 1);
3614 if messages_delivered >= 6 {
3615 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3616 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3617 check_added_monitors!(nodes[1], 1);
3624 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3625 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3626 if messages_delivered < 3 {
3627 // Even if the funding_locked messages get exchanged, as long as nothing further was
3628 // received on either side, both sides will need to resend them.
3629 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3630 } else if messages_delivered == 3 {
3631 // nodes[0] still wants its RAA + commitment_signed
3632 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3633 } else if messages_delivered == 4 {
3634 // nodes[0] still wants its commitment_signed
3635 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3636 } else if messages_delivered == 5 {
3637 // nodes[1] still wants its final RAA
3638 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3639 } else if messages_delivered == 6 {
3640 // Everything was delivered...
3641 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3644 let events_1 = nodes[1].node.get_and_clear_pending_events();
3645 assert_eq!(events_1.len(), 1);
3647 Event::PendingHTLCsForwardable { .. } => { },
3648 _ => panic!("Unexpected event"),
3651 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3652 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3653 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3655 nodes[1].node.process_pending_htlc_forwards();
3657 let events_2 = nodes[1].node.get_and_clear_pending_events();
3658 assert_eq!(events_2.len(), 1);
3660 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
3661 assert_eq!(payment_hash_1, *payment_hash);
3662 assert_eq!(*payment_secret, None);
3663 assert_eq!(amt, 1000000);
3665 _ => panic!("Unexpected event"),
3668 nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000);
3669 check_added_monitors!(nodes[1], 1);
3671 let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3672 assert_eq!(events_3.len(), 1);
3673 let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3674 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3675 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3676 assert!(updates.update_add_htlcs.is_empty());
3677 assert!(updates.update_fail_htlcs.is_empty());
3678 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3679 assert!(updates.update_fail_malformed_htlcs.is_empty());
3680 assert!(updates.update_fee.is_none());
3681 (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3683 _ => panic!("Unexpected event"),
3686 if messages_delivered >= 1 {
3687 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3689 let events_4 = nodes[0].node.get_and_clear_pending_events();
3690 assert_eq!(events_4.len(), 1);
3692 Event::PaymentSent { ref payment_preimage } => {
3693 assert_eq!(payment_preimage_1, *payment_preimage);
3695 _ => panic!("Unexpected event"),
3698 if messages_delivered >= 2 {
3699 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3700 check_added_monitors!(nodes[0], 1);
3701 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3703 if messages_delivered >= 3 {
3704 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3705 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3706 check_added_monitors!(nodes[1], 1);
3708 if messages_delivered >= 4 {
3709 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3710 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3711 // No commitment_signed so get_event_msg's assert(len == 1) passes
3712 check_added_monitors!(nodes[1], 1);
3714 if messages_delivered >= 5 {
3715 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3716 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3717 check_added_monitors!(nodes[0], 1);
3724 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3725 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3726 if messages_delivered < 2 {
3727 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3728 //TODO: Deduplicate PaymentSent events, then enable this if:
3729 //if messages_delivered < 1 {
3730 let events_4 = nodes[0].node.get_and_clear_pending_events();
3731 assert_eq!(events_4.len(), 1);
3733 Event::PaymentSent { ref payment_preimage } => {
3734 assert_eq!(payment_preimage_1, *payment_preimage);
3736 _ => panic!("Unexpected event"),
3739 } else if messages_delivered == 2 {
3740 // nodes[0] still wants its RAA + commitment_signed
3741 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3742 } else if messages_delivered == 3 {
3743 // nodes[0] still wants its commitment_signed
3744 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3745 } else if messages_delivered == 4 {
3746 // nodes[1] still wants its final RAA
3747 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3748 } else if messages_delivered == 5 {
3749 // Everything was delivered...
3750 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3753 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3754 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3755 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3757 // Channel should still work fine...
3758 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3759 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3760 &nodes[1].node.get_our_node_id(), None, Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3761 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3762 let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3763 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3767 fn test_drop_messages_peer_disconnect_a() {
3768 do_test_drop_messages_peer_disconnect(0);
3769 do_test_drop_messages_peer_disconnect(1);
3770 do_test_drop_messages_peer_disconnect(2);
3771 do_test_drop_messages_peer_disconnect(3);
3775 fn test_drop_messages_peer_disconnect_b() {
3776 do_test_drop_messages_peer_disconnect(4);
3777 do_test_drop_messages_peer_disconnect(5);
3778 do_test_drop_messages_peer_disconnect(6);
3782 fn test_funding_peer_disconnect() {
3783 // Test that we can lock in our funding tx while disconnected
3784 let chanmon_cfgs = create_chanmon_cfgs(2);
3785 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3786 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3787 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3788 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3790 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3791 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3793 confirm_transaction(&nodes[0], &tx);
3794 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3795 assert_eq!(events_1.len(), 1);
3797 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3798 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3800 _ => panic!("Unexpected event"),
3803 reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3805 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3806 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3808 confirm_transaction(&nodes[1], &tx);
3809 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3810 assert_eq!(events_2.len(), 2);
3811 let funding_locked = match events_2[0] {
3812 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3813 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3816 _ => panic!("Unexpected event"),
3818 let bs_announcement_sigs = match events_2[1] {
3819 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3820 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3823 _ => panic!("Unexpected event"),
3826 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3828 nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3829 nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3830 let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3831 assert_eq!(events_3.len(), 2);
3832 let as_announcement_sigs = match events_3[0] {
3833 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3834 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3837 _ => panic!("Unexpected event"),
3839 let (as_announcement, as_update) = match events_3[1] {
3840 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3841 (msg.clone(), update_msg.clone())
3843 _ => panic!("Unexpected event"),
3846 nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3847 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3848 assert_eq!(events_4.len(), 1);
3849 let (_, bs_update) = match events_4[0] {
3850 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3851 (msg.clone(), update_msg.clone())
3853 _ => panic!("Unexpected event"),
3856 nodes[0].net_graph_msg_handler.handle_channel_announcement(&as_announcement).unwrap();
3857 nodes[0].net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
3858 nodes[0].net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
3860 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3861 let logger = test_utils::TestLogger::new();
3862 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();
3863 let (payment_preimage, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3864 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage, 1_000_000);
3868 fn test_drop_messages_peer_disconnect_dual_htlc() {
3869 // Test that we can handle reconnecting when both sides of a channel have pending
3870 // commitment_updates when we disconnect.
3871 let chanmon_cfgs = create_chanmon_cfgs(2);
3872 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3873 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3874 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3875 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3876 let logger = test_utils::TestLogger::new();
3878 let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3880 // Now try to send a second payment which will fail to send
3881 let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
3882 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3883 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();
3884 nodes[0].node.send_payment(&route, payment_hash_2, &None).unwrap();
3885 check_added_monitors!(nodes[0], 1);
3887 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3888 assert_eq!(events_1.len(), 1);
3890 MessageSendEvent::UpdateHTLCs { .. } => {},
3891 _ => panic!("Unexpected event"),
3894 assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000));
3895 check_added_monitors!(nodes[1], 1);
3897 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3898 assert_eq!(events_2.len(), 1);
3900 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 } } => {
3901 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3902 assert!(update_add_htlcs.is_empty());
3903 assert_eq!(update_fulfill_htlcs.len(), 1);
3904 assert!(update_fail_htlcs.is_empty());
3905 assert!(update_fail_malformed_htlcs.is_empty());
3906 assert!(update_fee.is_none());
3908 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3909 let events_3 = nodes[0].node.get_and_clear_pending_events();
3910 assert_eq!(events_3.len(), 1);
3912 Event::PaymentSent { ref payment_preimage } => {
3913 assert_eq!(*payment_preimage, payment_preimage_1);
3915 _ => panic!("Unexpected event"),
3918 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
3919 let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3920 // No commitment_signed so get_event_msg's assert(len == 1) passes
3921 check_added_monitors!(nodes[0], 1);
3923 _ => panic!("Unexpected event"),
3926 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3927 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3929 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3930 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3931 assert_eq!(reestablish_1.len(), 1);
3932 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3933 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3934 assert_eq!(reestablish_2.len(), 1);
3936 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3937 let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3938 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3939 let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3941 assert!(as_resp.0.is_none());
3942 assert!(bs_resp.0.is_none());
3944 assert!(bs_resp.1.is_none());
3945 assert!(bs_resp.2.is_none());
3947 assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3949 assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3950 assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3951 assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3952 assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3953 assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3954 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
3955 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
3956 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3957 // No commitment_signed so get_event_msg's assert(len == 1) passes
3958 check_added_monitors!(nodes[1], 1);
3960 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
3961 let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3962 assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
3963 assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
3964 assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
3965 assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
3966 assert!(bs_second_commitment_signed.update_fee.is_none());
3967 check_added_monitors!(nodes[1], 1);
3969 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3970 let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3971 assert!(as_commitment_signed.update_add_htlcs.is_empty());
3972 assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
3973 assert!(as_commitment_signed.update_fail_htlcs.is_empty());
3974 assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
3975 assert!(as_commitment_signed.update_fee.is_none());
3976 check_added_monitors!(nodes[0], 1);
3978 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
3979 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3980 // No commitment_signed so get_event_msg's assert(len == 1) passes
3981 check_added_monitors!(nodes[0], 1);
3983 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
3984 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3985 // No commitment_signed so get_event_msg's assert(len == 1) passes
3986 check_added_monitors!(nodes[1], 1);
3988 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3989 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3990 check_added_monitors!(nodes[1], 1);
3992 expect_pending_htlcs_forwardable!(nodes[1]);
3994 let events_5 = nodes[1].node.get_and_clear_pending_events();
3995 assert_eq!(events_5.len(), 1);
3997 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt: _ } => {
3998 assert_eq!(payment_hash_2, *payment_hash);
3999 assert_eq!(*payment_secret, None);
4001 _ => panic!("Unexpected event"),
4004 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
4005 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4006 check_added_monitors!(nodes[0], 1);
4008 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
4011 fn do_test_htlc_timeout(send_partial_mpp: bool) {
4012 // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
4013 // to avoid our counterparty failing the channel.
4014 let chanmon_cfgs = create_chanmon_cfgs(2);
4015 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4016 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4017 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4019 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4020 let logger = test_utils::TestLogger::new();
4022 let our_payment_hash = if send_partial_mpp {
4023 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4024 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();
4025 let (_, our_payment_hash) = get_payment_preimage_hash!(&nodes[0]);
4026 let payment_secret = PaymentSecret([0xdb; 32]);
4027 // Use the utility function send_payment_along_path to send the payment with MPP data which
4028 // indicates there are more HTLCs coming.
4029 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.
4030 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200000, cur_height).unwrap();
4031 check_added_monitors!(nodes[0], 1);
4032 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4033 assert_eq!(events.len(), 1);
4034 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
4035 // hop should *not* yet generate any PaymentReceived event(s).
4036 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false);
4039 route_payment(&nodes[0], &[&nodes[1]], 100000).1
4042 let mut block = Block {
4043 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
4046 connect_block(&nodes[0], &block, CHAN_CONFIRM_DEPTH + 1);
4047 connect_block(&nodes[1], &block, CHAN_CONFIRM_DEPTH + 1);
4048 for i in CHAN_CONFIRM_DEPTH + 2 ..TEST_FINAL_CLTV + CHAN_CONFIRM_DEPTH + 2 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS {
4049 block.header.prev_blockhash = block.block_hash();
4050 connect_block(&nodes[0], &block, i);
4051 connect_block(&nodes[1], &block, i);
4054 expect_pending_htlcs_forwardable!(nodes[1]);
4056 check_added_monitors!(nodes[1], 1);
4057 let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4058 assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
4059 assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
4060 assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
4061 assert!(htlc_timeout_updates.update_fee.is_none());
4063 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
4064 commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
4065 // 100_000 msat as u64, followed by a height of TEST_FINAL_CLTV + 2 as u32
4066 let mut expected_failure_data = byte_utils::be64_to_array(100_000).to_vec();
4067 expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(TEST_FINAL_CLTV + 2));
4068 expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
4072 fn test_htlc_timeout() {
4073 do_test_htlc_timeout(true);
4074 do_test_htlc_timeout(false);
4077 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
4078 // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
4079 let chanmon_cfgs = create_chanmon_cfgs(3);
4080 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4081 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4082 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4083 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4084 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
4086 // Make sure all nodes are at the same starting height
4087 connect_blocks(&nodes[0], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1, nodes[0].best_block_info().1, false, Default::default());
4088 connect_blocks(&nodes[1], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1, nodes[1].best_block_info().1, false, Default::default());
4089 connect_blocks(&nodes[2], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1, nodes[2].best_block_info().1, false, Default::default());
4091 let logger = test_utils::TestLogger::new();
4093 // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
4094 let (_, first_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4096 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4097 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();
4098 nodes[1].node.send_payment(&route, first_payment_hash, &None).unwrap();
4100 assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
4101 check_added_monitors!(nodes[1], 1);
4103 // Now attempt to route a second payment, which should be placed in the holding cell
4104 let (_, second_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4106 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4107 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();
4108 nodes[0].node.send_payment(&route, second_payment_hash, &None).unwrap();
4109 check_added_monitors!(nodes[0], 1);
4110 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4111 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
4112 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4113 expect_pending_htlcs_forwardable!(nodes[1]);
4114 check_added_monitors!(nodes[1], 0);
4116 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4117 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();
4118 nodes[1].node.send_payment(&route, second_payment_hash, &None).unwrap();
4119 check_added_monitors!(nodes[1], 0);
4122 connect_blocks(&nodes[1], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS, nodes[1].best_block_info().1, false, Default::default());
4123 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4124 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4125 connect_blocks(&nodes[1], 1, nodes[1].best_block_info().1, false, Default::default());
4128 expect_pending_htlcs_forwardable!(nodes[1]);
4129 check_added_monitors!(nodes[1], 1);
4130 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
4131 assert_eq!(fail_commit.len(), 1);
4132 match fail_commit[0] {
4133 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
4134 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
4135 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
4137 _ => unreachable!(),
4139 expect_payment_failed!(nodes[0], second_payment_hash, false);
4140 if let &MessageSendEvent::PaymentFailureNetworkUpdate { ref update } = &nodes[0].node.get_and_clear_pending_msg_events()[0] {
4142 &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {},
4143 _ => panic!("Unexpected event"),
4146 panic!("Unexpected event");
4149 expect_payment_failed!(nodes[1], second_payment_hash, true);
4154 fn test_holding_cell_htlc_add_timeouts() {
4155 do_test_holding_cell_htlc_add_timeouts(false);
4156 do_test_holding_cell_htlc_add_timeouts(true);
4160 fn test_invalid_channel_announcement() {
4161 //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
4162 let secp_ctx = Secp256k1::new();
4163 let chanmon_cfgs = create_chanmon_cfgs(2);
4164 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4165 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4166 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4168 let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
4170 let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
4171 let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
4172 let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4173 let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4175 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 } );
4177 let as_bitcoin_key = as_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4178 let bs_bitcoin_key = bs_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4180 let as_network_key = nodes[0].node.get_our_node_id();
4181 let bs_network_key = nodes[1].node.get_our_node_id();
4183 let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
4185 let mut chan_announcement;
4187 macro_rules! dummy_unsigned_msg {
4189 msgs::UnsignedChannelAnnouncement {
4190 features: ChannelFeatures::known(),
4191 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4192 short_channel_id: as_chan.get_short_channel_id().unwrap(),
4193 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
4194 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
4195 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
4196 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
4197 excess_data: Vec::new(),
4202 macro_rules! sign_msg {
4203 ($unsigned_msg: expr) => {
4204 let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
4205 let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_signer().inner.funding_key);
4206 let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_signer().inner.funding_key);
4207 let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
4208 let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
4209 chan_announcement = msgs::ChannelAnnouncement {
4210 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
4211 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
4212 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
4213 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
4214 contents: $unsigned_msg
4219 let unsigned_msg = dummy_unsigned_msg!();
4220 sign_msg!(unsigned_msg);
4221 assert_eq!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).unwrap(), true);
4222 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 } );
4224 // Configured with Network::Testnet
4225 let mut unsigned_msg = dummy_unsigned_msg!();
4226 unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.block_hash();
4227 sign_msg!(unsigned_msg);
4228 assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4230 let mut unsigned_msg = dummy_unsigned_msg!();
4231 unsigned_msg.chain_hash = BlockHash::hash(&[1,2,3,4,5,6,7,8,9]);
4232 sign_msg!(unsigned_msg);
4233 assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4237 fn test_no_txn_manager_serialize_deserialize() {
4238 let chanmon_cfgs = create_chanmon_cfgs(2);
4239 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4240 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4241 let logger: test_utils::TestLogger;
4242 let fee_estimator: test_utils::TestFeeEstimator;
4243 let persister: test_utils::TestPersister;
4244 let new_chain_monitor: test_utils::TestChainMonitor;
4245 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4246 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4248 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
4250 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4252 let nodes_0_serialized = nodes[0].node.encode();
4253 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4254 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4256 logger = test_utils::TestLogger::new();
4257 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4258 persister = test_utils::TestPersister::new();
4259 let keys_manager = &chanmon_cfgs[0].keys_manager;
4260 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4261 nodes[0].chain_monitor = &new_chain_monitor;
4262 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4263 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4264 &mut chan_0_monitor_read, keys_manager).unwrap();
4265 assert!(chan_0_monitor_read.is_empty());
4267 let mut nodes_0_read = &nodes_0_serialized[..];
4268 let config = UserConfig::default();
4269 let (_, nodes_0_deserialized_tmp) = {
4270 let mut channel_monitors = HashMap::new();
4271 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4272 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4273 default_config: config,
4275 fee_estimator: &fee_estimator,
4276 chain_monitor: nodes[0].chain_monitor,
4277 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4282 nodes_0_deserialized = nodes_0_deserialized_tmp;
4283 assert!(nodes_0_read.is_empty());
4285 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4286 nodes[0].node = &nodes_0_deserialized;
4287 assert_eq!(nodes[0].node.list_channels().len(), 1);
4288 check_added_monitors!(nodes[0], 1);
4290 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4291 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4292 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4293 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4295 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4296 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4297 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4298 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4300 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4301 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4302 for node in nodes.iter() {
4303 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4304 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4305 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4308 send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
4312 fn test_manager_serialize_deserialize_events() {
4313 // This test makes sure the events field in ChannelManager survives de/serialization
4314 let chanmon_cfgs = create_chanmon_cfgs(2);
4315 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4316 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4317 let fee_estimator: test_utils::TestFeeEstimator;
4318 let persister: test_utils::TestPersister;
4319 let logger: test_utils::TestLogger;
4320 let new_chain_monitor: test_utils::TestChainMonitor;
4321 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4322 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4324 // Start creating a channel, but stop right before broadcasting the event message FundingBroadcastSafe
4325 let channel_value = 100000;
4326 let push_msat = 10001;
4327 let a_flags = InitFeatures::known();
4328 let b_flags = InitFeatures::known();
4329 let node_a = nodes.remove(0);
4330 let node_b = nodes.remove(0);
4331 node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
4332 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()));
4333 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()));
4335 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&node_a, channel_value, 42);
4337 node_a.node.funding_transaction_generated(&temporary_channel_id, funding_output);
4338 check_added_monitors!(node_a, 0);
4340 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()));
4342 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
4343 assert_eq!(added_monitors.len(), 1);
4344 assert_eq!(added_monitors[0].0, funding_output);
4345 added_monitors.clear();
4348 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()));
4350 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
4351 assert_eq!(added_monitors.len(), 1);
4352 assert_eq!(added_monitors[0].0, funding_output);
4353 added_monitors.clear();
4355 // Normally, this is where node_a would check for a FundingBroadcastSafe event, but the test de/serializes first instead
4360 // Start the de/seriailization process mid-channel creation to check that the channel manager will hold onto events that are serialized
4361 let nodes_0_serialized = nodes[0].node.encode();
4362 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4363 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4365 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4366 logger = test_utils::TestLogger::new();
4367 persister = test_utils::TestPersister::new();
4368 let keys_manager = &chanmon_cfgs[0].keys_manager;
4369 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4370 nodes[0].chain_monitor = &new_chain_monitor;
4371 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4372 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4373 &mut chan_0_monitor_read, keys_manager).unwrap();
4374 assert!(chan_0_monitor_read.is_empty());
4376 let mut nodes_0_read = &nodes_0_serialized[..];
4377 let config = UserConfig::default();
4378 let (_, nodes_0_deserialized_tmp) = {
4379 let mut channel_monitors = HashMap::new();
4380 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4381 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4382 default_config: config,
4384 fee_estimator: &fee_estimator,
4385 chain_monitor: nodes[0].chain_monitor,
4386 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4391 nodes_0_deserialized = nodes_0_deserialized_tmp;
4392 assert!(nodes_0_read.is_empty());
4394 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4396 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4397 nodes[0].node = &nodes_0_deserialized;
4399 // After deserializing, make sure the FundingBroadcastSafe event is still held by the channel manager
4400 let events_4 = nodes[0].node.get_and_clear_pending_events();
4401 assert_eq!(events_4.len(), 1);
4403 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
4404 assert_eq!(user_channel_id, 42);
4405 assert_eq!(*funding_txo, funding_output);
4407 _ => panic!("Unexpected event"),
4410 // Make sure the channel is functioning as though the de/serialization never happened
4411 assert_eq!(nodes[0].node.list_channels().len(), 1);
4412 check_added_monitors!(nodes[0], 1);
4414 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4415 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4416 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4417 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4419 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4420 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4421 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4422 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4424 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4425 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4426 for node in nodes.iter() {
4427 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4428 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4429 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4432 send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
4436 fn test_simple_manager_serialize_deserialize() {
4437 let chanmon_cfgs = create_chanmon_cfgs(2);
4438 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4439 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4440 let logger: test_utils::TestLogger;
4441 let fee_estimator: test_utils::TestFeeEstimator;
4442 let persister: test_utils::TestPersister;
4443 let new_chain_monitor: test_utils::TestChainMonitor;
4444 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4445 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4446 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4448 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4449 let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4451 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4453 let nodes_0_serialized = nodes[0].node.encode();
4454 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4455 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4457 logger = test_utils::TestLogger::new();
4458 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4459 persister = test_utils::TestPersister::new();
4460 let keys_manager = &chanmon_cfgs[0].keys_manager;
4461 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4462 nodes[0].chain_monitor = &new_chain_monitor;
4463 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4464 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4465 &mut chan_0_monitor_read, keys_manager).unwrap();
4466 assert!(chan_0_monitor_read.is_empty());
4468 let mut nodes_0_read = &nodes_0_serialized[..];
4469 let (_, nodes_0_deserialized_tmp) = {
4470 let mut channel_monitors = HashMap::new();
4471 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4472 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4473 default_config: UserConfig::default(),
4475 fee_estimator: &fee_estimator,
4476 chain_monitor: nodes[0].chain_monitor,
4477 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4482 nodes_0_deserialized = nodes_0_deserialized_tmp;
4483 assert!(nodes_0_read.is_empty());
4485 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4486 nodes[0].node = &nodes_0_deserialized;
4487 check_added_monitors!(nodes[0], 1);
4489 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4491 fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
4492 claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage, 1_000_000);
4496 fn test_manager_serialize_deserialize_inconsistent_monitor() {
4497 // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
4498 let chanmon_cfgs = create_chanmon_cfgs(4);
4499 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4500 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4501 let logger: test_utils::TestLogger;
4502 let fee_estimator: test_utils::TestFeeEstimator;
4503 let persister: test_utils::TestPersister;
4504 let new_chain_monitor: test_utils::TestChainMonitor;
4505 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4506 let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4507 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4508 create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::known(), InitFeatures::known());
4509 let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
4511 let mut node_0_stale_monitors_serialized = Vec::new();
4512 for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4513 let mut writer = test_utils::TestVecWriter(Vec::new());
4514 monitor.1.write(&mut writer).unwrap();
4515 node_0_stale_monitors_serialized.push(writer.0);
4518 let (our_payment_preimage, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
4520 // Serialize the ChannelManager here, but the monitor we keep up-to-date
4521 let nodes_0_serialized = nodes[0].node.encode();
4523 route_payment(&nodes[0], &[&nodes[3]], 1000000);
4524 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4525 nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4526 nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4528 // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
4530 let mut node_0_monitors_serialized = Vec::new();
4531 for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4532 let mut writer = test_utils::TestVecWriter(Vec::new());
4533 monitor.1.write(&mut writer).unwrap();
4534 node_0_monitors_serialized.push(writer.0);
4537 logger = test_utils::TestLogger::new();
4538 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4539 persister = test_utils::TestPersister::new();
4540 let keys_manager = &chanmon_cfgs[0].keys_manager;
4541 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4542 nodes[0].chain_monitor = &new_chain_monitor;
4545 let mut node_0_stale_monitors = Vec::new();
4546 for serialized in node_0_stale_monitors_serialized.iter() {
4547 let mut read = &serialized[..];
4548 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4549 assert!(read.is_empty());
4550 node_0_stale_monitors.push(monitor);
4553 let mut node_0_monitors = Vec::new();
4554 for serialized in node_0_monitors_serialized.iter() {
4555 let mut read = &serialized[..];
4556 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4557 assert!(read.is_empty());
4558 node_0_monitors.push(monitor);
4561 let mut nodes_0_read = &nodes_0_serialized[..];
4562 if let Err(msgs::DecodeError::InvalidValue) =
4563 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4564 default_config: UserConfig::default(),
4566 fee_estimator: &fee_estimator,
4567 chain_monitor: nodes[0].chain_monitor,
4568 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4570 channel_monitors: node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4572 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
4575 let mut nodes_0_read = &nodes_0_serialized[..];
4576 let (_, nodes_0_deserialized_tmp) =
4577 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4578 default_config: UserConfig::default(),
4580 fee_estimator: &fee_estimator,
4581 chain_monitor: nodes[0].chain_monitor,
4582 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4584 channel_monitors: node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4586 nodes_0_deserialized = nodes_0_deserialized_tmp;
4587 assert!(nodes_0_read.is_empty());
4589 { // Channel close should result in a commitment tx and an HTLC tx
4590 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4591 assert_eq!(txn.len(), 2);
4592 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
4593 assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
4596 for monitor in node_0_monitors.drain(..) {
4597 assert!(nodes[0].chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor).is_ok());
4598 check_added_monitors!(nodes[0], 1);
4600 nodes[0].node = &nodes_0_deserialized;
4602 // nodes[1] and nodes[2] have no lost state with nodes[0]...
4603 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4604 reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4605 //... and we can even still claim the payment!
4606 claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage, 1_000_000);
4608 nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4609 let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4610 nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4611 nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
4612 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4613 assert_eq!(msg_events.len(), 1);
4614 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
4616 &ErrorAction::SendErrorMessage { ref msg } => {
4617 assert_eq!(msg.channel_id, channel_id);
4619 _ => panic!("Unexpected event!"),
4624 macro_rules! check_spendable_outputs {
4625 ($node: expr, $der_idx: expr, $keysinterface: expr, $chan_value: expr) => {
4627 let mut events = $node.chain_monitor.chain_monitor.get_and_clear_pending_events();
4628 let mut txn = Vec::new();
4629 let mut all_outputs = Vec::new();
4630 let secp_ctx = Secp256k1::new();
4631 for event in events.drain(..) {
4633 Event::SpendableOutputs { mut outputs } => {
4634 for outp in outputs.drain(..) {
4635 txn.push($keysinterface.backing.spend_spendable_outputs(&[&outp], Vec::new(), Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &secp_ctx).unwrap());
4636 all_outputs.push(outp);
4639 _ => panic!("Unexpected event"),
4642 if all_outputs.len() > 1 {
4643 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) {
4653 fn test_claim_sizeable_push_msat() {
4654 // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4655 let chanmon_cfgs = create_chanmon_cfgs(2);
4656 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4657 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4658 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4660 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4661 nodes[1].node.force_close_channel(&chan.2).unwrap();
4662 check_closed_broadcast!(nodes[1], false);
4663 check_added_monitors!(nodes[1], 1);
4664 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4665 assert_eq!(node_txn.len(), 1);
4666 check_spends!(node_txn[0], chan.3);
4667 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
4669 mine_transaction(&nodes[1], &node_txn[0]);
4670 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, nodes[1].best_block_info().1, false, Default::default());
4672 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4673 assert_eq!(spend_txn.len(), 1);
4674 check_spends!(spend_txn[0], node_txn[0]);
4678 fn test_claim_on_remote_sizeable_push_msat() {
4679 // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4680 // to_remote output is encumbered by a P2WPKH
4681 let chanmon_cfgs = create_chanmon_cfgs(2);
4682 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4683 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4684 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4686 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4687 nodes[0].node.force_close_channel(&chan.2).unwrap();
4688 check_closed_broadcast!(nodes[0], false);
4689 check_added_monitors!(nodes[0], 1);
4691 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4692 assert_eq!(node_txn.len(), 1);
4693 check_spends!(node_txn[0], chan.3);
4694 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
4696 mine_transaction(&nodes[1], &node_txn[0]);
4697 check_closed_broadcast!(nodes[1], false);
4698 check_added_monitors!(nodes[1], 1);
4699 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, nodes[1].best_block_info().1, false, Default::default());
4701 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4702 assert_eq!(spend_txn.len(), 1);
4703 check_spends!(spend_txn[0], node_txn[0]);
4707 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4708 // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4709 // to_remote output is encumbered by a P2WPKH
4711 let chanmon_cfgs = create_chanmon_cfgs(2);
4712 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4713 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4714 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4716 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::known(), InitFeatures::known());
4717 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4718 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4719 assert_eq!(revoked_local_txn[0].input.len(), 1);
4720 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4722 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4723 mine_transaction(&nodes[1], &revoked_local_txn[0]);
4724 check_closed_broadcast!(nodes[1], false);
4725 check_added_monitors!(nodes[1], 1);
4727 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4728 mine_transaction(&nodes[1], &node_txn[0]);
4729 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, nodes[1].best_block_info().1, false, Default::default());
4731 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4732 assert_eq!(spend_txn.len(), 3);
4733 check_spends!(spend_txn[0], revoked_local_txn[0]); // to_remote output on revoked remote commitment_tx
4734 check_spends!(spend_txn[1], node_txn[0]);
4735 check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[0]); // Both outputs
4739 fn test_static_spendable_outputs_preimage_tx() {
4740 let chanmon_cfgs = create_chanmon_cfgs(2);
4741 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4742 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4743 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4745 // Create some initial channels
4746 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4748 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4750 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4751 assert_eq!(commitment_tx[0].input.len(), 1);
4752 assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4754 // Settle A's commitment tx on B's chain
4755 assert!(nodes[1].node.claim_funds(payment_preimage, &None, 3_000_000));
4756 check_added_monitors!(nodes[1], 1);
4757 mine_transaction(&nodes[1], &commitment_tx[0]);
4758 check_added_monitors!(nodes[1], 1);
4759 let events = nodes[1].node.get_and_clear_pending_msg_events();
4761 MessageSendEvent::UpdateHTLCs { .. } => {},
4762 _ => panic!("Unexpected event"),
4765 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4766 _ => panic!("Unexepected event"),
4769 // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4770 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4771 assert_eq!(node_txn.len(), 3);
4772 check_spends!(node_txn[0], commitment_tx[0]);
4773 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4774 check_spends!(node_txn[1], chan_1.3);
4775 check_spends!(node_txn[2], node_txn[1]);
4777 mine_transaction(&nodes[1], &node_txn[0]);
4778 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, nodes[1].best_block_info().1, false, Default::default());
4780 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4781 assert_eq!(spend_txn.len(), 1);
4782 check_spends!(spend_txn[0], node_txn[0]);
4786 fn test_static_spendable_outputs_timeout_tx() {
4787 let chanmon_cfgs = create_chanmon_cfgs(2);
4788 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4789 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4790 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4792 // Create some initial channels
4793 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4795 // Rebalance the network a bit by relaying one payment through all the channels ...
4796 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
4798 let (_, our_payment_hash) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
4800 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4801 assert_eq!(commitment_tx[0].input.len(), 1);
4802 assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4804 // Settle A's commitment tx on B' chain
4805 mine_transaction(&nodes[1], &commitment_tx[0]);
4806 check_added_monitors!(nodes[1], 1);
4807 let events = nodes[1].node.get_and_clear_pending_msg_events();
4809 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4810 _ => panic!("Unexpected event"),
4813 // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
4814 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4815 assert_eq!(node_txn.len(), 3); // ChannelManager : 2 (local commitent tx + HTLC-timeout), ChannelMonitor: timeout tx
4816 check_spends!(node_txn[0], commitment_tx[0].clone());
4817 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4818 check_spends!(node_txn[1], chan_1.3.clone());
4819 check_spends!(node_txn[2], node_txn[1]);
4821 mine_transaction(&nodes[1], &node_txn[0]);
4822 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, nodes[1].best_block_info().1, false, Default::default());
4823 expect_payment_failed!(nodes[1], our_payment_hash, true);
4825 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4826 assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote, timeout_tx.output
4827 check_spends!(spend_txn[0], commitment_tx[0]);
4828 check_spends!(spend_txn[1], node_txn[0]);
4829 check_spends!(spend_txn[2], node_txn[0], commitment_tx[0]); // All outputs
4833 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
4834 let chanmon_cfgs = create_chanmon_cfgs(2);
4835 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4836 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4837 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4839 // Create some initial channels
4840 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4842 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4843 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4844 assert_eq!(revoked_local_txn[0].input.len(), 1);
4845 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4847 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4849 mine_transaction(&nodes[1], &revoked_local_txn[0]);
4850 check_closed_broadcast!(nodes[1], false);
4851 check_added_monitors!(nodes[1], 1);
4853 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4854 assert_eq!(node_txn.len(), 2);
4855 assert_eq!(node_txn[0].input.len(), 2);
4856 check_spends!(node_txn[0], revoked_local_txn[0]);
4858 mine_transaction(&nodes[1], &node_txn[0]);
4859 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, nodes[1].best_block_info().1, false, Default::default());
4861 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4862 assert_eq!(spend_txn.len(), 1);
4863 check_spends!(spend_txn[0], node_txn[0]);
4867 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
4868 let mut chanmon_cfgs = create_chanmon_cfgs(2);
4869 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
4870 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4871 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4872 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4874 // Create some initial channels
4875 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4877 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4878 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4879 assert_eq!(revoked_local_txn[0].input.len(), 1);
4880 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4882 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4884 // A will generate HTLC-Timeout from revoked commitment tx
4885 mine_transaction(&nodes[0], &revoked_local_txn[0]);
4886 check_closed_broadcast!(nodes[0], false);
4887 check_added_monitors!(nodes[0], 1);
4889 let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4890 assert_eq!(revoked_htlc_txn.len(), 2);
4891 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4892 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4893 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
4894 check_spends!(revoked_htlc_txn[1], chan_1.3);
4896 // B will generate justice tx from A's revoked commitment/HTLC tx
4897 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4898 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, nodes[1].best_block_info().1 + 1);
4899 check_closed_broadcast!(nodes[1], false);
4900 check_added_monitors!(nodes[1], 1);
4902 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4903 assert_eq!(node_txn.len(), 3); // ChannelMonitor: bogus justice tx, justice tx on revoked outputs, ChannelManager: local commitment tx
4904 // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
4905 // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
4906 // transactions next...
4907 assert_eq!(node_txn[0].input.len(), 3);
4908 check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
4910 assert_eq!(node_txn[1].input.len(), 2);
4911 check_spends!(node_txn[1], revoked_local_txn[0], revoked_htlc_txn[0]);
4912 if node_txn[1].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
4913 assert_ne!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4915 assert_eq!(node_txn[1].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
4916 assert_ne!(node_txn[1].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4919 assert_eq!(node_txn[2].input.len(), 1);
4920 check_spends!(node_txn[2], chan_1.3);
4922 mine_transaction(&nodes[1], &node_txn[1]);
4923 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, nodes[1].best_block_info().1, false, Default::default());
4925 // Check B's ChannelMonitor was able to generate the right spendable output descriptor
4926 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4927 assert_eq!(spend_txn.len(), 1);
4928 assert_eq!(spend_txn[0].input.len(), 1);
4929 check_spends!(spend_txn[0], node_txn[1]);
4933 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
4934 let mut chanmon_cfgs = create_chanmon_cfgs(2);
4935 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
4936 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4937 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4938 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4940 // Create some initial channels
4941 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4943 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4944 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
4945 assert_eq!(revoked_local_txn[0].input.len(), 1);
4946 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4948 // The to-be-revoked commitment tx should have one HTLC and one to_remote output
4949 assert_eq!(revoked_local_txn[0].output.len(), 2);
4951 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4953 // B will generate HTLC-Success from revoked commitment tx
4954 mine_transaction(&nodes[1], &revoked_local_txn[0]);
4955 check_closed_broadcast!(nodes[1], false);
4956 check_added_monitors!(nodes[1], 1);
4957 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4959 assert_eq!(revoked_htlc_txn.len(), 2);
4960 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4961 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4962 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
4964 // Check that the unspent (of two) outputs on revoked_local_txn[0] is a P2WPKH:
4965 let unspent_local_txn_output = revoked_htlc_txn[0].input[0].previous_output.vout as usize ^ 1;
4966 assert_eq!(revoked_local_txn[0].output[unspent_local_txn_output].script_pubkey.len(), 2 + 20); // P2WPKH
4968 // A will generate justice tx from B's revoked commitment/HTLC tx
4969 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4970 connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, nodes[0].best_block_info().1 + 1);
4971 check_closed_broadcast!(nodes[0], false);
4972 check_added_monitors!(nodes[0], 1);
4974 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4975 assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
4977 // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
4978 // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
4979 // transactions next...
4980 assert_eq!(node_txn[0].input.len(), 2);
4981 check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
4982 if node_txn[0].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
4983 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4985 assert_eq!(node_txn[0].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
4986 assert_eq!(node_txn[0].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4989 assert_eq!(node_txn[1].input.len(), 1);
4990 check_spends!(node_txn[1], revoked_htlc_txn[0]);
4992 check_spends!(node_txn[2], chan_1.3);
4994 mine_transaction(&nodes[0], &node_txn[1]);
4995 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, nodes[0].best_block_info().1, false, Default::default());
4997 // Note that nodes[0]'s tx_broadcaster is still locked, so if we get here the channelmonitor
4998 // didn't try to generate any new transactions.
5000 // Check A's ChannelMonitor was able to generate the right spendable output descriptor
5001 let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
5002 assert_eq!(spend_txn.len(), 3);
5003 assert_eq!(spend_txn[0].input.len(), 1);
5004 check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
5005 assert_ne!(spend_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5006 check_spends!(spend_txn[1], node_txn[1]); // spending justice tx output on the htlc success tx
5007 check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[1]); // Both outputs
5011 fn test_onchain_to_onchain_claim() {
5012 // Test that in case of channel closure, we detect the state of output and claim HTLC
5013 // on downstream peer's remote commitment tx.
5014 // First, have C claim an HTLC against its own latest commitment transaction.
5015 // Then, broadcast these to B, which should update the monitor downstream on the A<->B
5017 // Finally, check that B will claim the HTLC output if A's latest commitment transaction
5020 let chanmon_cfgs = create_chanmon_cfgs(3);
5021 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5022 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5023 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5025 // Create some initial channels
5026 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5027 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5029 // Rebalance the network a bit by relaying one payment through all the channels ...
5030 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
5031 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
5033 let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
5034 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
5035 check_spends!(commitment_tx[0], chan_2.3);
5036 nodes[2].node.claim_funds(payment_preimage, &None, 3_000_000);
5037 check_added_monitors!(nodes[2], 1);
5038 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5039 assert!(updates.update_add_htlcs.is_empty());
5040 assert!(updates.update_fail_htlcs.is_empty());
5041 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5042 assert!(updates.update_fail_malformed_htlcs.is_empty());
5044 mine_transaction(&nodes[2], &commitment_tx[0]);
5045 check_closed_broadcast!(nodes[2], false);
5046 check_added_monitors!(nodes[2], 1);
5048 let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
5049 assert_eq!(c_txn.len(), 3);
5050 assert_eq!(c_txn[0], c_txn[2]);
5051 assert_eq!(commitment_tx[0], c_txn[1]);
5052 check_spends!(c_txn[1], chan_2.3);
5053 check_spends!(c_txn[2], c_txn[1]);
5054 assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
5055 assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5056 assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5057 assert_eq!(c_txn[0].lock_time, 0); // Success tx
5059 // 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
5060 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
5061 connect_block(&nodes[1], &Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]}, nodes[1].best_block_info().1 + 1);
5063 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5064 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-timeout tx
5065 assert_eq!(b_txn.len(), 3);
5066 check_spends!(b_txn[1], chan_2.3); // B local commitment tx, issued by ChannelManager
5067 check_spends!(b_txn[2], b_txn[1]); // HTLC-Timeout on B local commitment tx, issued by ChannelManager
5068 assert_eq!(b_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5069 assert!(b_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5070 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
5071 check_spends!(b_txn[0], c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor
5072 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5073 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5074 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
5077 check_added_monitors!(nodes[1], 1);
5078 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5079 check_added_monitors!(nodes[1], 1);
5080 match msg_events[0] {
5081 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5082 _ => panic!("Unexpected event"),
5084 match msg_events[1] {
5085 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, .. } } => {
5086 assert!(update_add_htlcs.is_empty());
5087 assert!(update_fail_htlcs.is_empty());
5088 assert_eq!(update_fulfill_htlcs.len(), 1);
5089 assert!(update_fail_malformed_htlcs.is_empty());
5090 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
5092 _ => panic!("Unexpected event"),
5094 // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
5095 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5096 mine_transaction(&nodes[1], &commitment_tx[0]);
5097 let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5098 // ChannelMonitor: HTLC-Success tx, ChannelManager: local commitment tx + HTLC-Success tx
5099 assert_eq!(b_txn.len(), 3);
5100 check_spends!(b_txn[1], chan_1.3);
5101 check_spends!(b_txn[2], b_txn[1]);
5102 check_spends!(b_txn[0], commitment_tx[0]);
5103 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5104 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5105 assert_eq!(b_txn[0].lock_time, 0); // Success tx
5107 check_closed_broadcast!(nodes[1], false);
5108 check_added_monitors!(nodes[1], 1);
5112 fn test_duplicate_payment_hash_one_failure_one_success() {
5113 // Topology : A --> B --> C
5114 // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
5115 let chanmon_cfgs = create_chanmon_cfgs(3);
5116 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5117 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5118 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5120 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5121 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5123 let (our_payment_preimage, duplicate_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
5124 *nodes[0].network_payment_count.borrow_mut() -= 1;
5125 assert_eq!(route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000).1, duplicate_payment_hash);
5127 let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
5128 assert_eq!(commitment_txn[0].input.len(), 1);
5129 check_spends!(commitment_txn[0], chan_2.3);
5131 mine_transaction(&nodes[1], &commitment_txn[0]);
5132 check_closed_broadcast!(nodes[1], false);
5133 check_added_monitors!(nodes[1], 1);
5135 let htlc_timeout_tx;
5136 { // Extract one of the two HTLC-Timeout transaction
5137 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5138 // ChannelMonitor: timeout tx * 2, ChannelManager: local commitment tx + HTLC-timeout * 2
5139 assert_eq!(node_txn.len(), 5);
5140 check_spends!(node_txn[0], commitment_txn[0]);
5141 assert_eq!(node_txn[0].input.len(), 1);
5142 check_spends!(node_txn[1], commitment_txn[0]);
5143 assert_eq!(node_txn[1].input.len(), 1);
5144 assert_ne!(node_txn[0].input[0], node_txn[1].input[0]);
5145 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5146 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5147 check_spends!(node_txn[2], chan_2.3);
5148 check_spends!(node_txn[3], node_txn[2]);
5149 check_spends!(node_txn[4], node_txn[2]);
5150 htlc_timeout_tx = node_txn[1].clone();
5153 nodes[2].node.claim_funds(our_payment_preimage, &None, 900_000);
5154 mine_transaction(&nodes[2], &commitment_txn[0]);
5155 check_added_monitors!(nodes[2], 3);
5156 let events = nodes[2].node.get_and_clear_pending_msg_events();
5158 MessageSendEvent::UpdateHTLCs { .. } => {},
5159 _ => panic!("Unexpected event"),
5162 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5163 _ => panic!("Unexepected event"),
5165 let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5166 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)
5167 check_spends!(htlc_success_txn[2], chan_2.3);
5168 check_spends!(htlc_success_txn[3], htlc_success_txn[2]);
5169 check_spends!(htlc_success_txn[4], htlc_success_txn[2]);
5170 assert_eq!(htlc_success_txn[0], htlc_success_txn[3]);
5171 assert_eq!(htlc_success_txn[0].input.len(), 1);
5172 assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5173 assert_eq!(htlc_success_txn[1], htlc_success_txn[4]);
5174 assert_eq!(htlc_success_txn[1].input.len(), 1);
5175 assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5176 assert_ne!(htlc_success_txn[0].input[0], htlc_success_txn[1].input[0]);
5177 check_spends!(htlc_success_txn[0], commitment_txn[0]);
5178 check_spends!(htlc_success_txn[1], commitment_txn[0]);
5180 mine_transaction(&nodes[1], &htlc_timeout_tx);
5181 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, nodes[1].best_block_info().1, false, Default::default());
5182 expect_pending_htlcs_forwardable!(nodes[1]);
5183 let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5184 assert!(htlc_updates.update_add_htlcs.is_empty());
5185 assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5186 assert_eq!(htlc_updates.update_fail_htlcs[0].htlc_id, 1);
5187 assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5188 assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5189 check_added_monitors!(nodes[1], 1);
5191 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
5192 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5194 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5195 let events = nodes[0].node.get_and_clear_pending_msg_events();
5196 assert_eq!(events.len(), 1);
5198 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. } } => {
5200 _ => { panic!("Unexpected event"); }
5203 expect_payment_failed!(nodes[0], duplicate_payment_hash, false);
5205 // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5206 mine_transaction(&nodes[1], &htlc_success_txn[0]);
5207 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5208 assert!(updates.update_add_htlcs.is_empty());
5209 assert!(updates.update_fail_htlcs.is_empty());
5210 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5211 assert_eq!(updates.update_fulfill_htlcs[0].htlc_id, 0);
5212 assert!(updates.update_fail_malformed_htlcs.is_empty());
5213 check_added_monitors!(nodes[1], 1);
5215 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
5216 commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5218 let events = nodes[0].node.get_and_clear_pending_events();
5220 Event::PaymentSent { ref payment_preimage } => {
5221 assert_eq!(*payment_preimage, our_payment_preimage);
5223 _ => panic!("Unexpected event"),
5228 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
5229 let chanmon_cfgs = create_chanmon_cfgs(2);
5230 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5231 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5232 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5234 // Create some initial channels
5235 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5237 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5238 let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5239 assert_eq!(local_txn.len(), 1);
5240 assert_eq!(local_txn[0].input.len(), 1);
5241 check_spends!(local_txn[0], chan_1.3);
5243 // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5244 nodes[1].node.claim_funds(payment_preimage, &None, 9_000_000);
5245 check_added_monitors!(nodes[1], 1);
5246 mine_transaction(&nodes[1], &local_txn[0]);
5247 check_added_monitors!(nodes[1], 1);
5248 let events = nodes[1].node.get_and_clear_pending_msg_events();
5250 MessageSendEvent::UpdateHTLCs { .. } => {},
5251 _ => panic!("Unexpected event"),
5254 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5255 _ => panic!("Unexepected event"),
5258 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5259 assert_eq!(node_txn.len(), 3);
5260 assert_eq!(node_txn[0], node_txn[2]);
5261 assert_eq!(node_txn[1], local_txn[0]);
5262 assert_eq!(node_txn[0].input.len(), 1);
5263 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5264 check_spends!(node_txn[0], local_txn[0]);
5268 mine_transaction(&nodes[1], &node_tx);
5269 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, nodes[1].best_block_info().1, false, Default::default());
5271 // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5272 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5273 assert_eq!(spend_txn.len(), 1);
5274 check_spends!(spend_txn[0], node_tx);
5277 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
5278 // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
5279 // unrevoked commitment transaction.
5280 // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
5281 // a remote RAA before they could be failed backwards (and combinations thereof).
5282 // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
5283 // use the same payment hashes.
5284 // Thus, we use a six-node network:
5289 // And test where C fails back to A/B when D announces its latest commitment transaction
5290 let chanmon_cfgs = create_chanmon_cfgs(6);
5291 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
5292 let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
5293 let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
5294 let logger = test_utils::TestLogger::new();
5296 create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5297 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5298 let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5299 create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
5300 create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
5302 // Rebalance and check output sanity...
5303 send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000, 500_000);
5304 send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000, 500_000);
5305 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
5307 let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
5309 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
5311 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
5312 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
5313 let our_node_id = &nodes[1].node.get_our_node_id();
5314 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();
5316 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
5318 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
5320 let (_, payment_hash_3) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5322 let (_, payment_hash_4) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5323 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();
5325 send_along_route_with_hash(&nodes[1], route.clone(), &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_3);
5327 send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_4);
5330 let (_, payment_hash_5) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5332 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();
5333 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
5336 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
5338 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();
5339 send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_6);
5341 // Double-check that six of the new HTLC were added
5342 // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
5343 // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
5344 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
5345 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
5347 // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
5348 // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
5349 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1, &None));
5350 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3, &None));
5351 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5, &None));
5352 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6, &None));
5353 check_added_monitors!(nodes[4], 0);
5354 expect_pending_htlcs_forwardable!(nodes[4]);
5355 check_added_monitors!(nodes[4], 1);
5357 let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
5358 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
5359 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
5360 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
5361 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
5362 commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
5364 // Fail 3rd below-dust and 7th above-dust HTLCs
5365 assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2, &None));
5366 assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4, &None));
5367 check_added_monitors!(nodes[5], 0);
5368 expect_pending_htlcs_forwardable!(nodes[5]);
5369 check_added_monitors!(nodes[5], 1);
5371 let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5372 nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5373 nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5374 commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5376 let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5378 expect_pending_htlcs_forwardable!(nodes[3]);
5379 check_added_monitors!(nodes[3], 1);
5380 let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5381 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5382 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5383 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5384 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5385 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5386 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5387 if deliver_last_raa {
5388 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5390 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5393 // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5394 // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5395 // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5396 // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5398 // We now broadcast the latest commitment transaction, which *should* result in failures for
5399 // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5400 // the non-broadcast above-dust HTLCs.
5402 // Alternatively, we may broadcast the previous commitment transaction, which should only
5403 // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5404 let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5406 if announce_latest {
5407 mine_transaction(&nodes[2], &ds_last_commitment_tx[0]);
5409 mine_transaction(&nodes[2], &ds_prev_commitment_tx[0]);
5411 connect_blocks(&nodes[2], ANTI_REORG_DELAY - 1, nodes[2].best_block_info().1, false, Default::default());
5412 check_closed_broadcast!(nodes[2], false);
5413 expect_pending_htlcs_forwardable!(nodes[2]);
5414 check_added_monitors!(nodes[2], 3);
5416 let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5417 assert_eq!(cs_msgs.len(), 2);
5418 let mut a_done = false;
5419 for msg in cs_msgs {
5421 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5422 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5423 // should be failed-backwards here.
5424 let target = if *node_id == nodes[0].node.get_our_node_id() {
5425 // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5426 for htlc in &updates.update_fail_htlcs {
5427 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 });
5429 assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5434 // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5435 for htlc in &updates.update_fail_htlcs {
5436 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5438 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5439 assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5442 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5443 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5444 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5445 if announce_latest {
5446 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5447 if *node_id == nodes[0].node.get_our_node_id() {
5448 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5451 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5453 _ => panic!("Unexpected event"),
5457 let as_events = nodes[0].node.get_and_clear_pending_events();
5458 assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
5459 let mut as_failds = HashSet::new();
5460 for event in as_events.iter() {
5461 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5462 assert!(as_failds.insert(*payment_hash));
5463 if *payment_hash != payment_hash_2 {
5464 assert_eq!(*rejected_by_dest, deliver_last_raa);
5466 assert!(!rejected_by_dest);
5468 } else { panic!("Unexpected event"); }
5470 assert!(as_failds.contains(&payment_hash_1));
5471 assert!(as_failds.contains(&payment_hash_2));
5472 if announce_latest {
5473 assert!(as_failds.contains(&payment_hash_3));
5474 assert!(as_failds.contains(&payment_hash_5));
5476 assert!(as_failds.contains(&payment_hash_6));
5478 let bs_events = nodes[1].node.get_and_clear_pending_events();
5479 assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
5480 let mut bs_failds = HashSet::new();
5481 for event in bs_events.iter() {
5482 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5483 assert!(bs_failds.insert(*payment_hash));
5484 if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5485 assert_eq!(*rejected_by_dest, deliver_last_raa);
5487 assert!(!rejected_by_dest);
5489 } else { panic!("Unexpected event"); }
5491 assert!(bs_failds.contains(&payment_hash_1));
5492 assert!(bs_failds.contains(&payment_hash_2));
5493 if announce_latest {
5494 assert!(bs_failds.contains(&payment_hash_4));
5496 assert!(bs_failds.contains(&payment_hash_5));
5498 // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5499 // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
5500 // to unknown-preimage-etc, B should have gotten 2. Thus, in the
5501 // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
5502 // PaymentFailureNetworkUpdates.
5503 let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
5504 assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5505 let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5506 assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5507 for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
5509 &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
5510 _ => panic!("Unexpected event"),
5516 fn test_fail_backwards_latest_remote_announce_a() {
5517 do_test_fail_backwards_unrevoked_remote_announce(false, true);
5521 fn test_fail_backwards_latest_remote_announce_b() {
5522 do_test_fail_backwards_unrevoked_remote_announce(true, true);
5526 fn test_fail_backwards_previous_remote_announce() {
5527 do_test_fail_backwards_unrevoked_remote_announce(false, false);
5528 // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5529 // tested for in test_commitment_revoked_fail_backward_exhaustive()
5533 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5534 let chanmon_cfgs = create_chanmon_cfgs(2);
5535 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5536 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5537 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5539 // Create some initial channels
5540 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5542 let (_, our_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5543 let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5544 assert_eq!(local_txn[0].input.len(), 1);
5545 check_spends!(local_txn[0], chan_1.3);
5547 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5548 mine_transaction(&nodes[0], &local_txn[0]);
5549 check_closed_broadcast!(nodes[0], false);
5550 check_added_monitors!(nodes[0], 1);
5552 let htlc_timeout = {
5553 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5554 assert_eq!(node_txn[0].input.len(), 1);
5555 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5556 check_spends!(node_txn[0], local_txn[0]);
5560 mine_transaction(&nodes[0], &htlc_timeout);
5561 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, nodes[0].best_block_info().1, false, Default::default());
5562 expect_payment_failed!(nodes[0], our_payment_hash, true);
5564 // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5565 let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
5566 assert_eq!(spend_txn.len(), 3);
5567 check_spends!(spend_txn[0], local_txn[0]);
5568 check_spends!(spend_txn[1], htlc_timeout);
5569 check_spends!(spend_txn[2], local_txn[0], htlc_timeout);
5573 fn test_key_derivation_params() {
5574 // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with
5575 // a key manager rotation to test that key_derivation_params returned in DynamicOutputP2WSH
5576 // let us re-derive the channel key set to then derive a delayed_payment_key.
5578 let chanmon_cfgs = create_chanmon_cfgs(3);
5580 // We manually create the node configuration to backup the seed.
5581 let seed = [42; 32];
5582 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5583 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);
5584 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 };
5585 let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5586 node_cfgs.remove(0);
5587 node_cfgs.insert(0, node);
5589 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5590 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5592 // Create some initial channels
5593 // Create a dummy channel to advance index by one and thus test re-derivation correctness
5595 let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5596 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5597 assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5599 let (_, our_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5600 let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5601 let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5602 assert_eq!(local_txn_1[0].input.len(), 1);
5603 check_spends!(local_txn_1[0], chan_1.3);
5605 // We check funding pubkey are unique
5606 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]));
5607 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]));
5608 if from_0_funding_key_0 == from_1_funding_key_0
5609 || from_0_funding_key_0 == from_1_funding_key_1
5610 || from_0_funding_key_1 == from_1_funding_key_0
5611 || from_0_funding_key_1 == from_1_funding_key_1 {
5612 panic!("Funding pubkeys aren't unique");
5615 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5616 mine_transaction(&nodes[0], &local_txn_1[0]);
5617 check_closed_broadcast!(nodes[0], false);
5618 check_added_monitors!(nodes[0], 1);
5620 let htlc_timeout = {
5621 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5622 assert_eq!(node_txn[0].input.len(), 1);
5623 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5624 check_spends!(node_txn[0], local_txn_1[0]);
5628 mine_transaction(&nodes[0], &htlc_timeout);
5629 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, nodes[0].best_block_info().1, false, Default::default());
5630 expect_payment_failed!(nodes[0], our_payment_hash, true);
5632 // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5633 let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5634 let spend_txn = check_spendable_outputs!(nodes[0], 1, new_keys_manager, 100000);
5635 assert_eq!(spend_txn.len(), 3);
5636 check_spends!(spend_txn[0], local_txn_1[0]);
5637 check_spends!(spend_txn[1], htlc_timeout);
5638 check_spends!(spend_txn[2], local_txn_1[0], htlc_timeout);
5642 fn test_static_output_closing_tx() {
5643 let chanmon_cfgs = create_chanmon_cfgs(2);
5644 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5645 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5646 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5648 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5650 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
5651 let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5653 mine_transaction(&nodes[0], &closing_tx);
5654 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, nodes[0].best_block_info().1, false, Default::default());
5656 let spend_txn = check_spendable_outputs!(nodes[0], 2, node_cfgs[0].keys_manager, 100000);
5657 assert_eq!(spend_txn.len(), 1);
5658 check_spends!(spend_txn[0], closing_tx);
5660 mine_transaction(&nodes[1], &closing_tx);
5661 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, nodes[1].best_block_info().1, false, Default::default());
5663 let spend_txn = check_spendable_outputs!(nodes[1], 2, node_cfgs[1].keys_manager, 100000);
5664 assert_eq!(spend_txn.len(), 1);
5665 check_spends!(spend_txn[0], closing_tx);
5668 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5669 let chanmon_cfgs = create_chanmon_cfgs(2);
5670 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5671 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5672 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5673 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5675 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5677 // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5678 // present in B's local commitment transaction, but none of A's commitment transactions.
5679 assert!(nodes[1].node.claim_funds(our_payment_preimage, &None, if use_dust { 50_000 } else { 3_000_000 }));
5680 check_added_monitors!(nodes[1], 1);
5682 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5683 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5684 let events = nodes[0].node.get_and_clear_pending_events();
5685 assert_eq!(events.len(), 1);
5687 Event::PaymentSent { payment_preimage } => {
5688 assert_eq!(payment_preimage, our_payment_preimage);
5690 _ => panic!("Unexpected event"),
5693 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5694 check_added_monitors!(nodes[0], 1);
5695 let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5696 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5697 check_added_monitors!(nodes[1], 1);
5699 let starting_block = nodes[1].best_block_info();
5700 let mut block = Block {
5701 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5704 for i in starting_block.1 + 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + starting_block.1 + 2 {
5705 connect_block(&nodes[1], &block, i);
5706 block.header.prev_blockhash = block.block_hash();
5708 test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5709 check_closed_broadcast!(nodes[1], false);
5710 check_added_monitors!(nodes[1], 1);
5713 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5714 let chanmon_cfgs = create_chanmon_cfgs(2);
5715 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5716 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5717 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5718 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5719 let logger = test_utils::TestLogger::new();
5721 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
5722 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5723 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();
5724 nodes[0].node.send_payment(&route, payment_hash, &None).unwrap();
5725 check_added_monitors!(nodes[0], 1);
5727 let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5729 // As far as A is concerned, the HTLC is now present only in the latest remote commitment
5730 // transaction, however it is not in A's latest local commitment, so we can just broadcast that
5731 // to "time out" the HTLC.
5733 let starting_block = nodes[1].best_block_info();
5734 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5736 for i in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + starting_block.1 + 2 {
5737 connect_block(&nodes[0], &Block { header, txdata: Vec::new()}, i);
5738 header.prev_blockhash = header.block_hash();
5740 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5741 check_closed_broadcast!(nodes[0], false);
5742 check_added_monitors!(nodes[0], 1);
5745 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
5746 let chanmon_cfgs = create_chanmon_cfgs(3);
5747 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5748 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5749 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5750 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5752 // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
5753 // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
5754 // Also optionally test that we *don't* fail the channel in case the commitment transaction was
5755 // actually revoked.
5756 let htlc_value = if use_dust { 50000 } else { 3000000 };
5757 let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
5758 assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash, &None));
5759 expect_pending_htlcs_forwardable!(nodes[1]);
5760 check_added_monitors!(nodes[1], 1);
5762 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5763 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
5764 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5765 check_added_monitors!(nodes[0], 1);
5766 let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5767 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5768 check_added_monitors!(nodes[1], 1);
5769 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
5770 check_added_monitors!(nodes[1], 1);
5771 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
5773 if check_revoke_no_close {
5774 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
5775 check_added_monitors!(nodes[0], 1);
5778 let starting_block = nodes[1].best_block_info();
5779 let mut block = Block {
5780 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5783 for i in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 2 {
5784 connect_block(&nodes[0], &block, i);
5785 block.header.prev_blockhash = block.block_hash();
5787 if !check_revoke_no_close {
5788 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5789 check_closed_broadcast!(nodes[0], false);
5790 check_added_monitors!(nodes[0], 1);
5792 expect_payment_failed!(nodes[0], our_payment_hash, true);
5796 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
5797 // There are only a few cases to test here:
5798 // * its not really normative behavior, but we test that below-dust HTLCs "included" in
5799 // broadcastable commitment transactions result in channel closure,
5800 // * its included in an unrevoked-but-previous remote commitment transaction,
5801 // * its included in the latest remote or local commitment transactions.
5802 // We test each of the three possible commitment transactions individually and use both dust and
5804 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
5805 // assume they are handled the same across all six cases, as both outbound and inbound failures are
5806 // tested for at least one of the cases in other tests.
5808 fn htlc_claim_single_commitment_only_a() {
5809 do_htlc_claim_local_commitment_only(true);
5810 do_htlc_claim_local_commitment_only(false);
5812 do_htlc_claim_current_remote_commitment_only(true);
5813 do_htlc_claim_current_remote_commitment_only(false);
5817 fn htlc_claim_single_commitment_only_b() {
5818 do_htlc_claim_previous_remote_commitment_only(true, false);
5819 do_htlc_claim_previous_remote_commitment_only(false, false);
5820 do_htlc_claim_previous_remote_commitment_only(true, true);
5821 do_htlc_claim_previous_remote_commitment_only(false, true);
5826 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
5827 let chanmon_cfgs = create_chanmon_cfgs(2);
5828 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5829 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5830 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5831 //Force duplicate channel ids
5832 for node in nodes.iter() {
5833 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
5836 // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
5837 let channel_value_satoshis=10000;
5838 let push_msat=10001;
5839 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
5840 let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5841 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
5843 //Create a second channel with a channel_id collision
5844 assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5848 fn bolt2_open_channel_sending_node_checks_part2() {
5849 let chanmon_cfgs = create_chanmon_cfgs(2);
5850 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5851 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5852 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5854 // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
5855 let channel_value_satoshis=2^24;
5856 let push_msat=10001;
5857 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5859 // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
5860 let channel_value_satoshis=10000;
5861 // Test when push_msat is equal to 1000 * funding_satoshis.
5862 let push_msat=1000*channel_value_satoshis+1;
5863 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5865 // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
5866 let channel_value_satoshis=10000;
5867 let push_msat=10001;
5868 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
5869 let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5870 assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
5872 // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
5873 // 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
5874 assert!(node0_to_1_send_open_channel.channel_flags<=1);
5876 // 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.
5877 assert!(BREAKDOWN_TIMEOUT>0);
5878 assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
5880 // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
5881 let chain_hash=genesis_block(Network::Testnet).header.block_hash();
5882 assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
5884 // 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.
5885 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
5886 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
5887 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
5888 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
5889 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
5892 // Test that if we fail to send an HTLC that is being freed from the holding cell, and the HTLC
5893 // originated from our node, its failure is surfaced to the user. We trigger this failure to
5894 // free the HTLC by increasing our fee while the HTLC is in the holding cell such that the HTLC
5895 // is no longer affordable once it's freed.
5897 fn test_fail_holding_cell_htlc_upon_free() {
5898 let chanmon_cfgs = create_chanmon_cfgs(2);
5899 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5900 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5901 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5902 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
5903 let logger = test_utils::TestLogger::new();
5905 // First nodes[0] generates an update_fee, setting the channel's
5906 // pending_update_fee.
5907 nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 20).unwrap();
5908 check_added_monitors!(nodes[0], 1);
5910 let events = nodes[0].node.get_and_clear_pending_msg_events();
5911 assert_eq!(events.len(), 1);
5912 let (update_msg, commitment_signed) = match events[0] {
5913 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
5914 (update_fee.as_ref(), commitment_signed)
5916 _ => panic!("Unexpected event"),
5919 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
5921 let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
5922 let channel_reserve = chan_stat.channel_reserve_msat;
5923 let feerate = get_feerate!(nodes[0], chan.2);
5925 // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
5926 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5927 let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1);
5928 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5929 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();
5931 // Send a payment which passes reserve checks but gets stuck in the holding cell.
5932 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
5933 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
5934 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
5936 // Flush the pending fee update.
5937 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
5938 let (as_revoke_and_ack, _) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5939 check_added_monitors!(nodes[1], 1);
5940 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
5941 check_added_monitors!(nodes[0], 1);
5943 // Upon receipt of the RAA, there will be an attempt to resend the holding cell
5944 // HTLC, but now that the fee has been raised the payment will now fail, causing
5945 // us to surface its failure to the user.
5946 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
5947 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
5948 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), "Freeing holding cell with 1 HTLC updates".to_string(), 1);
5949 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);
5950 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
5952 // Check that the payment failed to be sent out.
5953 let events = nodes[0].node.get_and_clear_pending_events();
5954 assert_eq!(events.len(), 1);
5956 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
5957 assert_eq!(our_payment_hash.clone(), *payment_hash);
5958 assert_eq!(*rejected_by_dest, false);
5959 assert_eq!(*error_code, None);
5960 assert_eq!(*error_data, None);
5962 _ => panic!("Unexpected event"),
5966 // Test that if multiple HTLCs are released from the holding cell and one is
5967 // valid but the other is no longer valid upon release, the valid HTLC can be
5968 // successfully completed while the other one fails as expected.
5970 fn test_free_and_fail_holding_cell_htlcs() {
5971 let chanmon_cfgs = create_chanmon_cfgs(2);
5972 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5973 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5974 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5975 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
5976 let logger = test_utils::TestLogger::new();
5978 // First nodes[0] generates an update_fee, setting the channel's
5979 // pending_update_fee.
5980 nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 200).unwrap();
5981 check_added_monitors!(nodes[0], 1);
5983 let events = nodes[0].node.get_and_clear_pending_msg_events();
5984 assert_eq!(events.len(), 1);
5985 let (update_msg, commitment_signed) = match events[0] {
5986 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
5987 (update_fee.as_ref(), commitment_signed)
5989 _ => panic!("Unexpected event"),
5992 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
5994 let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
5995 let channel_reserve = chan_stat.channel_reserve_msat;
5996 let feerate = get_feerate!(nodes[0], chan.2);
5998 // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
5999 let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
6001 let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
6002 let amt_2 = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 2 + 1) - amt_1;
6003 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6004 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();
6005 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();
6007 // Send 2 payments which pass reserve checks but get stuck in the holding cell.
6008 nodes[0].node.send_payment(&route_1, payment_hash_1, &None).unwrap();
6009 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6010 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1);
6011 nodes[0].node.send_payment(&route_2, payment_hash_2, &None).unwrap();
6012 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6013 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1 + amt_2);
6015 // Flush the pending fee update.
6016 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6017 let (revoke_and_ack, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6018 check_added_monitors!(nodes[1], 1);
6019 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_and_ack);
6020 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6021 check_added_monitors!(nodes[0], 2);
6023 // Upon receipt of the RAA, there will be an attempt to resend the holding cell HTLCs,
6024 // but now that the fee has been raised the second payment will now fail, causing us
6025 // to surface its failure to the user. The first payment should succeed.
6026 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6027 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6028 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), "Freeing holding cell with 2 HTLC updates".to_string(), 1);
6029 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);
6030 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6032 // Check that the second payment failed to be sent out.
6033 let events = nodes[0].node.get_and_clear_pending_events();
6034 assert_eq!(events.len(), 1);
6036 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6037 assert_eq!(payment_hash_2.clone(), *payment_hash);
6038 assert_eq!(*rejected_by_dest, false);
6039 assert_eq!(*error_code, None);
6040 assert_eq!(*error_data, None);
6042 _ => panic!("Unexpected event"),
6045 // Complete the first payment and the RAA from the fee update.
6046 let (payment_event, send_raa_event) = {
6047 let mut msgs = nodes[0].node.get_and_clear_pending_msg_events();
6048 assert_eq!(msgs.len(), 2);
6049 (SendEvent::from_event(msgs.remove(0)), msgs.remove(0))
6051 let raa = match send_raa_event {
6052 MessageSendEvent::SendRevokeAndACK { msg, .. } => msg,
6053 _ => panic!("Unexpected event"),
6055 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6056 check_added_monitors!(nodes[1], 1);
6057 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6058 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6059 let events = nodes[1].node.get_and_clear_pending_events();
6060 assert_eq!(events.len(), 1);
6062 Event::PendingHTLCsForwardable { .. } => {},
6063 _ => panic!("Unexpected event"),
6065 nodes[1].node.process_pending_htlc_forwards();
6066 let events = nodes[1].node.get_and_clear_pending_events();
6067 assert_eq!(events.len(), 1);
6069 Event::PaymentReceived { .. } => {},
6070 _ => panic!("Unexpected event"),
6072 nodes[1].node.claim_funds(payment_preimage_1, &None, amt_1);
6073 check_added_monitors!(nodes[1], 1);
6074 let update_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6075 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msgs.update_fulfill_htlcs[0]);
6076 commitment_signed_dance!(nodes[0], nodes[1], update_msgs.commitment_signed, false, true);
6077 let events = nodes[0].node.get_and_clear_pending_events();
6078 assert_eq!(events.len(), 1);
6080 Event::PaymentSent { ref payment_preimage } => {
6081 assert_eq!(*payment_preimage, payment_preimage_1);
6083 _ => panic!("Unexpected event"),
6087 // Test that if we fail to forward an HTLC that is being freed from the holding cell that the
6088 // HTLC is failed backwards. We trigger this failure to forward the freed HTLC by increasing
6089 // our fee while the HTLC is in the holding cell such that the HTLC is no longer affordable
6092 fn test_fail_holding_cell_htlc_upon_free_multihop() {
6093 let chanmon_cfgs = create_chanmon_cfgs(3);
6094 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6095 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6096 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6097 let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6098 let chan_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6099 let logger = test_utils::TestLogger::new();
6101 // First nodes[1] generates an update_fee, setting the channel's
6102 // pending_update_fee.
6103 nodes[1].node.update_fee(chan_1_2.2, get_feerate!(nodes[1], chan_1_2.2) + 20).unwrap();
6104 check_added_monitors!(nodes[1], 1);
6106 let events = nodes[1].node.get_and_clear_pending_msg_events();
6107 assert_eq!(events.len(), 1);
6108 let (update_msg, commitment_signed) = match events[0] {
6109 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6110 (update_fee.as_ref(), commitment_signed)
6112 _ => panic!("Unexpected event"),
6115 nodes[2].node.handle_update_fee(&nodes[1].node.get_our_node_id(), update_msg.unwrap());
6117 let mut chan_stat = get_channel_value_stat!(nodes[0], chan_0_1.2);
6118 let channel_reserve = chan_stat.channel_reserve_msat;
6119 let feerate = get_feerate!(nodes[0], chan_0_1.2);
6121 // Send a payment which passes reserve checks but gets stuck in the holding cell.
6123 let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
6124 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6125 let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1) - total_routing_fee_msat;
6126 let payment_event = {
6127 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6128 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();
6129 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6130 check_added_monitors!(nodes[0], 1);
6132 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6133 assert_eq!(events.len(), 1);
6135 SendEvent::from_event(events.remove(0))
6137 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6138 check_added_monitors!(nodes[1], 0);
6139 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6140 expect_pending_htlcs_forwardable!(nodes[1]);
6142 chan_stat = get_channel_value_stat!(nodes[1], chan_1_2.2);
6143 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6145 // Flush the pending fee update.
6146 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
6147 let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6148 check_added_monitors!(nodes[2], 1);
6149 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &raa);
6150 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &commitment_signed);
6151 check_added_monitors!(nodes[1], 2);
6153 // A final RAA message is generated to finalize the fee update.
6154 let events = nodes[1].node.get_and_clear_pending_msg_events();
6155 assert_eq!(events.len(), 1);
6157 let raa_msg = match &events[0] {
6158 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => {
6161 _ => panic!("Unexpected event"),
6164 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_msg);
6165 check_added_monitors!(nodes[2], 1);
6166 assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
6168 // nodes[1]'s ChannelManager will now signal that we have HTLC forwards to process.
6169 let process_htlc_forwards_event = nodes[1].node.get_and_clear_pending_events();
6170 assert_eq!(process_htlc_forwards_event.len(), 1);
6171 match &process_htlc_forwards_event[0] {
6172 &Event::PendingHTLCsForwardable { .. } => {},
6173 _ => panic!("Unexpected event"),
6176 // In response, we call ChannelManager's process_pending_htlc_forwards
6177 nodes[1].node.process_pending_htlc_forwards();
6178 check_added_monitors!(nodes[1], 1);
6180 // This causes the HTLC to be failed backwards.
6181 let fail_event = nodes[1].node.get_and_clear_pending_msg_events();
6182 assert_eq!(fail_event.len(), 1);
6183 let (fail_msg, commitment_signed) = match &fail_event[0] {
6184 &MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6185 assert_eq!(updates.update_add_htlcs.len(), 0);
6186 assert_eq!(updates.update_fulfill_htlcs.len(), 0);
6187 assert_eq!(updates.update_fail_malformed_htlcs.len(), 0);
6188 assert_eq!(updates.update_fail_htlcs.len(), 1);
6189 (updates.update_fail_htlcs[0].clone(), updates.commitment_signed.clone())
6191 _ => panic!("Unexpected event"),
6194 // Pass the failure messages back to nodes[0].
6195 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
6196 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6198 // Complete the HTLC failure+removal process.
6199 let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6200 check_added_monitors!(nodes[0], 1);
6201 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6202 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
6203 check_added_monitors!(nodes[1], 2);
6204 let final_raa_event = nodes[1].node.get_and_clear_pending_msg_events();
6205 assert_eq!(final_raa_event.len(), 1);
6206 let raa = match &final_raa_event[0] {
6207 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => msg.clone(),
6208 _ => panic!("Unexpected event"),
6210 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
6211 let fail_msg_event = nodes[0].node.get_and_clear_pending_msg_events();
6212 assert_eq!(fail_msg_event.len(), 1);
6213 match &fail_msg_event[0] {
6214 &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
6215 _ => panic!("Unexpected event"),
6217 let failure_event = nodes[0].node.get_and_clear_pending_events();
6218 assert_eq!(failure_event.len(), 1);
6219 match &failure_event[0] {
6220 &Event::PaymentFailed { rejected_by_dest, .. } => {
6221 assert!(!rejected_by_dest);
6223 _ => panic!("Unexpected event"),
6225 check_added_monitors!(nodes[0], 1);
6228 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
6229 // 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.
6230 //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.
6233 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
6234 //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
6235 let chanmon_cfgs = create_chanmon_cfgs(2);
6236 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6237 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6238 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6239 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6241 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6242 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6243 let logger = test_utils::TestLogger::new();
6244 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();
6245 route.paths[0][0].fee_msat = 100;
6247 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6248 assert!(regex::Regex::new(r"Cannot send less than their minimum HTLC value \(\d+\)").unwrap().is_match(err)));
6249 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6250 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
6254 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
6255 //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6256 let chanmon_cfgs = create_chanmon_cfgs(2);
6257 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6258 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6259 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6260 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6261 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6263 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6264 let logger = test_utils::TestLogger::new();
6265 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();
6266 route.paths[0][0].fee_msat = 0;
6267 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6268 assert_eq!(err, "Cannot send 0-msat HTLC"));
6270 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6271 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
6275 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
6276 //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6277 let chanmon_cfgs = create_chanmon_cfgs(2);
6278 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6279 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6280 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6281 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6283 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6284 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6285 let logger = test_utils::TestLogger::new();
6286 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();
6287 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6288 check_added_monitors!(nodes[0], 1);
6289 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6290 updates.update_add_htlcs[0].amount_msat = 0;
6292 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6293 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
6294 check_closed_broadcast!(nodes[1], true).unwrap();
6295 check_added_monitors!(nodes[1], 1);
6299 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6300 //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6301 //It is enforced when constructing a route.
6302 let chanmon_cfgs = create_chanmon_cfgs(2);
6303 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6304 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6305 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6306 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6307 let logger = test_utils::TestLogger::new();
6309 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6311 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6312 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();
6313 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::RouteError { ref err },
6314 assert_eq!(err, &"Channel CLTV overflowed?"));
6318 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6319 //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.
6320 //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6321 //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
6322 let chanmon_cfgs = create_chanmon_cfgs(2);
6323 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6324 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6325 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6326 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6327 let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().counterparty_max_accepted_htlcs as u64;
6329 let logger = test_utils::TestLogger::new();
6330 for i in 0..max_accepted_htlcs {
6331 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6332 let payment_event = {
6333 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6334 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();
6335 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6336 check_added_monitors!(nodes[0], 1);
6338 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6339 assert_eq!(events.len(), 1);
6340 if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6341 assert_eq!(htlcs[0].htlc_id, i);
6345 SendEvent::from_event(events.remove(0))
6347 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6348 check_added_monitors!(nodes[1], 0);
6349 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6351 expect_pending_htlcs_forwardable!(nodes[1]);
6352 expect_payment_received!(nodes[1], our_payment_hash, 100000);
6354 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6355 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6356 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();
6357 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6358 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
6360 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6361 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
6365 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6366 //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.
6367 let chanmon_cfgs = create_chanmon_cfgs(2);
6368 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6369 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6370 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6371 let channel_value = 100000;
6372 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::known(), InitFeatures::known());
6373 let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).counterparty_max_htlc_value_in_flight_msat;
6375 send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight, max_in_flight);
6377 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6378 // Manually create a route over our max in flight (which our router normally automatically
6380 let route = Route { paths: vec![vec![RouteHop {
6381 pubkey: nodes[1].node.get_our_node_id(), node_features: NodeFeatures::known(), channel_features: ChannelFeatures::known(),
6382 short_channel_id: nodes[1].node.list_usable_channels()[0].short_channel_id.unwrap(),
6383 fee_msat: max_in_flight + 1, cltv_expiry_delta: TEST_FINAL_CLTV
6385 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6386 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)));
6388 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6389 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);
6391 send_payment(&nodes[0], &[&nodes[1]], max_in_flight, max_in_flight);
6394 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6396 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6397 //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
6398 let chanmon_cfgs = create_chanmon_cfgs(2);
6399 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6400 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6401 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6402 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6403 let htlc_minimum_msat: u64;
6405 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
6406 let channel = chan_lock.by_id.get(&chan.2).unwrap();
6407 htlc_minimum_msat = channel.get_holder_htlc_minimum_msat();
6410 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6411 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6412 let logger = test_utils::TestLogger::new();
6413 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();
6414 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6415 check_added_monitors!(nodes[0], 1);
6416 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6417 updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6418 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6419 assert!(nodes[1].node.list_channels().is_empty());
6420 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6421 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()));
6422 check_added_monitors!(nodes[1], 1);
6426 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6427 //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
6428 let chanmon_cfgs = create_chanmon_cfgs(2);
6429 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6430 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6431 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6432 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6433 let logger = test_utils::TestLogger::new();
6435 let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6436 let channel_reserve = chan_stat.channel_reserve_msat;
6437 let feerate = get_feerate!(nodes[0], chan.2);
6438 // The 2* and +1 are for the fee spike reserve.
6439 let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1);
6441 let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6442 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6443 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6444 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();
6445 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6446 check_added_monitors!(nodes[0], 1);
6447 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6449 // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6450 // at this time channel-initiatee receivers are not required to enforce that senders
6451 // respect the fee_spike_reserve.
6452 updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
6453 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6455 assert!(nodes[1].node.list_channels().is_empty());
6456 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6457 assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
6458 check_added_monitors!(nodes[1], 1);
6462 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
6463 //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
6464 //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
6465 let chanmon_cfgs = create_chanmon_cfgs(2);
6466 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6467 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6468 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6469 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6470 let logger = test_utils::TestLogger::new();
6472 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6473 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
6475 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6476 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();
6478 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
6479 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
6480 let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &None, cur_height).unwrap();
6481 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
6483 let mut msg = msgs::UpdateAddHTLC {
6487 payment_hash: our_payment_hash,
6488 cltv_expiry: htlc_cltv,
6489 onion_routing_packet: onion_packet.clone(),
6492 for i in 0..super::channel::OUR_MAX_HTLCS {
6493 msg.htlc_id = i as u64;
6494 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6496 msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
6497 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6499 assert!(nodes[1].node.list_channels().is_empty());
6500 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6501 assert!(regex::Regex::new(r"Remote tried to push more than our max accepted HTLCs \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6502 check_added_monitors!(nodes[1], 1);
6506 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
6507 //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
6508 let chanmon_cfgs = create_chanmon_cfgs(2);
6509 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6510 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6511 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6512 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6513 let logger = test_utils::TestLogger::new();
6515 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6516 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6517 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();
6518 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6519 check_added_monitors!(nodes[0], 1);
6520 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6521 updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).counterparty_max_htlc_value_in_flight_msat + 1;
6522 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6524 assert!(nodes[1].node.list_channels().is_empty());
6525 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6526 assert!(regex::Regex::new("Remote HTLC add would put them over our max HTLC value").unwrap().is_match(err_msg.data.as_str()));
6527 check_added_monitors!(nodes[1], 1);
6531 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6532 //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6533 let chanmon_cfgs = create_chanmon_cfgs(2);
6534 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6535 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6536 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6537 let logger = test_utils::TestLogger::new();
6539 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6540 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6541 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6542 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();
6543 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6544 check_added_monitors!(nodes[0], 1);
6545 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6546 updates.update_add_htlcs[0].cltv_expiry = 500000000;
6547 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6549 assert!(nodes[1].node.list_channels().is_empty());
6550 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6551 assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6552 check_added_monitors!(nodes[1], 1);
6556 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6557 //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6558 // We test this by first testing that that repeated HTLCs pass commitment signature checks
6559 // after disconnect and that non-sequential htlc_ids result in a channel failure.
6560 let chanmon_cfgs = create_chanmon_cfgs(2);
6561 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6562 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6563 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6564 let logger = test_utils::TestLogger::new();
6566 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6567 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6568 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6569 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();
6570 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6571 check_added_monitors!(nodes[0], 1);
6572 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6573 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6575 //Disconnect and Reconnect
6576 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6577 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6578 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6579 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6580 assert_eq!(reestablish_1.len(), 1);
6581 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6582 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6583 assert_eq!(reestablish_2.len(), 1);
6584 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6585 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6586 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6587 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6590 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6591 assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6592 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6593 check_added_monitors!(nodes[1], 1);
6594 let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6596 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6598 assert!(nodes[1].node.list_channels().is_empty());
6599 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6600 assert!(regex::Regex::new(r"Remote skipped HTLC ID \(skipped ID: \d+\)").unwrap().is_match(err_msg.data.as_str()));
6601 check_added_monitors!(nodes[1], 1);
6605 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6606 //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.
6608 let chanmon_cfgs = create_chanmon_cfgs(2);
6609 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6610 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6611 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6612 let logger = test_utils::TestLogger::new();
6613 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6614 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6615 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6616 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();
6617 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6619 check_added_monitors!(nodes[0], 1);
6620 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6621 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6623 let update_msg = msgs::UpdateFulfillHTLC{
6626 payment_preimage: our_payment_preimage,
6629 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6631 assert!(nodes[0].node.list_channels().is_empty());
6632 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6633 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()));
6634 check_added_monitors!(nodes[0], 1);
6638 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6639 //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.
6641 let chanmon_cfgs = create_chanmon_cfgs(2);
6642 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6643 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6644 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6645 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6646 let logger = test_utils::TestLogger::new();
6648 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6649 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6650 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();
6651 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6652 check_added_monitors!(nodes[0], 1);
6653 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6654 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6656 let update_msg = msgs::UpdateFailHTLC{
6659 reason: msgs::OnionErrorPacket { data: Vec::new()},
6662 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6664 assert!(nodes[0].node.list_channels().is_empty());
6665 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6666 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()));
6667 check_added_monitors!(nodes[0], 1);
6671 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6672 //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.
6674 let chanmon_cfgs = create_chanmon_cfgs(2);
6675 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6676 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6677 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6678 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6679 let logger = test_utils::TestLogger::new();
6681 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6682 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6683 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();
6684 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6685 check_added_monitors!(nodes[0], 1);
6686 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6687 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6688 let update_msg = msgs::UpdateFailMalformedHTLC{
6691 sha256_of_onion: [1; 32],
6692 failure_code: 0x8000,
6695 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6697 assert!(nodes[0].node.list_channels().is_empty());
6698 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6699 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()));
6700 check_added_monitors!(nodes[0], 1);
6704 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
6705 //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
6707 let chanmon_cfgs = create_chanmon_cfgs(2);
6708 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6709 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6710 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6711 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6713 let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6715 nodes[1].node.claim_funds(our_payment_preimage, &None, 100_000);
6716 check_added_monitors!(nodes[1], 1);
6718 let events = nodes[1].node.get_and_clear_pending_msg_events();
6719 assert_eq!(events.len(), 1);
6720 let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6722 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, .. } } => {
6723 assert!(update_add_htlcs.is_empty());
6724 assert_eq!(update_fulfill_htlcs.len(), 1);
6725 assert!(update_fail_htlcs.is_empty());
6726 assert!(update_fail_malformed_htlcs.is_empty());
6727 assert!(update_fee.is_none());
6728 update_fulfill_htlcs[0].clone()
6730 _ => panic!("Unexpected event"),
6734 update_fulfill_msg.htlc_id = 1;
6736 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6738 assert!(nodes[0].node.list_channels().is_empty());
6739 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6740 assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
6741 check_added_monitors!(nodes[0], 1);
6745 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
6746 //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.
6748 let chanmon_cfgs = create_chanmon_cfgs(2);
6749 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6750 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6751 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6752 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6754 let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6756 nodes[1].node.claim_funds(our_payment_preimage, &None, 100_000);
6757 check_added_monitors!(nodes[1], 1);
6759 let events = nodes[1].node.get_and_clear_pending_msg_events();
6760 assert_eq!(events.len(), 1);
6761 let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6763 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, .. } } => {
6764 assert!(update_add_htlcs.is_empty());
6765 assert_eq!(update_fulfill_htlcs.len(), 1);
6766 assert!(update_fail_htlcs.is_empty());
6767 assert!(update_fail_malformed_htlcs.is_empty());
6768 assert!(update_fee.is_none());
6769 update_fulfill_htlcs[0].clone()
6771 _ => panic!("Unexpected event"),
6775 update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
6777 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6779 assert!(nodes[0].node.list_channels().is_empty());
6780 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6781 assert!(regex::Regex::new(r"Remote tried to fulfill HTLC \(\d+\) with an incorrect preimage").unwrap().is_match(err_msg.data.as_str()));
6782 check_added_monitors!(nodes[0], 1);
6786 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
6787 //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.
6789 let chanmon_cfgs = create_chanmon_cfgs(2);
6790 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6791 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6792 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6793 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6794 let logger = test_utils::TestLogger::new();
6796 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6797 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6798 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();
6799 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6800 check_added_monitors!(nodes[0], 1);
6802 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6803 updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6805 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6806 check_added_monitors!(nodes[1], 0);
6807 commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
6809 let events = nodes[1].node.get_and_clear_pending_msg_events();
6811 let mut update_msg: msgs::UpdateFailMalformedHTLC = {
6813 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, .. } } => {
6814 assert!(update_add_htlcs.is_empty());
6815 assert!(update_fulfill_htlcs.is_empty());
6816 assert!(update_fail_htlcs.is_empty());
6817 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6818 assert!(update_fee.is_none());
6819 update_fail_malformed_htlcs[0].clone()
6821 _ => panic!("Unexpected event"),
6824 update_msg.failure_code &= !0x8000;
6825 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6827 assert!(nodes[0].node.list_channels().is_empty());
6828 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6829 assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
6830 check_added_monitors!(nodes[0], 1);
6834 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
6835 //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
6836 // * 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.
6838 let chanmon_cfgs = create_chanmon_cfgs(3);
6839 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6840 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6841 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6842 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6843 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6844 let logger = test_utils::TestLogger::new();
6846 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6849 let mut payment_event = {
6850 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6851 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();
6852 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6853 check_added_monitors!(nodes[0], 1);
6854 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6855 assert_eq!(events.len(), 1);
6856 SendEvent::from_event(events.remove(0))
6858 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6859 check_added_monitors!(nodes[1], 0);
6860 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6861 expect_pending_htlcs_forwardable!(nodes[1]);
6862 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
6863 assert_eq!(events_2.len(), 1);
6864 check_added_monitors!(nodes[1], 1);
6865 payment_event = SendEvent::from_event(events_2.remove(0));
6866 assert_eq!(payment_event.msgs.len(), 1);
6869 payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6870 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
6871 check_added_monitors!(nodes[2], 0);
6872 commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
6874 let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
6875 assert_eq!(events_3.len(), 1);
6876 let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
6878 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 } } => {
6879 assert!(update_add_htlcs.is_empty());
6880 assert!(update_fulfill_htlcs.is_empty());
6881 assert!(update_fail_htlcs.is_empty());
6882 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6883 assert!(update_fee.is_none());
6884 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
6886 _ => panic!("Unexpected event"),
6890 nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
6892 check_added_monitors!(nodes[1], 0);
6893 commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
6894 expect_pending_htlcs_forwardable!(nodes[1]);
6895 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
6896 assert_eq!(events_4.len(), 1);
6898 //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
6900 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, .. } } => {
6901 assert!(update_add_htlcs.is_empty());
6902 assert!(update_fulfill_htlcs.is_empty());
6903 assert_eq!(update_fail_htlcs.len(), 1);
6904 assert!(update_fail_malformed_htlcs.is_empty());
6905 assert!(update_fee.is_none());
6907 _ => panic!("Unexpected event"),
6910 check_added_monitors!(nodes[1], 1);
6913 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
6914 // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
6915 // 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
6916 // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
6918 let mut chanmon_cfgs = create_chanmon_cfgs(2);
6919 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
6920 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6921 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6922 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6923 let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6925 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
6927 // We route 2 dust-HTLCs between A and B
6928 let (_, payment_hash_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6929 let (_, payment_hash_2) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6930 route_payment(&nodes[0], &[&nodes[1]], 1000000);
6932 // Cache one local commitment tx as previous
6933 let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6935 // Fail one HTLC to prune it in the will-be-latest-local commitment tx
6936 assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2, &None));
6937 check_added_monitors!(nodes[1], 0);
6938 expect_pending_htlcs_forwardable!(nodes[1]);
6939 check_added_monitors!(nodes[1], 1);
6941 let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6942 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
6943 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
6944 check_added_monitors!(nodes[0], 1);
6946 // Cache one local commitment tx as lastest
6947 let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6949 let events = nodes[0].node.get_and_clear_pending_msg_events();
6951 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
6952 assert_eq!(node_id, nodes[1].node.get_our_node_id());
6954 _ => panic!("Unexpected event"),
6957 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
6958 assert_eq!(node_id, nodes[1].node.get_our_node_id());
6960 _ => panic!("Unexpected event"),
6963 assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
6964 // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
6965 if announce_latest {
6966 mine_transaction(&nodes[0], &as_last_commitment_tx[0]);
6968 mine_transaction(&nodes[0], &as_prev_commitment_tx[0]);
6971 check_closed_broadcast!(nodes[0], false);
6972 check_added_monitors!(nodes[0], 1);
6974 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6975 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, nodes[0].best_block_info().1, false, Default::default());
6976 let events = nodes[0].node.get_and_clear_pending_events();
6977 // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
6978 assert_eq!(events.len(), 2);
6979 let mut first_failed = false;
6980 for event in events {
6982 Event::PaymentFailed { payment_hash, .. } => {
6983 if payment_hash == payment_hash_1 {
6984 assert!(!first_failed);
6985 first_failed = true;
6987 assert_eq!(payment_hash, payment_hash_2);
6990 _ => panic!("Unexpected event"),
6996 fn test_failure_delay_dust_htlc_local_commitment() {
6997 do_test_failure_delay_dust_htlc_local_commitment(true);
6998 do_test_failure_delay_dust_htlc_local_commitment(false);
7001 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
7002 // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
7003 // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
7004 // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
7005 // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
7006 // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
7007 // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
7009 let chanmon_cfgs = create_chanmon_cfgs(3);
7010 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7011 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7012 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7013 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7015 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7017 let (_payment_preimage_1, dust_hash) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7018 let (_payment_preimage_2, non_dust_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7020 let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7021 let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
7023 // We revoked bs_commitment_tx
7025 let (payment_preimage_3, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7026 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 1_000_000);
7029 let mut timeout_tx = Vec::new();
7031 // We fail dust-HTLC 1 by broadcast of local commitment tx
7032 mine_transaction(&nodes[0], &as_commitment_tx[0]);
7033 check_closed_broadcast!(nodes[0], false);
7034 check_added_monitors!(nodes[0], 1);
7035 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7036 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
7037 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, nodes[0].best_block_info().1, false, Default::default());
7038 expect_payment_failed!(nodes[0], dust_hash, true);
7039 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7040 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
7041 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7042 mine_transaction(&nodes[0], &timeout_tx[0]);
7043 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, nodes[0].best_block_info().1, false, Default::default());
7044 expect_payment_failed!(nodes[0], non_dust_hash, true);
7046 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
7047 mine_transaction(&nodes[0], &bs_commitment_tx[0]);
7048 check_closed_broadcast!(nodes[0], false);
7049 check_added_monitors!(nodes[0], 1);
7050 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7051 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
7052 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, nodes[0].best_block_info().1, false, Default::default());
7054 expect_payment_failed!(nodes[0], dust_hash, true);
7055 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7056 // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
7057 mine_transaction(&nodes[0], &timeout_tx[0]);
7058 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7059 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, nodes[0].best_block_info().1, false, Default::default());
7060 expect_payment_failed!(nodes[0], non_dust_hash, true);
7062 // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
7064 let events = nodes[0].node.get_and_clear_pending_events();
7065 assert_eq!(events.len(), 2);
7068 Event::PaymentFailed { payment_hash, .. } => {
7069 if payment_hash == dust_hash { first = true; }
7070 else { first = false; }
7072 _ => panic!("Unexpected event"),
7075 Event::PaymentFailed { payment_hash, .. } => {
7076 if first { assert_eq!(payment_hash, non_dust_hash); }
7077 else { assert_eq!(payment_hash, dust_hash); }
7079 _ => panic!("Unexpected event"),
7086 fn test_sweep_outbound_htlc_failure_update() {
7087 do_test_sweep_outbound_htlc_failure_update(false, true);
7088 do_test_sweep_outbound_htlc_failure_update(false, false);
7089 do_test_sweep_outbound_htlc_failure_update(true, false);
7093 fn test_upfront_shutdown_script() {
7094 // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
7095 // enforce it at shutdown message
7097 let mut config = UserConfig::default();
7098 config.channel_options.announced_channel = true;
7099 config.peer_channel_config_limits.force_announced_channel_preference = false;
7100 config.channel_options.commit_upfront_shutdown_pubkey = false;
7101 let user_cfgs = [None, Some(config), None];
7102 let chanmon_cfgs = create_chanmon_cfgs(3);
7103 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7104 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7105 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7107 // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
7108 let flags = InitFeatures::known();
7109 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7110 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7111 let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7112 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7113 // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that we disconnect peer
7114 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7115 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()));
7116 check_added_monitors!(nodes[2], 1);
7118 // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
7119 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7120 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7121 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7122 // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
7123 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7124 let events = nodes[2].node.get_and_clear_pending_msg_events();
7125 assert_eq!(events.len(), 1);
7127 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7128 _ => panic!("Unexpected event"),
7131 // We test that if case of peer non-signaling we don't enforce committed script at channel opening
7132 let flags_no = InitFeatures::known().clear_upfront_shutdown_script();
7133 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
7134 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7135 let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
7136 node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7137 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
7138 let events = nodes[1].node.get_and_clear_pending_msg_events();
7139 assert_eq!(events.len(), 1);
7141 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7142 _ => panic!("Unexpected event"),
7145 // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7146 // channel smoothly, opt-out is from channel initiator here
7147 let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
7148 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7149 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7150 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7151 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7152 let events = nodes[0].node.get_and_clear_pending_msg_events();
7153 assert_eq!(events.len(), 1);
7155 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7156 _ => panic!("Unexpected event"),
7159 //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7160 //// channel smoothly
7161 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
7162 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7163 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7164 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7165 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7166 let events = nodes[0].node.get_and_clear_pending_msg_events();
7167 assert_eq!(events.len(), 2);
7169 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7170 _ => panic!("Unexpected event"),
7173 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7174 _ => panic!("Unexpected event"),
7179 fn test_upfront_shutdown_script_unsupport_segwit() {
7180 // We test that channel is closed early
7181 // if a segwit program is passed as upfront shutdown script,
7182 // but the peer does not support segwit.
7183 let chanmon_cfgs = create_chanmon_cfgs(2);
7184 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7185 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7186 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7188 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
7190 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7191 open_channel.shutdown_scriptpubkey = Present(Builder::new().push_int(16)
7192 .push_slice(&[0, 0])
7195 let features = InitFeatures::known().clear_shutdown_anysegwit();
7196 nodes[0].node.handle_open_channel(&nodes[0].node.get_our_node_id(), features, &open_channel);
7198 let events = nodes[0].node.get_and_clear_pending_msg_events();
7199 assert_eq!(events.len(), 1);
7201 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7202 assert_eq!(node_id, nodes[0].node.get_our_node_id());
7203 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));
7205 _ => panic!("Unexpected event"),
7210 fn test_shutdown_script_any_segwit_allowed() {
7211 let mut config = UserConfig::default();
7212 config.channel_options.announced_channel = true;
7213 config.peer_channel_config_limits.force_announced_channel_preference = false;
7214 config.channel_options.commit_upfront_shutdown_pubkey = false;
7215 let user_cfgs = [None, Some(config), None];
7216 let chanmon_cfgs = create_chanmon_cfgs(3);
7217 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7218 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7219 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7221 //// We test if the remote peer accepts opt_shutdown_anysegwit, a witness program can be used on shutdown
7222 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7223 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7224 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7225 node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7226 .push_slice(&[0, 0])
7228 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7229 let events = nodes[0].node.get_and_clear_pending_msg_events();
7230 assert_eq!(events.len(), 2);
7232 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7233 _ => panic!("Unexpected event"),
7236 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7237 _ => panic!("Unexpected event"),
7242 fn test_shutdown_script_any_segwit_not_allowed() {
7243 let mut config = UserConfig::default();
7244 config.channel_options.announced_channel = true;
7245 config.peer_channel_config_limits.force_announced_channel_preference = false;
7246 config.channel_options.commit_upfront_shutdown_pubkey = false;
7247 let user_cfgs = [None, Some(config), None];
7248 let chanmon_cfgs = create_chanmon_cfgs(3);
7249 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7250 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7251 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7253 //// We test that if the remote peer does not accept opt_shutdown_anysegwit, the witness program cannot be used on shutdown
7254 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7255 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7256 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7257 // Make an any segwit version script
7258 node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7259 .push_slice(&[0, 0])
7261 let flags_no = InitFeatures::known().clear_shutdown_anysegwit();
7262 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &flags_no, &node_0_shutdown);
7263 let events = nodes[0].node.get_and_clear_pending_msg_events();
7264 assert_eq!(events.len(), 2);
7266 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7267 assert_eq!(node_id, nodes[1].node.get_our_node_id());
7268 assert_eq!(msg.data, "Got a nonstandard scriptpubkey (60020000) from remote peer".to_owned())
7270 _ => panic!("Unexpected event"),
7272 check_added_monitors!(nodes[0], 1);
7276 fn test_shutdown_script_segwit_but_not_anysegwit() {
7277 let mut config = UserConfig::default();
7278 config.channel_options.announced_channel = true;
7279 config.peer_channel_config_limits.force_announced_channel_preference = false;
7280 config.channel_options.commit_upfront_shutdown_pubkey = false;
7281 let user_cfgs = [None, Some(config), None];
7282 let chanmon_cfgs = create_chanmon_cfgs(3);
7283 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7284 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7285 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7287 //// We test that if shutdown any segwit is supported and we send a witness script with 0 version, this is not accepted
7288 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7289 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7290 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7291 // Make a segwit script that is not a valid as any segwit
7292 node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
7293 .push_slice(&[0, 0])
7295 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7296 let events = nodes[0].node.get_and_clear_pending_msg_events();
7297 assert_eq!(events.len(), 2);
7299 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7300 assert_eq!(node_id, nodes[1].node.get_our_node_id());
7301 assert_eq!(msg.data, "Got a nonstandard scriptpubkey (00020000) from remote peer".to_owned())
7303 _ => panic!("Unexpected event"),
7305 check_added_monitors!(nodes[0], 1);
7309 fn test_user_configurable_csv_delay() {
7310 // We test our channel constructors yield errors when we pass them absurd csv delay
7312 let mut low_our_to_self_config = UserConfig::default();
7313 low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
7314 let mut high_their_to_self_config = UserConfig::default();
7315 high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
7316 let user_cfgs = [Some(high_their_to_self_config.clone()), None];
7317 let chanmon_cfgs = create_chanmon_cfgs(2);
7318 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7319 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
7320 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7322 // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
7323 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) {
7325 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())); },
7326 _ => panic!("Unexpected event"),
7328 } else { assert!(false) }
7330 // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
7331 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7332 let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7333 open_channel.to_self_delay = 200;
7334 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) {
7336 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())); },
7337 _ => panic!("Unexpected event"),
7339 } else { assert!(false); }
7341 // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
7342 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7343 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()));
7344 let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7345 accept_channel.to_self_delay = 200;
7346 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7347 if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
7349 &ErrorAction::SendErrorMessage { ref msg } => {
7350 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()));
7352 _ => { assert!(false); }
7354 } else { assert!(false); }
7356 // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
7357 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7358 let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7359 open_channel.to_self_delay = 200;
7360 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) {
7362 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())); },
7363 _ => panic!("Unexpected event"),
7365 } else { assert!(false); }
7369 fn test_data_loss_protect() {
7370 // We want to be sure that :
7371 // * we don't broadcast our Local Commitment Tx in case of fallen behind
7372 // (but this is not quite true - we broadcast during Drop because chanmon is out of sync with chanmgr)
7373 // * we close channel in case of detecting other being fallen behind
7374 // * we are able to claim our own outputs thanks to to_remote being static
7375 // TODO: this test is incomplete and the data_loss_protect implementation is incomplete - see issue #775
7381 let mut chanmon_cfgs = create_chanmon_cfgs(2);
7382 // We broadcast during Drop because chanmon is out of sync with chanmgr, which would cause a panic
7383 // during signing due to revoked tx
7384 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7385 let keys_manager = &chanmon_cfgs[0].keys_manager;
7388 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7389 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7390 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7392 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7394 // Cache node A state before any channel update
7395 let previous_node_state = nodes[0].node.encode();
7396 let mut previous_chain_monitor_state = test_utils::TestVecWriter(Vec::new());
7397 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut previous_chain_monitor_state).unwrap();
7399 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
7400 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
7402 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7403 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7405 // Restore node A from previous state
7406 logger = test_utils::TestLogger::with_id(format!("node {}", 0));
7407 let mut chain_monitor = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut ::std::io::Cursor::new(previous_chain_monitor_state.0), keys_manager).unwrap().1;
7408 chain_source = test_utils::TestChainSource::new(Network::Testnet);
7409 tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())};
7410 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
7411 persister = test_utils::TestPersister::new();
7412 monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &fee_estimator, &persister, keys_manager);
7414 let mut channel_monitors = HashMap::new();
7415 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chain_monitor);
7416 <(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 {
7417 keys_manager: keys_manager,
7418 fee_estimator: &fee_estimator,
7419 chain_monitor: &monitor,
7421 tx_broadcaster: &tx_broadcaster,
7422 default_config: UserConfig::default(),
7426 nodes[0].node = &node_state_0;
7427 assert!(monitor.watch_channel(OutPoint { txid: chan.3.txid(), index: 0 }, chain_monitor).is_ok());
7428 nodes[0].chain_monitor = &monitor;
7429 nodes[0].chain_source = &chain_source;
7431 check_added_monitors!(nodes[0], 1);
7433 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7434 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7436 let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7438 // Check we don't broadcast any transactions following learning of per_commitment_point from B
7439 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
7440 check_added_monitors!(nodes[0], 1);
7443 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7444 assert_eq!(node_txn.len(), 0);
7447 let mut reestablish_1 = Vec::with_capacity(1);
7448 for msg in nodes[0].node.get_and_clear_pending_msg_events() {
7449 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
7450 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7451 reestablish_1.push(msg.clone());
7452 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
7453 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
7455 &ErrorAction::SendErrorMessage { ref msg } => {
7456 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");
7458 _ => panic!("Unexpected event!"),
7461 panic!("Unexpected event")
7465 // Check we close channel detecting A is fallen-behind
7466 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7467 assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
7468 check_added_monitors!(nodes[1], 1);
7471 // Check A is able to claim to_remote output
7472 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7473 assert_eq!(node_txn.len(), 1);
7474 check_spends!(node_txn[0], chan.3);
7475 assert_eq!(node_txn[0].output.len(), 2);
7476 mine_transaction(&nodes[0], &node_txn[0]);
7477 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, nodes[0].best_block_info().1, false, Default::default());
7478 let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 1000000);
7479 assert_eq!(spend_txn.len(), 1);
7480 check_spends!(spend_txn[0], node_txn[0]);
7484 fn test_check_htlc_underpaying() {
7485 // Send payment through A -> B but A is maliciously
7486 // sending a probe payment (i.e less than expected value0
7487 // to B, B should refuse payment.
7489 let chanmon_cfgs = create_chanmon_cfgs(2);
7490 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7491 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7492 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7494 // Create some initial channels
7495 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7497 let (payment_preimage, payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 10_000);
7499 // Node 3 is expecting payment of 100_000 but receive 10_000,
7500 // fail htlc like we didn't know the preimage.
7501 nodes[1].node.claim_funds(payment_preimage, &None, 100_000);
7502 nodes[1].node.process_pending_htlc_forwards();
7504 let events = nodes[1].node.get_and_clear_pending_msg_events();
7505 assert_eq!(events.len(), 1);
7506 let (update_fail_htlc, commitment_signed) = match events[0] {
7507 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 } } => {
7508 assert!(update_add_htlcs.is_empty());
7509 assert!(update_fulfill_htlcs.is_empty());
7510 assert_eq!(update_fail_htlcs.len(), 1);
7511 assert!(update_fail_malformed_htlcs.is_empty());
7512 assert!(update_fee.is_none());
7513 (update_fail_htlcs[0].clone(), commitment_signed)
7515 _ => panic!("Unexpected event"),
7517 check_added_monitors!(nodes[1], 1);
7519 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
7520 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
7522 // 10_000 msat as u64, followed by a height of CHAN_CONFIRM_DEPTH as u32
7523 let mut expected_failure_data = byte_utils::be64_to_array(10_000).to_vec();
7524 expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(CHAN_CONFIRM_DEPTH));
7525 expect_payment_failed!(nodes[0], payment_hash, true, 0x4000|15, &expected_failure_data[..]);
7526 nodes[1].node.get_and_clear_pending_events();
7530 fn test_announce_disable_channels() {
7531 // Create 2 channels between A and B. Disconnect B. Call timer_chan_freshness_every_min and check for generated
7532 // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
7534 let chanmon_cfgs = create_chanmon_cfgs(2);
7535 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7536 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7537 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7539 let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7540 let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7541 let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7544 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7545 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7547 nodes[0].node.timer_chan_freshness_every_min(); // dirty -> stagged
7548 nodes[0].node.timer_chan_freshness_every_min(); // staged -> fresh
7549 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7550 assert_eq!(msg_events.len(), 3);
7551 for e in msg_events {
7553 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7554 let short_id = msg.contents.short_channel_id;
7555 // Check generated channel_update match list in PendingChannelUpdate
7556 if short_id != short_id_1 && short_id != short_id_2 && short_id != short_id_3 {
7557 panic!("Generated ChannelUpdate for wrong chan!");
7560 _ => panic!("Unexpected event"),
7564 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7565 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7566 assert_eq!(reestablish_1.len(), 3);
7567 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7568 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7569 assert_eq!(reestablish_2.len(), 3);
7571 // Reestablish chan_1
7572 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7573 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7574 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7575 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7576 // Reestablish chan_2
7577 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
7578 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7579 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
7580 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7581 // Reestablish chan_3
7582 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
7583 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7584 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
7585 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7587 nodes[0].node.timer_chan_freshness_every_min();
7588 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7592 fn test_bump_penalty_txn_on_revoked_commitment() {
7593 // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
7594 // we're able to claim outputs on revoked commitment transaction before timelocks expiration
7596 let chanmon_cfgs = create_chanmon_cfgs(2);
7597 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7598 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7599 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7601 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7602 let logger = test_utils::TestLogger::new();
7604 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7605 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
7606 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();
7607 send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
7609 let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
7610 // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7611 assert_eq!(revoked_txn[0].output.len(), 4);
7612 assert_eq!(revoked_txn[0].input.len(), 1);
7613 assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
7614 let revoked_txid = revoked_txn[0].txid();
7616 let mut penalty_sum = 0;
7617 for outp in revoked_txn[0].output.iter() {
7618 if outp.script_pubkey.is_v0_p2wsh() {
7619 penalty_sum += outp.value;
7623 // Connect blocks to change height_timer range to see if we use right soonest_timelock
7624 let starting_height = nodes[1].best_block_info().1;
7625 let header_114 = connect_blocks(&nodes[1], 14, starting_height, false, Default::default());
7627 // Actually revoke tx by claiming a HTLC
7628 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
7629 let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7630 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_txn[0].clone()] }, 15 + starting_height);
7631 check_added_monitors!(nodes[1], 1);
7633 // One or more justice tx should have been broadcast, check it
7637 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7638 assert_eq!(node_txn.len(), 3); // justice tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout (broadcasted from ChannelManager)
7639 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7640 assert_eq!(node_txn[0].output.len(), 1);
7641 check_spends!(node_txn[0], revoked_txn[0]);
7642 let fee_1 = penalty_sum - node_txn[0].output[0].value;
7643 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
7644 penalty_1 = node_txn[0].txid();
7648 // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
7649 let header = connect_blocks(&nodes[1], 15, 15 + starting_height, true, header.block_hash());
7650 let mut penalty_2 = penalty_1;
7651 let mut feerate_2 = 0;
7653 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7654 assert_eq!(node_txn.len(), 1);
7655 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7656 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7657 assert_eq!(node_txn[0].output.len(), 1);
7658 check_spends!(node_txn[0], revoked_txn[0]);
7659 penalty_2 = node_txn[0].txid();
7660 // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7661 assert_ne!(penalty_2, penalty_1);
7662 let fee_2 = penalty_sum - node_txn[0].output[0].value;
7663 feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7664 // Verify 25% bump heuristic
7665 assert!(feerate_2 * 100 >= feerate_1 * 125);
7669 assert_ne!(feerate_2, 0);
7671 // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
7672 connect_blocks(&nodes[1], 1, 30 + starting_height, true, header);
7674 let mut feerate_3 = 0;
7676 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7677 assert_eq!(node_txn.len(), 1);
7678 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7679 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7680 assert_eq!(node_txn[0].output.len(), 1);
7681 check_spends!(node_txn[0], revoked_txn[0]);
7682 penalty_3 = node_txn[0].txid();
7683 // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7684 assert_ne!(penalty_3, penalty_2);
7685 let fee_3 = penalty_sum - node_txn[0].output[0].value;
7686 feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
7687 // Verify 25% bump heuristic
7688 assert!(feerate_3 * 100 >= feerate_2 * 125);
7692 assert_ne!(feerate_3, 0);
7694 nodes[1].node.get_and_clear_pending_events();
7695 nodes[1].node.get_and_clear_pending_msg_events();
7699 fn test_bump_penalty_txn_on_revoked_htlcs() {
7700 // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
7701 // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
7703 let mut chanmon_cfgs = create_chanmon_cfgs(2);
7704 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
7705 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7706 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7707 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7709 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7710 // Lock HTLC in both directions
7711 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3_000_000).0;
7712 route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7714 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7715 assert_eq!(revoked_local_txn[0].input.len(), 1);
7716 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7718 // Revoke local commitment tx
7719 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
7721 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7722 // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
7723 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, CHAN_CONFIRM_DEPTH + 1);
7724 check_closed_broadcast!(nodes[1], false);
7725 check_added_monitors!(nodes[1], 1);
7727 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7728 assert_eq!(revoked_htlc_txn.len(), 4);
7729 if revoked_htlc_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7730 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7731 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7732 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7733 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7734 assert_eq!(revoked_htlc_txn[1].output.len(), 1);
7735 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7736 } else if revoked_htlc_txn[1].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7737 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7738 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7739 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7740 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7741 assert_eq!(revoked_htlc_txn[0].output.len(), 1);
7742 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7745 // Broadcast set of revoked txn on A
7746 let hash_128 = connect_blocks(&nodes[0], 40, CHAN_CONFIRM_DEPTH, false, Default::default());
7747 let header_11 = BlockHeader { version: 0x20000000, prev_blockhash: hash_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7748 connect_block(&nodes[0], &Block { header: header_11, txdata: vec![revoked_local_txn[0].clone()] }, CHAN_CONFIRM_DEPTH + 40 + 1);
7749 let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_11.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7750 connect_block(&nodes[0], &Block { header: header_129, txdata: vec![revoked_htlc_txn[0].clone(), revoked_htlc_txn[1].clone()] }, CHAN_CONFIRM_DEPTH + 40 + 2);
7751 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
7756 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7757 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
7758 // Verify claim tx are spending revoked HTLC txn
7760 // node_txn 0-2 each spend a separate revoked output from revoked_local_txn[0]
7761 // Note that node_txn[0] and node_txn[1] are bogus - they double spend the revoked_htlc_txn
7762 // which are included in the same block (they are broadcasted because we scan the
7763 // transactions linearly and generate claims as we go, they likely should be removed in the
7765 assert_eq!(node_txn[0].input.len(), 1);
7766 check_spends!(node_txn[0], revoked_local_txn[0]);
7767 assert_eq!(node_txn[1].input.len(), 1);
7768 check_spends!(node_txn[1], revoked_local_txn[0]);
7769 assert_eq!(node_txn[2].input.len(), 1);
7770 check_spends!(node_txn[2], revoked_local_txn[0]);
7772 // Each of the three justice transactions claim a separate (single) output of the three
7773 // available, which we check here:
7774 assert_ne!(node_txn[0].input[0].previous_output, node_txn[1].input[0].previous_output);
7775 assert_ne!(node_txn[0].input[0].previous_output, node_txn[2].input[0].previous_output);
7776 assert_ne!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
7778 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
7779 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
7781 // node_txn[3] is the local commitment tx broadcast just because (and somewhat in case of
7782 // reorgs, though its not clear its ever worth broadcasting conflicting txn like this when
7783 // a remote commitment tx has already been confirmed).
7784 check_spends!(node_txn[3], chan.3);
7786 // node_txn[4] spends the revoked outputs from the revoked_htlc_txn (which only have one
7787 // output, checked above).
7788 assert_eq!(node_txn[4].input.len(), 2);
7789 assert_eq!(node_txn[4].output.len(), 1);
7790 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7792 first = node_txn[4].txid();
7793 // Store both feerates for later comparison
7794 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[4].output[0].value;
7795 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
7796 penalty_txn = vec![node_txn[2].clone()];
7800 // Connect one more block to see if bumped penalty are issued for HTLC txn
7801 let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7802 connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn }, CHAN_CONFIRM_DEPTH + 40 + 3);
7803 let header_131 = BlockHeader { version: 0x20000000, prev_blockhash: header_130.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7804 connect_block(&nodes[0], &Block { header: header_131, txdata: Vec::new() }, CHAN_CONFIRM_DEPTH + 40 + 4);
7806 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7807 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
7809 check_spends!(node_txn[0], revoked_local_txn[0]);
7810 check_spends!(node_txn[1], revoked_local_txn[0]);
7811 // Note that these are both bogus - they spend outputs already claimed in block 129:
7812 if node_txn[0].input[0].previous_output == revoked_htlc_txn[0].input[0].previous_output {
7813 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
7815 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
7816 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
7822 // Few more blocks to confirm penalty txn
7823 let header_135 = connect_blocks(&nodes[0], 4, CHAN_CONFIRM_DEPTH + 40 + 4, true, header_131.block_hash());
7824 assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
7825 let header_144 = connect_blocks(&nodes[0], 9, CHAN_CONFIRM_DEPTH + 40 + 8, true, header_135);
7827 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7828 assert_eq!(node_txn.len(), 1);
7830 assert_eq!(node_txn[0].input.len(), 2);
7831 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7832 // Verify bumped tx is different and 25% bump heuristic
7833 assert_ne!(first, node_txn[0].txid());
7834 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[0].output[0].value;
7835 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7836 assert!(feerate_2 * 100 > feerate_1 * 125);
7837 let txn = vec![node_txn[0].clone()];
7841 // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
7842 let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7843 connect_block(&nodes[0], &Block { header: header_145, txdata: node_txn }, CHAN_CONFIRM_DEPTH + 40 + 8 + 10);
7844 connect_blocks(&nodes[0], 20, CHAN_CONFIRM_DEPTH + 40 + 8 + 10, true, header_145.block_hash());
7846 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7847 // We verify than no new transaction has been broadcast because previously
7848 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
7849 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
7850 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
7851 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
7852 // up bumped justice generation.
7853 assert_eq!(node_txn.len(), 0);
7856 check_closed_broadcast!(nodes[0], false);
7857 check_added_monitors!(nodes[0], 1);
7861 fn test_bump_penalty_txn_on_remote_commitment() {
7862 // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
7863 // we're able to claim outputs on remote commitment transaction before timelocks expiration
7866 // Provide preimage for one
7867 // Check aggregation
7869 let chanmon_cfgs = create_chanmon_cfgs(2);
7870 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7871 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7872 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7874 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7875 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7876 route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
7878 // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7879 let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
7880 assert_eq!(remote_txn[0].output.len(), 4);
7881 assert_eq!(remote_txn[0].input.len(), 1);
7882 assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
7884 // Claim a HTLC without revocation (provide B monitor with preimage)
7885 nodes[1].node.claim_funds(payment_preimage, &None, 3_000_000);
7886 mine_transaction(&nodes[1], &remote_txn[0]);
7887 check_added_monitors!(nodes[1], 2);
7889 // One or more claim tx should have been broadcast, check it
7892 let feerate_timeout;
7893 let feerate_preimage;
7895 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7896 assert_eq!(node_txn.len(), 5); // 2 * claim tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout + local HTLC-success (broadcasted from ChannelManager)
7897 assert_eq!(node_txn[0].input.len(), 1);
7898 assert_eq!(node_txn[1].input.len(), 1);
7899 check_spends!(node_txn[0], remote_txn[0]);
7900 check_spends!(node_txn[1], remote_txn[0]);
7901 check_spends!(node_txn[2], chan.3);
7902 check_spends!(node_txn[3], node_txn[2]);
7903 check_spends!(node_txn[4], node_txn[2]);
7904 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7905 timeout = node_txn[0].txid();
7906 let index = node_txn[0].input[0].previous_output.vout;
7907 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7908 feerate_timeout = fee * 1000 / node_txn[0].get_weight() as u64;
7910 preimage = node_txn[1].txid();
7911 let index = node_txn[1].input[0].previous_output.vout;
7912 let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7913 feerate_preimage = fee * 1000 / node_txn[1].get_weight() as u64;
7915 timeout = node_txn[1].txid();
7916 let index = node_txn[1].input[0].previous_output.vout;
7917 let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7918 feerate_timeout = fee * 1000 / node_txn[1].get_weight() as u64;
7920 preimage = node_txn[0].txid();
7921 let index = node_txn[0].input[0].previous_output.vout;
7922 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7923 feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
7927 assert_ne!(feerate_timeout, 0);
7928 assert_ne!(feerate_preimage, 0);
7930 // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
7931 connect_blocks(&nodes[1], 15, nodes[1].best_block_info().1, false, Default::default());
7933 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7934 assert_eq!(node_txn.len(), 2);
7935 assert_eq!(node_txn[0].input.len(), 1);
7936 assert_eq!(node_txn[1].input.len(), 1);
7937 check_spends!(node_txn[0], remote_txn[0]);
7938 check_spends!(node_txn[1], remote_txn[0]);
7939 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7940 let index = node_txn[0].input[0].previous_output.vout;
7941 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7942 let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
7943 assert!(new_feerate * 100 > feerate_timeout * 125);
7944 assert_ne!(timeout, node_txn[0].txid());
7946 let index = node_txn[1].input[0].previous_output.vout;
7947 let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7948 let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
7949 assert!(new_feerate * 100 > feerate_preimage * 125);
7950 assert_ne!(preimage, node_txn[1].txid());
7952 let index = node_txn[1].input[0].previous_output.vout;
7953 let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7954 let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
7955 assert!(new_feerate * 100 > feerate_timeout * 125);
7956 assert_ne!(timeout, node_txn[1].txid());
7958 let index = node_txn[0].input[0].previous_output.vout;
7959 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7960 let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
7961 assert!(new_feerate * 100 > feerate_preimage * 125);
7962 assert_ne!(preimage, node_txn[0].txid());
7967 nodes[1].node.get_and_clear_pending_events();
7968 nodes[1].node.get_and_clear_pending_msg_events();
7972 fn test_counterparty_raa_skip_no_crash() {
7973 // Previously, if our counterparty sent two RAAs in a row without us having provided a
7974 // commitment transaction, we would have happily carried on and provided them the next
7975 // commitment transaction based on one RAA forward. This would probably eventually have led to
7976 // channel closure, but it would not have resulted in funds loss. Still, our
7977 // EnforcingSigner would have paniced as it doesn't like jumps into the future. Here, we
7978 // check simply that the channel is closed in response to such an RAA, but don't check whether
7979 // we decide to punish our counterparty for revoking their funds (as we don't currently
7981 let chanmon_cfgs = create_chanmon_cfgs(2);
7982 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7983 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7984 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7985 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
7987 let mut guard = nodes[0].node.channel_state.lock().unwrap();
7988 let keys = &guard.by_id.get_mut(&channel_id).unwrap().get_signer();
7989 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
7990 let per_commitment_secret = keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER);
7991 // Must revoke without gaps
7992 keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 1);
7993 let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
7994 &SecretKey::from_slice(&keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
7996 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
7997 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
7998 assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
7999 check_added_monitors!(nodes[1], 1);
8003 fn test_bump_txn_sanitize_tracking_maps() {
8004 // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
8005 // verify we clean then right after expiration of ANTI_REORG_DELAY.
8007 let chanmon_cfgs = create_chanmon_cfgs(2);
8008 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8009 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8010 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8012 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8013 // Lock HTLC in both directions
8014 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8015 route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
8017 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8018 assert_eq!(revoked_local_txn[0].input.len(), 1);
8019 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8021 // Revoke local commitment tx
8022 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 9_000_000);
8024 // Broadcast set of revoked txn on A
8025 connect_blocks(&nodes[0], 52 - CHAN_CONFIRM_DEPTH, CHAN_CONFIRM_DEPTH, false, Default::default());
8026 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8027 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 0);
8029 mine_transaction(&nodes[0], &revoked_local_txn[0]);
8030 check_closed_broadcast!(nodes[0], false);
8031 check_added_monitors!(nodes[0], 1);
8033 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8034 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
8035 check_spends!(node_txn[0], revoked_local_txn[0]);
8036 check_spends!(node_txn[1], revoked_local_txn[0]);
8037 check_spends!(node_txn[2], revoked_local_txn[0]);
8038 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
8042 let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8043 connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn }, nodes[0].best_block_info().1 + 1);
8044 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, nodes[0].best_block_info().1, false, Default::default());
8046 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8047 if let Some(monitor) = monitors.get(&OutPoint { txid: chan.3.txid(), index: 0 }) {
8048 assert!(monitor.inner.lock().unwrap().onchain_tx_handler.pending_claim_requests.is_empty());
8049 assert!(monitor.inner.lock().unwrap().onchain_tx_handler.claimable_outpoints.is_empty());
8055 fn test_override_channel_config() {
8056 let chanmon_cfgs = create_chanmon_cfgs(2);
8057 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8058 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8059 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8061 // Node0 initiates a channel to node1 using the override config.
8062 let mut override_config = UserConfig::default();
8063 override_config.own_channel_config.our_to_self_delay = 200;
8065 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
8067 // Assert the channel created by node0 is using the override config.
8068 let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8069 assert_eq!(res.channel_flags, 0);
8070 assert_eq!(res.to_self_delay, 200);
8074 fn test_override_0msat_htlc_minimum() {
8075 let mut zero_config = UserConfig::default();
8076 zero_config.own_channel_config.our_htlc_minimum_msat = 0;
8077 let chanmon_cfgs = create_chanmon_cfgs(2);
8078 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8079 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
8080 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8082 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
8083 let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8084 assert_eq!(res.htlc_minimum_msat, 1);
8086 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &res);
8087 let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8088 assert_eq!(res.htlc_minimum_msat, 1);
8092 fn test_simple_payment_secret() {
8093 // Simple test of sending a payment with a payment_secret present. This does not use any AMP
8094 // features, however.
8095 let chanmon_cfgs = create_chanmon_cfgs(3);
8096 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8097 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8098 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8100 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8101 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
8102 let logger = test_utils::TestLogger::new();
8104 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(&nodes[0]);
8105 let payment_secret = PaymentSecret([0xdb; 32]);
8106 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8107 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();
8108 send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2]]], 100000, payment_hash, Some(payment_secret.clone()));
8109 // Claiming with all the correct values but the wrong secret should result in nothing...
8110 assert_eq!(nodes[2].node.claim_funds(payment_preimage, &None, 100_000), false);
8111 assert_eq!(nodes[2].node.claim_funds(payment_preimage, &Some(PaymentSecret([42; 32])), 100_000), false);
8112 // ...but with the right secret we should be able to claim all the way back
8113 claim_payment_along_route_with_secret(&nodes[0], &[&[&nodes[1], &nodes[2]]], false, payment_preimage, Some(payment_secret.clone()), 100_000);
8117 fn test_simple_mpp() {
8118 // Simple test of sending a multi-path payment.
8119 let chanmon_cfgs = create_chanmon_cfgs(4);
8120 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8121 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8122 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8124 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8125 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8126 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8127 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8128 let logger = test_utils::TestLogger::new();
8130 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(&nodes[0]);
8131 let payment_secret = PaymentSecret([0xdb; 32]);
8132 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8133 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();
8134 let path = route.paths[0].clone();
8135 route.paths.push(path);
8136 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8137 route.paths[0][0].short_channel_id = chan_1_id;
8138 route.paths[0][1].short_channel_id = chan_3_id;
8139 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8140 route.paths[1][0].short_channel_id = chan_2_id;
8141 route.paths[1][1].short_channel_id = chan_4_id;
8142 send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, Some(payment_secret.clone()));
8143 // Claiming with all the correct values but the wrong secret should result in nothing...
8144 assert_eq!(nodes[3].node.claim_funds(payment_preimage, &None, 200_000), false);
8145 assert_eq!(nodes[3].node.claim_funds(payment_preimage, &Some(PaymentSecret([42; 32])), 200_000), false);
8146 // ...but with the right secret we should be able to claim all the way back
8147 claim_payment_along_route_with_secret(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage, Some(payment_secret), 200_000);
8151 fn test_update_err_monitor_lockdown() {
8152 // Our monitor will lock update of local commitment transaction if a broadcastion condition
8153 // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
8154 // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateErr.
8156 // This scenario may happen in a watchtower setup, where watchtower process a block height
8157 // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
8158 // commitment at same time.
8160 let chanmon_cfgs = create_chanmon_cfgs(2);
8161 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8162 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8163 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8165 // Create some initial channel
8166 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8167 let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8169 // Rebalance the network to generate htlc in the two directions
8170 send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000, 10_000_000);
8172 // Route a HTLC from node 0 to node 1 (but don't settle)
8173 let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8175 // Copy ChainMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
8176 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8177 let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
8178 let persister = test_utils::TestPersister::new();
8180 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8181 let monitor = monitors.get(&outpoint).unwrap();
8182 let mut w = test_utils::TestVecWriter(Vec::new());
8183 monitor.write(&mut w).unwrap();
8184 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8185 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8186 assert!(new_monitor == *monitor);
8187 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);
8188 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8191 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8192 watchtower.chain_monitor.block_connected(&header, &[], 200);
8194 // Try to update ChannelMonitor
8195 assert!(nodes[1].node.claim_funds(preimage, &None, 9_000_000));
8196 check_added_monitors!(nodes[1], 1);
8197 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8198 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8199 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8200 if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8201 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8202 if let Err(_) = watchtower.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8203 if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8204 } else { assert!(false); }
8205 } else { assert!(false); };
8206 // Our local monitor is in-sync and hasn't processed yet timeout
8207 check_added_monitors!(nodes[0], 1);
8208 let events = nodes[0].node.get_and_clear_pending_events();
8209 assert_eq!(events.len(), 1);
8213 fn test_concurrent_monitor_claim() {
8214 // Watchtower A receives block, broadcasts state N, then channel receives new state N+1,
8215 // sending it to both watchtowers, Bob accepts N+1, then receives block and broadcasts
8216 // the latest state N+1, Alice rejects state N+1, but Bob has already broadcast it,
8217 // state N+1 confirms. Alice claims output from state N+1.
8219 let chanmon_cfgs = create_chanmon_cfgs(2);
8220 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8221 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8222 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8224 // Create some initial channel
8225 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8226 let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8228 // Rebalance the network to generate htlc in the two directions
8229 send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000, 10_000_000);
8231 // Route a HTLC from node 0 to node 1 (but don't settle)
8232 route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8234 // Copy ChainMonitor to simulate watchtower Alice and update block height her ChannelMonitor timeout HTLC onchain
8235 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8236 let logger = test_utils::TestLogger::with_id(format!("node {}", "Alice"));
8237 let persister = test_utils::TestPersister::new();
8238 let watchtower_alice = {
8239 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8240 let monitor = monitors.get(&outpoint).unwrap();
8241 let mut w = test_utils::TestVecWriter(Vec::new());
8242 monitor.write(&mut w).unwrap();
8243 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8244 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8245 assert!(new_monitor == *monitor);
8246 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);
8247 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8250 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8251 watchtower_alice.chain_monitor.block_connected(&header, &vec![], CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8253 // Watchtower Alice should have broadcast a commitment/HTLC-timeout
8255 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8256 assert_eq!(txn.len(), 2);
8260 // Copy ChainMonitor to simulate watchtower Bob and make it receive a commitment update first.
8261 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8262 let logger = test_utils::TestLogger::with_id(format!("node {}", "Bob"));
8263 let persister = test_utils::TestPersister::new();
8264 let watchtower_bob = {
8265 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8266 let monitor = monitors.get(&outpoint).unwrap();
8267 let mut w = test_utils::TestVecWriter(Vec::new());
8268 monitor.write(&mut w).unwrap();
8269 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8270 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8271 assert!(new_monitor == *monitor);
8272 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);
8273 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8276 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8277 watchtower_bob.chain_monitor.block_connected(&header, &vec![], CHAN_CONFIRM_DEPTH + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8279 // Route another payment to generate another update with still previous HTLC pending
8280 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
8282 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
8283 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();
8284 nodes[1].node.send_payment(&route, payment_hash, &None).unwrap();
8286 check_added_monitors!(nodes[1], 1);
8288 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8289 assert_eq!(updates.update_add_htlcs.len(), 1);
8290 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &updates.update_add_htlcs[0]);
8291 if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8292 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8293 // Watchtower Alice should already have seen the block and reject the update
8294 if let Err(_) = watchtower_alice.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8295 if let Ok(_) = watchtower_bob.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8296 if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8297 } else { assert!(false); }
8298 } else { assert!(false); };
8299 // Our local monitor is in-sync and hasn't processed yet timeout
8300 check_added_monitors!(nodes[0], 1);
8302 //// Provide one more block to watchtower Bob, expect broadcast of commitment and HTLC-Timeout
8303 watchtower_bob.chain_monitor.block_connected(&header, &vec![], CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8305 // Watchtower Bob should have broadcast a commitment/HTLC-timeout
8308 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8309 assert_eq!(txn.len(), 2);
8310 bob_state_y = txn[0].clone();
8314 // We confirm Bob's state Y on Alice, she should broadcast a HTLC-timeout
8315 watchtower_alice.chain_monitor.block_connected(&header, &vec![(0, &bob_state_y)], CHAN_CONFIRM_DEPTH + 2 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8317 let htlc_txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8318 // We broadcast twice the transaction, once due to the HTLC-timeout, once due
8319 // the onchain detection of the HTLC output
8320 assert_eq!(htlc_txn.len(), 2);
8321 check_spends!(htlc_txn[0], bob_state_y);
8322 check_spends!(htlc_txn[1], bob_state_y);
8327 fn test_pre_lockin_no_chan_closed_update() {
8328 // Test that if a peer closes a channel in response to a funding_created message we don't
8329 // generate a channel update (as the channel cannot appear on chain without a funding_signed
8332 // Doing so would imply a channel monitor update before the initial channel monitor
8333 // registration, violating our API guarantees.
8335 // Previously, full_stack_target managed to hit this case by opening then closing a channel,
8336 // then opening a second channel with the same funding output as the first (which is not
8337 // rejected because the first channel does not exist in the ChannelManager) and closing it
8338 // before receiving funding_signed.
8339 let chanmon_cfgs = create_chanmon_cfgs(2);
8340 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8341 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8342 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8344 // Create an initial channel
8345 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8346 let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8347 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8348 let accept_chan_msg = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8349 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_chan_msg);
8351 // Move the first channel through the funding flow...
8352 let (temporary_channel_id, _tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
8354 nodes[0].node.funding_transaction_generated(&temporary_channel_id, funding_output);
8355 check_added_monitors!(nodes[0], 0);
8357 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8358 let channel_id = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
8359 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id, data: "Hi".to_owned() });
8360 assert!(nodes[0].chain_monitor.added_monitors.lock().unwrap().is_empty());
8364 fn test_htlc_no_detection() {
8365 // This test is a mutation to underscore the detection logic bug we had
8366 // before #653. HTLC value routed is above the remaining balance, thus
8367 // inverting HTLC and `to_remote` output. HTLC will come second and
8368 // it wouldn't be seen by pre-#653 detection as we were enumerate()'ing
8369 // on a watched outputs vector (Vec<TxOut>) thus implicitly relying on
8370 // outputs order detection for correct spending children filtring.
8372 let chanmon_cfgs = create_chanmon_cfgs(2);
8373 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8374 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8375 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8377 // Create some initial channels
8378 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8380 send_payment(&nodes[0], &vec!(&nodes[1])[..], 1_000_000, 1_000_000);
8381 let (_, our_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 2_000_000);
8382 let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
8383 assert_eq!(local_txn[0].input.len(), 1);
8384 assert_eq!(local_txn[0].output.len(), 3);
8385 check_spends!(local_txn[0], chan_1.3);
8387 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
8388 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8389 connect_block(&nodes[0], &Block { header, txdata: vec![local_txn[0].clone()] }, nodes[0].best_block_info().1 + 1);
8390 // We deliberately connect the local tx twice as this should provoke a failure calling
8391 // this test before #653 fix.
8392 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);
8393 check_closed_broadcast!(nodes[0], false);
8394 check_added_monitors!(nodes[0], 1);
8396 let htlc_timeout = {
8397 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8398 assert_eq!(node_txn[0].input.len(), 1);
8399 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8400 check_spends!(node_txn[0], local_txn[0]);
8404 let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8405 connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] }, nodes[0].best_block_info().1 + 1);
8406 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, nodes[0].best_block_info().1, false, Default::default());
8407 expect_payment_failed!(nodes[0], our_payment_hash, true);
8410 fn do_test_onchain_htlc_settlement_after_close(broadcast_alice: bool, go_onchain_before_fulfill: bool) {
8411 // If we route an HTLC, then learn the HTLC's preimage after the upstream channel has been
8412 // force-closed, we must claim that HTLC on-chain. (Given an HTLC forwarded from Alice --> Bob -->
8413 // Carol, Alice would be the upstream node, and Carol the downstream.)
8415 // Steps of the test:
8416 // 1) Alice sends a HTLC to Carol through Bob.
8417 // 2) Carol doesn't settle the HTLC.
8418 // 3) If broadcast_alice is true, Alice force-closes her channel with Bob. Else Bob force closes.
8419 // Steps 4 and 5 may be reordered depending on go_onchain_before_fulfill.
8420 // 4) Bob sees the Alice's commitment on his chain or vice versa. An offered output is present
8421 // but can't be claimed as Bob doesn't have yet knowledge of the preimage.
8422 // 5) Carol release the preimage to Bob off-chain.
8423 // 6) Bob claims the offered output on the broadcasted commitment.
8424 let chanmon_cfgs = create_chanmon_cfgs(3);
8425 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8426 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8427 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8429 // Create some initial channels
8430 let chan_ab = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8431 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8433 // Steps (1) and (2):
8434 // Send an HTLC Alice --> Bob --> Carol, but Carol doesn't settle the HTLC back.
8435 let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3_000_000);
8437 // Check that Alice's commitment transaction now contains an output for this HTLC.
8438 let alice_txn = get_local_commitment_txn!(nodes[0], chan_ab.2);
8439 check_spends!(alice_txn[0], chan_ab.3);
8440 assert_eq!(alice_txn[0].output.len(), 2);
8441 check_spends!(alice_txn[1], alice_txn[0]); // 2nd transaction is a non-final HTLC-timeout
8442 assert_eq!(alice_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8443 assert_eq!(alice_txn.len(), 2);
8445 // Steps (3) and (4):
8446 // If `go_onchain_before_fufill`, broadcast the relevant commitment transaction and check that Bob
8447 // responds by (1) broadcasting a channel update and (2) adding a new ChannelMonitor.
8448 let mut force_closing_node = 0; // Alice force-closes
8449 if !broadcast_alice { force_closing_node = 1; } // Bob force-closes
8450 nodes[force_closing_node].node.force_close_channel(&chan_ab.2).unwrap();
8451 check_closed_broadcast!(nodes[force_closing_node], false);
8452 check_added_monitors!(nodes[force_closing_node], 1);
8453 if go_onchain_before_fulfill {
8454 let txn_to_broadcast = match broadcast_alice {
8455 true => alice_txn.clone(),
8456 false => get_local_commitment_txn!(nodes[1], chan_ab.2)
8458 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8459 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]}, CHAN_CONFIRM_DEPTH * 2 + 1);
8460 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8461 if broadcast_alice {
8462 check_closed_broadcast!(nodes[1], false);
8463 check_added_monitors!(nodes[1], 1);
8465 assert_eq!(bob_txn.len(), 1);
8466 check_spends!(bob_txn[0], chan_ab.3);
8470 // Carol then claims the funds and sends an update_fulfill message to Bob, and they go through the
8471 // process of removing the HTLC from their commitment transactions.
8472 assert!(nodes[2].node.claim_funds(payment_preimage, &None, 3_000_000));
8473 check_added_monitors!(nodes[2], 1);
8474 let carol_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
8475 assert!(carol_updates.update_add_htlcs.is_empty());
8476 assert!(carol_updates.update_fail_htlcs.is_empty());
8477 assert!(carol_updates.update_fail_malformed_htlcs.is_empty());
8478 assert!(carol_updates.update_fee.is_none());
8479 assert_eq!(carol_updates.update_fulfill_htlcs.len(), 1);
8481 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &carol_updates.update_fulfill_htlcs[0]);
8482 // If Alice broadcasted but Bob doesn't know yet, here he prepares to tell her about the preimage.
8483 if !go_onchain_before_fulfill && broadcast_alice {
8484 let events = nodes[1].node.get_and_clear_pending_msg_events();
8485 assert_eq!(events.len(), 1);
8487 MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
8488 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
8490 _ => panic!("Unexpected event"),
8493 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &carol_updates.commitment_signed);
8494 // One monitor update for the preimage to update the Bob<->Alice channel, one monitor update
8495 // Carol<->Bob's updated commitment transaction info.
8496 check_added_monitors!(nodes[1], 2);
8498 let events = nodes[1].node.get_and_clear_pending_msg_events();
8499 assert_eq!(events.len(), 2);
8500 let bob_revocation = match events[0] {
8501 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8502 assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8505 _ => panic!("Unexpected event"),
8507 let bob_updates = match events[1] {
8508 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
8509 assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8512 _ => panic!("Unexpected event"),
8515 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bob_revocation);
8516 check_added_monitors!(nodes[2], 1);
8517 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bob_updates.commitment_signed);
8518 check_added_monitors!(nodes[2], 1);
8520 let events = nodes[2].node.get_and_clear_pending_msg_events();
8521 assert_eq!(events.len(), 1);
8522 let carol_revocation = match events[0] {
8523 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8524 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
8527 _ => panic!("Unexpected event"),
8529 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &carol_revocation);
8530 check_added_monitors!(nodes[1], 1);
8532 // If this test requires the force-closed channel to not be on-chain until after the fulfill,
8533 // here's where we put said channel's commitment tx on-chain.
8534 let mut txn_to_broadcast = alice_txn.clone();
8535 if !broadcast_alice { txn_to_broadcast = get_local_commitment_txn!(nodes[1], chan_ab.2); }
8536 if !go_onchain_before_fulfill {
8537 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8538 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]}, CHAN_CONFIRM_DEPTH * 2 + 1);
8539 // If Bob was the one to force-close, he will have already passed these checks earlier.
8540 if broadcast_alice {
8541 check_closed_broadcast!(nodes[1], false);
8542 check_added_monitors!(nodes[1], 1);
8544 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8545 if broadcast_alice {
8546 // In `connect_block()`, the ChainMonitor and ChannelManager are separately notified about a
8547 // new block being connected. The ChannelManager being notified triggers a monitor update,
8548 // which triggers broadcasting our commitment tx and an HTLC-claiming tx. The ChainMonitor
8549 // being notified triggers the HTLC-claiming tx redundantly, resulting in 3 total txs being
8551 assert_eq!(bob_txn.len(), 3);
8552 check_spends!(bob_txn[1], chan_ab.3);
8554 assert_eq!(bob_txn.len(), 2);
8555 check_spends!(bob_txn[0], chan_ab.3);
8560 // Finally, check that Bob broadcasted a preimage-claiming transaction for the HTLC output on the
8561 // broadcasted commitment transaction.
8563 let bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
8564 if go_onchain_before_fulfill {
8565 // Bob should now have an extra broadcasted tx, for the preimage-claiming transaction.
8566 assert_eq!(bob_txn.len(), 2);
8568 let script_weight = match broadcast_alice {
8569 true => OFFERED_HTLC_SCRIPT_WEIGHT,
8570 false => ACCEPTED_HTLC_SCRIPT_WEIGHT
8572 // If Alice force-closed and Bob didn't receive her commitment transaction until after he
8573 // received Carol's fulfill, he broadcasts the HTLC-output-claiming transaction first. Else if
8574 // Bob force closed or if he found out about Alice's commitment tx before receiving Carol's
8575 // fulfill, then he broadcasts the HTLC-output-claiming transaction second.
8576 if broadcast_alice && !go_onchain_before_fulfill {
8577 check_spends!(bob_txn[0], txn_to_broadcast[0]);
8578 assert_eq!(bob_txn[0].input[0].witness.last().unwrap().len(), script_weight);
8580 check_spends!(bob_txn[1], txn_to_broadcast[0]);
8581 assert_eq!(bob_txn[1].input[0].witness.last().unwrap().len(), script_weight);
8587 fn test_onchain_htlc_settlement_after_close() {
8588 do_test_onchain_htlc_settlement_after_close(true, true);
8589 do_test_onchain_htlc_settlement_after_close(false, true); // Technically redundant, but may as well
8590 do_test_onchain_htlc_settlement_after_close(true, false);
8591 do_test_onchain_htlc_settlement_after_close(false, false);
8595 fn test_duplicate_chan_id() {
8596 // Test that if a given peer tries to open a channel with the same channel_id as one that is
8597 // already open we reject it and keep the old channel.
8599 // Previously, full_stack_target managed to figure out that if you tried to open two channels
8600 // with the same funding output (ie post-funding channel_id), we'd create a monitor update for
8601 // the existing channel when we detect the duplicate new channel, screwing up our monitor
8602 // updating logic for the existing channel.
8603 let chanmon_cfgs = create_chanmon_cfgs(2);
8604 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8605 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8606 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8608 // Create an initial channel
8609 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8610 let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8611 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8612 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()));
8614 // Try to create a second channel with the same temporary_channel_id as the first and check
8615 // that it is rejected.
8616 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8618 let events = nodes[1].node.get_and_clear_pending_msg_events();
8619 assert_eq!(events.len(), 1);
8621 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8622 // Technically, at this point, nodes[1] would be justified in thinking both the
8623 // first (valid) and second (invalid) channels are closed, given they both have
8624 // the same non-temporary channel_id. However, currently we do not, so we just
8625 // move forward with it.
8626 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
8627 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8629 _ => panic!("Unexpected event"),
8633 // Move the first channel through the funding flow...
8634 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
8636 nodes[0].node.funding_transaction_generated(&temporary_channel_id, funding_output);
8637 check_added_monitors!(nodes[0], 0);
8639 let mut funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8640 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
8642 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
8643 assert_eq!(added_monitors.len(), 1);
8644 assert_eq!(added_monitors[0].0, funding_output);
8645 added_monitors.clear();
8647 let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
8649 let funding_outpoint = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index };
8650 let channel_id = funding_outpoint.to_channel_id();
8652 // Now we have the first channel past funding_created (ie it has a txid-based channel_id, not a
8655 // First try to open a second channel with a temporary channel id equal to the txid-based one.
8656 // Technically this is allowed by the spec, but we don't support it and there's little reason
8657 // to. Still, it shouldn't cause any other issues.
8658 open_chan_msg.temporary_channel_id = channel_id;
8659 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8661 let events = nodes[1].node.get_and_clear_pending_msg_events();
8662 assert_eq!(events.len(), 1);
8664 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8665 // Technically, at this point, nodes[1] would be justified in thinking both
8666 // channels are closed, but currently we do not, so we just move forward with it.
8667 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
8668 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8670 _ => panic!("Unexpected event"),
8674 // Now try to create a second channel which has a duplicate funding output.
8675 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8676 let open_chan_2_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8677 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_2_msg);
8678 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()));
8679 create_funding_transaction(&nodes[0], 100000, 42); // Get and check the FundingGenerationReady event
8681 let funding_created = {
8682 let mut a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
8683 let mut as_chan = a_channel_lock.by_id.get_mut(&open_chan_2_msg.temporary_channel_id).unwrap();
8684 let logger = test_utils::TestLogger::new();
8685 as_chan.get_outbound_funding_created(funding_outpoint, &&logger).unwrap()
8687 check_added_monitors!(nodes[0], 0);
8688 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
8689 // At this point we'll try to add a duplicate channel monitor, which will be rejected, but
8690 // still needs to be cleared here.
8691 check_added_monitors!(nodes[1], 1);
8693 // ...still, nodes[1] will reject the duplicate channel.
8695 let events = nodes[1].node.get_and_clear_pending_msg_events();
8696 assert_eq!(events.len(), 1);
8698 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8699 // Technically, at this point, nodes[1] would be justified in thinking both
8700 // channels are closed, but currently we do not, so we just move forward with it.
8701 assert_eq!(msg.channel_id, channel_id);
8702 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8704 _ => panic!("Unexpected event"),
8708 // finally, finish creating the original channel and send a payment over it to make sure
8709 // everything is functional.
8710 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
8712 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
8713 assert_eq!(added_monitors.len(), 1);
8714 assert_eq!(added_monitors[0].0, funding_output);
8715 added_monitors.clear();
8718 let events_4 = nodes[0].node.get_and_clear_pending_events();
8719 assert_eq!(events_4.len(), 1);
8721 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
8722 assert_eq!(user_channel_id, 42);
8723 assert_eq!(*funding_txo, funding_output);
8725 _ => panic!("Unexpected event"),
8728 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
8729 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
8730 update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
8731 send_payment(&nodes[0], &[&nodes[1]], 8000000, 8_000_000);
8735 fn test_error_chans_closed() {
8736 // Test that we properly handle error messages, closing appropriate channels.
8738 // Prior to #787 we'd allow a peer to make us force-close a channel we had with a different
8739 // peer. The "real" fix for that is to index channels with peers_ids, however in the mean time
8740 // we can test various edge cases around it to ensure we don't regress.
8741 let chanmon_cfgs = create_chanmon_cfgs(3);
8742 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8743 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8744 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8746 // Create some initial channels
8747 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8748 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8749 let chan_3 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8751 assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
8752 assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
8753 assert_eq!(nodes[2].node.list_usable_channels().len(), 1);
8755 // Closing a channel from a different peer has no effect
8756 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_3.2, data: "ERR".to_owned() });
8757 assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
8759 // Closing one channel doesn't impact others
8760 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_2.2, data: "ERR".to_owned() });
8761 check_added_monitors!(nodes[0], 1);
8762 check_closed_broadcast!(nodes[0], false);
8763 assert_eq!(nodes[0].node.list_usable_channels().len(), 2);
8764 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);
8765 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);
8767 // A null channel ID should close all channels
8768 let _chan_4 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8769 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: [0; 32], data: "ERR".to_owned() });
8770 check_added_monitors!(nodes[0], 2);
8771 let events = nodes[0].node.get_and_clear_pending_msg_events();
8772 assert_eq!(events.len(), 2);
8774 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
8775 assert_eq!(msg.contents.flags & 2, 2);
8777 _ => panic!("Unexpected event"),
8780 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
8781 assert_eq!(msg.contents.flags & 2, 2);
8783 _ => panic!("Unexpected event"),
8785 // Note that at this point users of a standard PeerHandler will end up calling
8786 // peer_disconnected with no_connection_possible set to false, duplicating the
8787 // close-all-channels logic. That's OK, we don't want to end up not force-closing channels for
8788 // users with their own peer handling logic. We duplicate the call here, however.
8789 assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
8790 assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
8792 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), true);
8793 assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
8794 assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);