1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! Tests that test standing up a network of ChannelManagers, creating channels, sending
11 //! payments/messages between them, and often checking the resulting ChannelMonitors are able to
12 //! claim outputs on-chain.
15 use chain::channelmonitor;
16 use chain::channelmonitor::{ChannelMonitor, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY};
17 use chain::transaction::OutPoint;
18 use chain::keysinterface::{ChannelKeys, KeysInterface, SpendableOutputDescriptor};
19 use ln::channel::{COMMITMENT_TX_BASE_WEIGHT, COMMITMENT_TX_WEIGHT_PER_HTLC};
20 use ln::channelmanager::{ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentPreimage, PaymentHash, PaymentSecret, PaymentSendFailure, BREAKDOWN_TIMEOUT};
21 use ln::channel::{Channel, ChannelError};
22 use ln::{chan_utils, onion_utils};
23 use routing::router::{Route, RouteHop, get_route};
24 use ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
26 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler,HTLCFailChannelUpdate, ErrorAction};
27 use util::enforcing_trait_impls::EnforcingChannelKeys;
28 use util::{byte_utils, test_utils};
29 use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
30 use util::errors::APIError;
31 use util::ser::{Writeable, ReadableArgs};
32 use util::config::UserConfig;
34 use bitcoin::hashes::sha256d::Hash as Sha256dHash;
35 use bitcoin::hash_types::{Txid, BlockHash};
36 use bitcoin::util::bip143;
37 use bitcoin::util::address::Address;
38 use bitcoin::util::bip32::{ChildNumber, ExtendedPubKey, ExtendedPrivKey};
39 use bitcoin::blockdata::block::{Block, BlockHeader};
40 use bitcoin::blockdata::transaction::{Transaction, TxOut, TxIn, SigHashType};
41 use bitcoin::blockdata::script::{Builder, Script};
42 use bitcoin::blockdata::opcodes;
43 use bitcoin::blockdata::constants::genesis_block;
44 use bitcoin::network::constants::Network;
46 use bitcoin::hashes::sha256::Hash as Sha256;
47 use bitcoin::hashes::Hash;
49 use bitcoin::secp256k1::{Secp256k1, Message};
50 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
54 use std::collections::{BTreeSet, HashMap, HashSet};
55 use std::default::Default;
57 use std::sync::atomic::Ordering;
60 use ln::functional_test_utils::*;
61 use ln::chan_utils::CommitmentTransaction;
64 fn test_insane_channel_opens() {
65 // Stand up a network of 2 nodes
66 let chanmon_cfgs = create_chanmon_cfgs(2);
67 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
68 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
69 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
71 // Instantiate channel parameters where we push the maximum msats given our
73 let channel_value_sat = 31337; // same as funding satoshis
74 let channel_reserve_satoshis = Channel::<EnforcingChannelKeys>::get_holder_selected_channel_reserve_satoshis(channel_value_sat);
75 let push_msat = (channel_value_sat - channel_reserve_satoshis) * 1000;
77 // Have node0 initiate a channel to node1 with aforementioned parameters
78 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_sat, push_msat, 42, None).unwrap();
80 // Extract the channel open message from node0 to node1
81 let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
83 // Test helper that asserts we get the correct error string given a mutator
84 // that supposedly makes the channel open message insane
85 let insane_open_helper = |expected_error_str: &str, message_mutator: fn(msgs::OpenChannel) -> msgs::OpenChannel| {
86 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &message_mutator(open_channel_message.clone()));
87 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
88 assert_eq!(msg_events.len(), 1);
89 let expected_regex = regex::Regex::new(expected_error_str).unwrap();
90 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
92 &ErrorAction::SendErrorMessage { .. } => {
93 nodes[1].logger.assert_log_regex("lightning::ln::channelmanager".to_string(), expected_regex, 1);
95 _ => panic!("unexpected event!"),
97 } else { assert!(false); }
100 use ln::channel::MAX_FUNDING_SATOSHIS;
101 use ln::channelmanager::MAX_LOCAL_BREAKDOWN_TIMEOUT;
103 // Test all mutations that would make the channel open message insane
104 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 });
106 insane_open_helper("Bogus channel_reserve_satoshis", |mut msg| { msg.channel_reserve_satoshis = msg.funding_satoshis + 1; msg });
108 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 });
110 insane_open_helper("Peer never wants payout outputs?", |mut msg| { msg.dust_limit_satoshis = msg.funding_satoshis + 1 ; msg });
112 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 });
114 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 });
116 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 });
118 insane_open_helper("0 max_accepted_htlcs makes for a useless channel", |mut msg| { msg.max_accepted_htlcs = 0; msg });
120 insane_open_helper("max_accepted_htlcs was 484. It must not be larger than 483", |mut msg| { msg.max_accepted_htlcs = 484; msg });
124 fn test_async_inbound_update_fee() {
125 let chanmon_cfgs = create_chanmon_cfgs(2);
126 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
127 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
128 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
129 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
130 let logger = test_utils::TestLogger::new();
131 let channel_id = chan.2;
134 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
138 // send (1) commitment_signed -.
139 // <- update_add_htlc/commitment_signed
140 // send (2) RAA (awaiting remote revoke) -.
141 // (1) commitment_signed is delivered ->
142 // .- send (3) RAA (awaiting remote revoke)
143 // (2) RAA is delivered ->
144 // .- send (4) commitment_signed
145 // <- (3) RAA is delivered
146 // send (5) commitment_signed -.
147 // <- (4) commitment_signed is delivered
149 // (5) commitment_signed is delivered ->
151 // (6) RAA is delivered ->
153 // First nodes[0] generates an update_fee
154 nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
155 check_added_monitors!(nodes[0], 1);
157 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
158 assert_eq!(events_0.len(), 1);
159 let (update_msg, commitment_signed) = match events_0[0] { // (1)
160 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
161 (update_fee.as_ref(), commitment_signed)
163 _ => panic!("Unexpected event"),
166 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
168 // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
169 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
170 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
171 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, &Vec::new(), 40000, TEST_FINAL_CLTV, &logger).unwrap(), our_payment_hash, &None).unwrap();
172 check_added_monitors!(nodes[1], 1);
174 let payment_event = {
175 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
176 assert_eq!(events_1.len(), 1);
177 SendEvent::from_event(events_1.remove(0))
179 assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
180 assert_eq!(payment_event.msgs.len(), 1);
182 // ...now when the messages get delivered everyone should be happy
183 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
184 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
185 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
186 // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
187 check_added_monitors!(nodes[0], 1);
189 // deliver(1), generate (3):
190 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
191 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
192 // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
193 check_added_monitors!(nodes[1], 1);
195 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack); // deliver (2)
196 let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
197 assert!(bs_update.update_add_htlcs.is_empty()); // (4)
198 assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
199 assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
200 assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
201 assert!(bs_update.update_fee.is_none()); // (4)
202 check_added_monitors!(nodes[1], 1);
204 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack); // deliver (3)
205 let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
206 assert!(as_update.update_add_htlcs.is_empty()); // (5)
207 assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
208 assert!(as_update.update_fail_htlcs.is_empty()); // (5)
209 assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
210 assert!(as_update.update_fee.is_none()); // (5)
211 check_added_monitors!(nodes[0], 1);
213 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed); // deliver (4)
214 let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
215 // only (6) so get_event_msg's assert(len == 1) passes
216 check_added_monitors!(nodes[0], 1);
218 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed); // deliver (5)
219 let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
220 check_added_monitors!(nodes[1], 1);
222 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
223 check_added_monitors!(nodes[0], 1);
225 let events_2 = nodes[0].node.get_and_clear_pending_events();
226 assert_eq!(events_2.len(), 1);
228 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
229 _ => panic!("Unexpected event"),
232 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke); // deliver (6)
233 check_added_monitors!(nodes[1], 1);
237 fn test_update_fee_unordered_raa() {
238 // Just the intro to the previous test followed by an out-of-order RAA (which caused a
239 // crash in an earlier version of the update_fee patch)
240 let chanmon_cfgs = create_chanmon_cfgs(2);
241 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
242 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
243 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
244 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
245 let channel_id = chan.2;
246 let logger = test_utils::TestLogger::new();
249 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
251 // First nodes[0] generates an update_fee
252 nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
253 check_added_monitors!(nodes[0], 1);
255 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
256 assert_eq!(events_0.len(), 1);
257 let update_msg = match events_0[0] { // (1)
258 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
261 _ => panic!("Unexpected event"),
264 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
266 // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
267 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
268 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
269 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, &Vec::new(), 40000, TEST_FINAL_CLTV, &logger).unwrap(), our_payment_hash, &None).unwrap();
270 check_added_monitors!(nodes[1], 1);
272 let payment_event = {
273 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
274 assert_eq!(events_1.len(), 1);
275 SendEvent::from_event(events_1.remove(0))
277 assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
278 assert_eq!(payment_event.msgs.len(), 1);
280 // ...now when the messages get delivered everyone should be happy
281 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
282 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
283 let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
284 // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
285 check_added_monitors!(nodes[0], 1);
287 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg); // deliver (2)
288 check_added_monitors!(nodes[1], 1);
290 // We can't continue, sadly, because our (1) now has a bogus signature
294 fn test_multi_flight_update_fee() {
295 let chanmon_cfgs = create_chanmon_cfgs(2);
296 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
297 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
298 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
299 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
300 let channel_id = chan.2;
303 // update_fee/commitment_signed ->
304 // .- send (1) RAA and (2) commitment_signed
305 // update_fee (never committed) ->
307 // We have to manually generate the above update_fee, it is allowed by the protocol but we
308 // don't track which updates correspond to which revoke_and_ack responses so we're in
309 // AwaitingRAA mode and will not generate the update_fee yet.
310 // <- (1) RAA delivered
311 // (3) is generated and send (4) CS -.
312 // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
313 // know the per_commitment_point to use for it.
314 // <- (2) commitment_signed delivered
316 // B should send no response here
317 // (4) commitment_signed delivered ->
318 // <- RAA/commitment_signed delivered
321 // First nodes[0] generates an update_fee
322 let initial_feerate = get_feerate!(nodes[0], channel_id);
323 nodes[0].node.update_fee(channel_id, initial_feerate + 20).unwrap();
324 check_added_monitors!(nodes[0], 1);
326 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
327 assert_eq!(events_0.len(), 1);
328 let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
329 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
330 (update_fee.as_ref().unwrap(), commitment_signed)
332 _ => panic!("Unexpected event"),
335 // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
336 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1);
337 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1);
338 let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
339 check_added_monitors!(nodes[1], 1);
341 // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
343 nodes[0].node.update_fee(channel_id, initial_feerate + 40).unwrap();
344 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
345 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
347 // Create the (3) update_fee message that nodes[0] will generate before it does...
348 let mut update_msg_2 = msgs::UpdateFee {
349 channel_id: update_msg_1.channel_id.clone(),
350 feerate_per_kw: (initial_feerate + 30) as u32,
353 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
355 update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
357 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
359 // Deliver (1), generating (3) and (4)
360 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg);
361 let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
362 check_added_monitors!(nodes[0], 1);
363 assert!(as_second_update.update_add_htlcs.is_empty());
364 assert!(as_second_update.update_fulfill_htlcs.is_empty());
365 assert!(as_second_update.update_fail_htlcs.is_empty());
366 assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
367 // Check that the update_fee newly generated matches what we delivered:
368 assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
369 assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
371 // Deliver (2) commitment_signed
372 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
373 let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
374 check_added_monitors!(nodes[0], 1);
375 // No commitment_signed so get_event_msg's assert(len == 1) passes
377 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg);
378 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
379 check_added_monitors!(nodes[1], 1);
382 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
383 let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
384 check_added_monitors!(nodes[1], 1);
386 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
387 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
388 check_added_monitors!(nodes[0], 1);
390 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment);
391 let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
392 // No commitment_signed so get_event_msg's assert(len == 1) passes
393 check_added_monitors!(nodes[0], 1);
395 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke);
396 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
397 check_added_monitors!(nodes[1], 1);
401 fn test_1_conf_open() {
402 // Previously, if the minium_depth config was set to 1, we'd never send a funding_locked. This
403 // tests that we properly send one in that case.
404 let mut alice_config = UserConfig::default();
405 alice_config.own_channel_config.minimum_depth = 1;
406 alice_config.channel_options.announced_channel = true;
407 alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
408 let mut bob_config = UserConfig::default();
409 bob_config.own_channel_config.minimum_depth = 1;
410 bob_config.channel_options.announced_channel = true;
411 bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
412 let chanmon_cfgs = create_chanmon_cfgs(2);
413 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
414 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(alice_config), Some(bob_config)]);
415 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
417 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
419 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
422 connect_block(&nodes[1], &block, 1);
423 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()));
425 connect_block(&nodes[0], &block, 1);
426 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
427 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
430 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
431 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
432 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
436 fn do_test_sanity_on_in_flight_opens(steps: u8) {
437 // Previously, we had issues deserializing channels when we hadn't connected the first block
438 // after creation. To catch that and similar issues, we lean on the Node::drop impl to test
439 // serialization round-trips and simply do steps towards opening a channel and then drop the
442 let chanmon_cfgs = create_chanmon_cfgs(2);
443 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
444 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
445 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
447 if steps & 0b1000_0000 != 0{
449 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
452 connect_block(&nodes[0], &block, 1);
453 connect_block(&nodes[1], &block, 1);
456 if steps & 0x0f == 0 { return; }
457 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
458 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
460 if steps & 0x0f == 1 { return; }
461 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
462 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
464 if steps & 0x0f == 2 { return; }
465 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
467 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
469 if steps & 0x0f == 3 { return; }
470 nodes[0].node.funding_transaction_generated(&temporary_channel_id, funding_output);
471 check_added_monitors!(nodes[0], 0);
472 let funding_created = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
474 if steps & 0x0f == 4 { return; }
475 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
477 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
478 assert_eq!(added_monitors.len(), 1);
479 assert_eq!(added_monitors[0].0, funding_output);
480 added_monitors.clear();
482 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
484 if steps & 0x0f == 5 { return; }
485 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
487 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
488 assert_eq!(added_monitors.len(), 1);
489 assert_eq!(added_monitors[0].0, funding_output);
490 added_monitors.clear();
493 let events_4 = nodes[0].node.get_and_clear_pending_events();
494 assert_eq!(events_4.len(), 1);
496 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
497 assert_eq!(user_channel_id, 42);
498 assert_eq!(*funding_txo, funding_output);
500 _ => panic!("Unexpected event"),
503 if steps & 0x0f == 6 { return; }
504 create_chan_between_nodes_with_value_confirm_first(&nodes[0], &nodes[1], &tx);
506 if steps & 0x0f == 7 { return; }
507 confirm_transaction(&nodes[0], &tx);
508 create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
512 fn test_sanity_on_in_flight_opens() {
513 do_test_sanity_on_in_flight_opens(0);
514 do_test_sanity_on_in_flight_opens(0 | 0b1000_0000);
515 do_test_sanity_on_in_flight_opens(1);
516 do_test_sanity_on_in_flight_opens(1 | 0b1000_0000);
517 do_test_sanity_on_in_flight_opens(2);
518 do_test_sanity_on_in_flight_opens(2 | 0b1000_0000);
519 do_test_sanity_on_in_flight_opens(3);
520 do_test_sanity_on_in_flight_opens(3 | 0b1000_0000);
521 do_test_sanity_on_in_flight_opens(4);
522 do_test_sanity_on_in_flight_opens(4 | 0b1000_0000);
523 do_test_sanity_on_in_flight_opens(5);
524 do_test_sanity_on_in_flight_opens(5 | 0b1000_0000);
525 do_test_sanity_on_in_flight_opens(6);
526 do_test_sanity_on_in_flight_opens(6 | 0b1000_0000);
527 do_test_sanity_on_in_flight_opens(7);
528 do_test_sanity_on_in_flight_opens(7 | 0b1000_0000);
529 do_test_sanity_on_in_flight_opens(8);
530 do_test_sanity_on_in_flight_opens(8 | 0b1000_0000);
534 fn test_update_fee_vanilla() {
535 let chanmon_cfgs = create_chanmon_cfgs(2);
536 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
537 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
538 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
539 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
540 let channel_id = chan.2;
542 let feerate = get_feerate!(nodes[0], channel_id);
543 nodes[0].node.update_fee(channel_id, feerate+25).unwrap();
544 check_added_monitors!(nodes[0], 1);
546 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
547 assert_eq!(events_0.len(), 1);
548 let (update_msg, commitment_signed) = match events_0[0] {
549 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 } } => {
550 (update_fee.as_ref(), commitment_signed)
552 _ => panic!("Unexpected event"),
554 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
556 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
557 let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
558 check_added_monitors!(nodes[1], 1);
560 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
561 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
562 check_added_monitors!(nodes[0], 1);
564 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
565 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
566 // No commitment_signed so get_event_msg's assert(len == 1) passes
567 check_added_monitors!(nodes[0], 1);
569 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
570 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
571 check_added_monitors!(nodes[1], 1);
575 fn test_update_fee_that_funder_cannot_afford() {
576 let chanmon_cfgs = create_chanmon_cfgs(2);
577 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
578 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
579 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
580 let channel_value = 1888;
581 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000, InitFeatures::known(), InitFeatures::known());
582 let channel_id = chan.2;
585 nodes[0].node.update_fee(channel_id, feerate).unwrap();
586 check_added_monitors!(nodes[0], 1);
587 let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
589 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap());
591 commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
593 //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
594 //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
596 let commitment_tx = get_local_commitment_txn!(nodes[1], channel_id)[0].clone();
598 //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
599 let num_htlcs = commitment_tx.output.len() - 2;
600 let total_fee: u64 = feerate as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
601 let mut actual_fee = commitment_tx.output.iter().fold(0, |acc, output| acc + output.value);
602 actual_fee = channel_value - actual_fee;
603 assert_eq!(total_fee, actual_fee);
606 //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
607 //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
608 nodes[0].node.update_fee(channel_id, feerate+2).unwrap();
609 check_added_monitors!(nodes[0], 1);
611 let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
613 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap());
615 //While producing the commitment_signed response after handling a received update_fee request the
616 //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
617 //Should produce and error.
618 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed);
619 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Funding remote cannot afford proposed new fee".to_string(), 1);
620 check_added_monitors!(nodes[1], 1);
621 check_closed_broadcast!(nodes[1], true);
625 fn test_update_fee_with_fundee_update_add_htlc() {
626 let chanmon_cfgs = create_chanmon_cfgs(2);
627 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
628 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
629 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
630 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
631 let channel_id = chan.2;
632 let logger = test_utils::TestLogger::new();
635 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
637 let feerate = get_feerate!(nodes[0], channel_id);
638 nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
639 check_added_monitors!(nodes[0], 1);
641 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
642 assert_eq!(events_0.len(), 1);
643 let (update_msg, commitment_signed) = match events_0[0] {
644 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 } } => {
645 (update_fee.as_ref(), commitment_signed)
647 _ => panic!("Unexpected event"),
649 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
650 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
651 let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
652 check_added_monitors!(nodes[1], 1);
654 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[1]);
655 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
656 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, &Vec::new(), 800000, TEST_FINAL_CLTV, &logger).unwrap();
658 // nothing happens since node[1] is in AwaitingRemoteRevoke
659 nodes[1].node.send_payment(&route, our_payment_hash, &None).unwrap();
661 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
662 assert_eq!(added_monitors.len(), 0);
663 added_monitors.clear();
665 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
666 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
667 // node[1] has nothing to do
669 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
670 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
671 check_added_monitors!(nodes[0], 1);
673 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
674 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
675 // No commitment_signed so get_event_msg's assert(len == 1) passes
676 check_added_monitors!(nodes[0], 1);
677 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
678 check_added_monitors!(nodes[1], 1);
679 // AwaitingRemoteRevoke ends here
681 let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
682 assert_eq!(commitment_update.update_add_htlcs.len(), 1);
683 assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
684 assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
685 assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
686 assert_eq!(commitment_update.update_fee.is_none(), true);
688 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]);
689 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
690 check_added_monitors!(nodes[0], 1);
691 let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
693 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke);
694 check_added_monitors!(nodes[1], 1);
695 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
697 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
698 check_added_monitors!(nodes[1], 1);
699 let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
700 // No commitment_signed so get_event_msg's assert(len == 1) passes
702 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke);
703 check_added_monitors!(nodes[0], 1);
704 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
706 expect_pending_htlcs_forwardable!(nodes[0]);
708 let events = nodes[0].node.get_and_clear_pending_events();
709 assert_eq!(events.len(), 1);
711 Event::PaymentReceived { .. } => { },
712 _ => panic!("Unexpected event"),
715 claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage, 800_000);
717 send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000, 800_000);
718 send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000, 800_000);
719 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
723 fn test_update_fee() {
724 let chanmon_cfgs = create_chanmon_cfgs(2);
725 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
726 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
727 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
728 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
729 let channel_id = chan.2;
732 // (1) update_fee/commitment_signed ->
733 // <- (2) revoke_and_ack
734 // .- send (3) commitment_signed
735 // (4) update_fee/commitment_signed ->
736 // .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
737 // <- (3) commitment_signed delivered
738 // send (6) revoke_and_ack -.
739 // <- (5) deliver revoke_and_ack
740 // (6) deliver revoke_and_ack ->
741 // .- send (7) commitment_signed in response to (4)
742 // <- (7) deliver commitment_signed
745 // Create and deliver (1)...
746 let feerate = get_feerate!(nodes[0], channel_id);
747 nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
748 check_added_monitors!(nodes[0], 1);
750 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
751 assert_eq!(events_0.len(), 1);
752 let (update_msg, commitment_signed) = match events_0[0] {
753 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 } } => {
754 (update_fee.as_ref(), commitment_signed)
756 _ => panic!("Unexpected event"),
758 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
760 // Generate (2) and (3):
761 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
762 let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
763 check_added_monitors!(nodes[1], 1);
766 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
767 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
768 check_added_monitors!(nodes[0], 1);
770 // Create and deliver (4)...
771 nodes[0].node.update_fee(channel_id, feerate+30).unwrap();
772 check_added_monitors!(nodes[0], 1);
773 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
774 assert_eq!(events_0.len(), 1);
775 let (update_msg, commitment_signed) = match events_0[0] {
776 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 } } => {
777 (update_fee.as_ref(), commitment_signed)
779 _ => panic!("Unexpected event"),
782 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
783 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
784 check_added_monitors!(nodes[1], 1);
786 let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
787 // No commitment_signed so get_event_msg's assert(len == 1) passes
789 // Handle (3), creating (6):
790 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0);
791 check_added_monitors!(nodes[0], 1);
792 let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
793 // No commitment_signed so get_event_msg's assert(len == 1) passes
796 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
797 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
798 check_added_monitors!(nodes[0], 1);
800 // Deliver (6), creating (7):
801 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0);
802 let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
803 assert!(commitment_update.update_add_htlcs.is_empty());
804 assert!(commitment_update.update_fulfill_htlcs.is_empty());
805 assert!(commitment_update.update_fail_htlcs.is_empty());
806 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
807 assert!(commitment_update.update_fee.is_none());
808 check_added_monitors!(nodes[1], 1);
811 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
812 check_added_monitors!(nodes[0], 1);
813 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
814 // No commitment_signed so get_event_msg's assert(len == 1) passes
816 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
817 check_added_monitors!(nodes[1], 1);
818 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
820 assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
821 assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
822 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
826 fn pre_funding_lock_shutdown_test() {
827 // Test sending a shutdown prior to funding_locked after funding generation
828 let chanmon_cfgs = create_chanmon_cfgs(2);
829 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
830 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
831 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
832 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0, InitFeatures::known(), InitFeatures::known());
833 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
834 connect_block(&nodes[0], &Block { header, txdata: vec![tx.clone()]}, 1);
835 connect_block(&nodes[1], &Block { header, txdata: vec![tx.clone()]}, 1);
837 nodes[0].node.close_channel(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id()).unwrap();
838 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
839 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
840 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
841 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
843 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
844 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
845 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
846 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
847 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
848 assert!(node_0_none.is_none());
850 assert!(nodes[0].node.list_channels().is_empty());
851 assert!(nodes[1].node.list_channels().is_empty());
855 fn updates_shutdown_wait() {
856 // Test sending a shutdown with outstanding updates pending
857 let chanmon_cfgs = create_chanmon_cfgs(3);
858 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
859 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
860 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
861 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
862 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
863 let logger = test_utils::TestLogger::new();
865 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
867 nodes[0].node.close_channel(&chan_1.2).unwrap();
868 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
869 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
870 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
871 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
873 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
874 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
876 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
878 let net_graph_msg_handler0 = &nodes[0].net_graph_msg_handler;
879 let net_graph_msg_handler1 = &nodes[1].net_graph_msg_handler;
880 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, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
881 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, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
882 unwrap_send_err!(nodes[0].node.send_payment(&route_1, payment_hash, &None), true, APIError::ChannelUnavailable {..}, {});
883 unwrap_send_err!(nodes[1].node.send_payment(&route_2, payment_hash, &None), true, APIError::ChannelUnavailable {..}, {});
885 assert!(nodes[2].node.claim_funds(our_payment_preimage, &None, 100_000));
886 check_added_monitors!(nodes[2], 1);
887 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
888 assert!(updates.update_add_htlcs.is_empty());
889 assert!(updates.update_fail_htlcs.is_empty());
890 assert!(updates.update_fail_malformed_htlcs.is_empty());
891 assert!(updates.update_fee.is_none());
892 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
893 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
894 check_added_monitors!(nodes[1], 1);
895 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
896 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
898 assert!(updates_2.update_add_htlcs.is_empty());
899 assert!(updates_2.update_fail_htlcs.is_empty());
900 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
901 assert!(updates_2.update_fee.is_none());
902 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
903 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
904 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
906 let events = nodes[0].node.get_and_clear_pending_events();
907 assert_eq!(events.len(), 1);
909 Event::PaymentSent { ref payment_preimage } => {
910 assert_eq!(our_payment_preimage, *payment_preimage);
912 _ => panic!("Unexpected event"),
915 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
916 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
917 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
918 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
919 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
920 assert!(node_0_none.is_none());
922 assert!(nodes[0].node.list_channels().is_empty());
924 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
925 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
926 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
927 assert!(nodes[1].node.list_channels().is_empty());
928 assert!(nodes[2].node.list_channels().is_empty());
932 fn htlc_fail_async_shutdown() {
933 // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
934 let chanmon_cfgs = create_chanmon_cfgs(3);
935 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
936 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
937 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
938 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
939 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
940 let logger = test_utils::TestLogger::new();
942 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
943 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
944 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, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
945 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
946 check_added_monitors!(nodes[0], 1);
947 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
948 assert_eq!(updates.update_add_htlcs.len(), 1);
949 assert!(updates.update_fulfill_htlcs.is_empty());
950 assert!(updates.update_fail_htlcs.is_empty());
951 assert!(updates.update_fail_malformed_htlcs.is_empty());
952 assert!(updates.update_fee.is_none());
954 nodes[1].node.close_channel(&chan_1.2).unwrap();
955 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
956 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
957 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
959 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
960 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
961 check_added_monitors!(nodes[1], 1);
962 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
963 commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
965 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
966 assert!(updates_2.update_add_htlcs.is_empty());
967 assert!(updates_2.update_fulfill_htlcs.is_empty());
968 assert_eq!(updates_2.update_fail_htlcs.len(), 1);
969 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
970 assert!(updates_2.update_fee.is_none());
972 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
973 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
975 expect_payment_failed!(nodes[0], our_payment_hash, false);
977 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
978 assert_eq!(msg_events.len(), 2);
979 let node_0_closing_signed = match msg_events[0] {
980 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
981 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
984 _ => panic!("Unexpected event"),
986 match msg_events[1] {
987 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
988 assert_eq!(msg.contents.short_channel_id, chan_1.0.contents.short_channel_id);
990 _ => panic!("Unexpected event"),
993 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
994 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
995 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
996 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
997 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
998 assert!(node_0_none.is_none());
1000 assert!(nodes[0].node.list_channels().is_empty());
1002 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1003 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1004 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1005 assert!(nodes[1].node.list_channels().is_empty());
1006 assert!(nodes[2].node.list_channels().is_empty());
1009 fn do_test_shutdown_rebroadcast(recv_count: u8) {
1010 // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
1011 // messages delivered prior to disconnect
1012 let chanmon_cfgs = create_chanmon_cfgs(3);
1013 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1014 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1015 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1016 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1017 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1019 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
1021 nodes[1].node.close_channel(&chan_1.2).unwrap();
1022 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1024 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
1025 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1027 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
1031 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1032 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1034 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1035 let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1036 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1037 let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1039 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
1040 let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1041 assert!(node_1_shutdown == node_1_2nd_shutdown);
1043 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
1044 let node_0_2nd_shutdown = if recv_count > 0 {
1045 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1046 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
1049 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1050 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
1051 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
1053 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_2nd_shutdown);
1055 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1056 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1058 assert!(nodes[2].node.claim_funds(our_payment_preimage, &None, 100_000));
1059 check_added_monitors!(nodes[2], 1);
1060 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1061 assert!(updates.update_add_htlcs.is_empty());
1062 assert!(updates.update_fail_htlcs.is_empty());
1063 assert!(updates.update_fail_malformed_htlcs.is_empty());
1064 assert!(updates.update_fee.is_none());
1065 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1066 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1067 check_added_monitors!(nodes[1], 1);
1068 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1069 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1071 assert!(updates_2.update_add_htlcs.is_empty());
1072 assert!(updates_2.update_fail_htlcs.is_empty());
1073 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
1074 assert!(updates_2.update_fee.is_none());
1075 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
1076 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
1077 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
1079 let events = nodes[0].node.get_and_clear_pending_events();
1080 assert_eq!(events.len(), 1);
1082 Event::PaymentSent { ref payment_preimage } => {
1083 assert_eq!(our_payment_preimage, *payment_preimage);
1085 _ => panic!("Unexpected event"),
1088 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1090 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1091 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1092 assert!(node_1_closing_signed.is_some());
1095 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1096 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1098 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1099 let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1100 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1101 if recv_count == 0 {
1102 // If all closing_signeds weren't delivered we can just resume where we left off...
1103 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1105 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
1106 let node_0_3rd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1107 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
1109 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1110 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1111 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
1113 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_3rd_shutdown);
1114 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1116 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_3rd_shutdown);
1117 let node_0_2nd_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1118 assert!(node_0_closing_signed == node_0_2nd_closing_signed);
1120 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
1121 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1122 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
1123 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1124 assert!(node_0_none.is_none());
1126 // If one node, however, received + responded with an identical closing_signed we end
1127 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
1128 // There isn't really anything better we can do simply, but in the future we might
1129 // explore storing a set of recently-closed channels that got disconnected during
1130 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
1131 // give our counterparty enough time to (potentially) broadcast a cooperative closing
1133 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1135 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1136 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
1137 assert_eq!(msg_events.len(), 1);
1138 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
1140 &ErrorAction::SendErrorMessage { ref msg } => {
1141 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msg);
1142 assert_eq!(msg.channel_id, chan_1.2);
1144 _ => panic!("Unexpected event!"),
1146 } else { panic!("Needed SendErrorMessage close"); }
1148 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
1149 // checks it, but in this case nodes[0] didn't ever get a chance to receive a
1150 // closing_signed so we do it ourselves
1151 check_closed_broadcast!(nodes[0], false);
1152 check_added_monitors!(nodes[0], 1);
1155 assert!(nodes[0].node.list_channels().is_empty());
1157 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1158 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1159 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1160 assert!(nodes[1].node.list_channels().is_empty());
1161 assert!(nodes[2].node.list_channels().is_empty());
1165 fn test_shutdown_rebroadcast() {
1166 do_test_shutdown_rebroadcast(0);
1167 do_test_shutdown_rebroadcast(1);
1168 do_test_shutdown_rebroadcast(2);
1172 fn fake_network_test() {
1173 // Simple test which builds a network of ChannelManagers, connects them to each other, and
1174 // tests that payments get routed and transactions broadcast in semi-reasonable ways.
1175 let chanmon_cfgs = create_chanmon_cfgs(4);
1176 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1177 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1178 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1180 // Create some initial channels
1181 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1182 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1183 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1185 // Rebalance the network a bit by relaying one payment through all the channels...
1186 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1187 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1188 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1189 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1191 // Send some more payments
1192 send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000, 1_000_000);
1193 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000, 1_000_000);
1194 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000, 1_000_000);
1196 // Test failure packets
1197 let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
1198 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
1200 // Add a new channel that skips 3
1201 let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1203 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000, 1_000_000);
1204 send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000, 1_000_000);
1205 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1206 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1207 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1208 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1209 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1211 // Do some rebalance loop payments, simultaneously
1212 let mut hops = Vec::with_capacity(3);
1213 hops.push(RouteHop {
1214 pubkey: nodes[2].node.get_our_node_id(),
1215 node_features: NodeFeatures::empty(),
1216 short_channel_id: chan_2.0.contents.short_channel_id,
1217 channel_features: ChannelFeatures::empty(),
1219 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
1221 hops.push(RouteHop {
1222 pubkey: nodes[3].node.get_our_node_id(),
1223 node_features: NodeFeatures::empty(),
1224 short_channel_id: chan_3.0.contents.short_channel_id,
1225 channel_features: ChannelFeatures::empty(),
1227 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
1229 hops.push(RouteHop {
1230 pubkey: nodes[1].node.get_our_node_id(),
1231 node_features: NodeFeatures::empty(),
1232 short_channel_id: chan_4.0.contents.short_channel_id,
1233 channel_features: ChannelFeatures::empty(),
1235 cltv_expiry_delta: TEST_FINAL_CLTV,
1237 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;
1238 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;
1239 let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
1241 let mut hops = Vec::with_capacity(3);
1242 hops.push(RouteHop {
1243 pubkey: nodes[3].node.get_our_node_id(),
1244 node_features: NodeFeatures::empty(),
1245 short_channel_id: chan_4.0.contents.short_channel_id,
1246 channel_features: ChannelFeatures::empty(),
1248 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
1250 hops.push(RouteHop {
1251 pubkey: nodes[2].node.get_our_node_id(),
1252 node_features: NodeFeatures::empty(),
1253 short_channel_id: chan_3.0.contents.short_channel_id,
1254 channel_features: ChannelFeatures::empty(),
1256 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
1258 hops.push(RouteHop {
1259 pubkey: nodes[1].node.get_our_node_id(),
1260 node_features: NodeFeatures::empty(),
1261 short_channel_id: chan_2.0.contents.short_channel_id,
1262 channel_features: ChannelFeatures::empty(),
1264 cltv_expiry_delta: TEST_FINAL_CLTV,
1266 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;
1267 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;
1268 let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1270 // Claim the rebalances...
1271 fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1272 claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1, 1_000_000);
1274 // Add a duplicate new channel from 2 to 4
1275 let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1277 // Send some payments across both channels
1278 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1279 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1280 let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1283 route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
1284 let events = nodes[0].node.get_and_clear_pending_msg_events();
1285 assert_eq!(events.len(), 0);
1286 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);
1288 //TODO: Test that routes work again here as we've been notified that the channel is full
1290 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3, 3_000_000);
1291 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4, 3_000_000);
1292 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5, 3_000_000);
1294 // Close down the channels...
1295 close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1296 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1297 close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1298 close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1299 close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
1303 fn holding_cell_htlc_counting() {
1304 // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1305 // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1306 // commitment dance rounds.
1307 let chanmon_cfgs = create_chanmon_cfgs(3);
1308 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1309 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1310 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1311 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1312 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1313 let logger = test_utils::TestLogger::new();
1315 let mut payments = Vec::new();
1316 for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1317 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1318 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1319 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, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1320 nodes[1].node.send_payment(&route, payment_hash, &None).unwrap();
1321 payments.push((payment_preimage, payment_hash));
1323 check_added_monitors!(nodes[1], 1);
1325 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1326 assert_eq!(events.len(), 1);
1327 let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1328 assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1330 // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1331 // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1333 let (_, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
1335 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1336 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, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1337 unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash_1, &None), true, APIError::ChannelUnavailable { ref err },
1338 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
1339 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1340 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1343 // This should also be true if we try to forward a payment.
1344 let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
1346 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1347 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, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1348 nodes[0].node.send_payment(&route, payment_hash_2, &None).unwrap();
1349 check_added_monitors!(nodes[0], 1);
1352 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1353 assert_eq!(events.len(), 1);
1354 let payment_event = SendEvent::from_event(events.pop().unwrap());
1355 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1357 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1358 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1359 // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1360 // fails), the second will process the resulting failure and fail the HTLC backward.
1361 expect_pending_htlcs_forwardable!(nodes[1]);
1362 expect_pending_htlcs_forwardable!(nodes[1]);
1363 check_added_monitors!(nodes[1], 1);
1365 let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1366 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1367 commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1369 let events = nodes[0].node.get_and_clear_pending_msg_events();
1370 assert_eq!(events.len(), 1);
1372 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
1373 assert_eq!(msg.contents.short_channel_id, chan_2.0.contents.short_channel_id);
1375 _ => panic!("Unexpected event"),
1378 expect_payment_failed!(nodes[0], payment_hash_2, false);
1380 // Now forward all the pending HTLCs and claim them back
1381 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1382 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1383 check_added_monitors!(nodes[2], 1);
1385 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1386 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1387 check_added_monitors!(nodes[1], 1);
1388 let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1390 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1391 check_added_monitors!(nodes[1], 1);
1392 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1394 for ref update in as_updates.update_add_htlcs.iter() {
1395 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1397 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1398 check_added_monitors!(nodes[2], 1);
1399 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1400 check_added_monitors!(nodes[2], 1);
1401 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1403 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1404 check_added_monitors!(nodes[1], 1);
1405 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1406 check_added_monitors!(nodes[1], 1);
1407 let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1409 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1410 check_added_monitors!(nodes[2], 1);
1412 expect_pending_htlcs_forwardable!(nodes[2]);
1414 let events = nodes[2].node.get_and_clear_pending_events();
1415 assert_eq!(events.len(), payments.len());
1416 for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1418 &Event::PaymentReceived { ref payment_hash, .. } => {
1419 assert_eq!(*payment_hash, *hash);
1421 _ => panic!("Unexpected event"),
1425 for (preimage, _) in payments.drain(..) {
1426 claim_payment(&nodes[1], &[&nodes[2]], preimage, 100_000);
1429 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000, 1_000_000);
1433 fn duplicate_htlc_test() {
1434 // Test that we accept duplicate payment_hash HTLCs across the network and that
1435 // claiming/failing them are all separate and don't affect each other
1436 let chanmon_cfgs = create_chanmon_cfgs(6);
1437 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1438 let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1439 let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1441 // Create some initial channels to route via 3 to 4/5 from 0/1/2
1442 create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
1443 create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1444 create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1445 create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
1446 create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
1448 let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1450 *nodes[0].network_payment_count.borrow_mut() -= 1;
1451 assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1453 *nodes[0].network_payment_count.borrow_mut() -= 1;
1454 assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1456 claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage, 1_000_000);
1457 fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1458 claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage, 1_000_000);
1462 fn test_duplicate_htlc_different_direction_onchain() {
1463 // Test that ChannelMonitor doesn't generate 2 preimage txn
1464 // when we have 2 HTLCs with same preimage that go across a node
1465 // in opposite directions.
1466 let chanmon_cfgs = create_chanmon_cfgs(2);
1467 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1468 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1469 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1471 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1472 let logger = test_utils::TestLogger::new();
1475 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
1477 let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1479 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1480 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, &Vec::new(), 800_000, TEST_FINAL_CLTV, &logger).unwrap();
1481 send_along_route_with_hash(&nodes[1], route, &vec!(&nodes[0])[..], 800_000, payment_hash);
1483 // Provide preimage to node 0 by claiming payment
1484 nodes[0].node.claim_funds(payment_preimage, &None, 800_000);
1485 check_added_monitors!(nodes[0], 1);
1487 // Broadcast node 1 commitment txn
1488 let remote_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
1490 assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1491 let mut has_both_htlcs = 0; // check htlcs match ones committed
1492 for outp in remote_txn[0].output.iter() {
1493 if outp.value == 800_000 / 1000 {
1494 has_both_htlcs += 1;
1495 } else if outp.value == 900_000 / 1000 {
1496 has_both_htlcs += 1;
1499 assert_eq!(has_both_htlcs, 2);
1501 let header = BlockHeader { version: 0x2000_0000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1502 connect_block(&nodes[0], &Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
1503 check_added_monitors!(nodes[0], 1);
1505 // Check we only broadcast 1 timeout tx
1506 let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1507 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()) };
1508 assert_eq!(claim_txn.len(), 5);
1509 check_spends!(claim_txn[2], chan_1.3);
1510 check_spends!(claim_txn[3], claim_txn[2]);
1511 assert_eq!(htlc_pair.0.input.len(), 1);
1512 assert_eq!(htlc_pair.0.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1513 check_spends!(htlc_pair.0, remote_txn[0]);
1514 assert_eq!(htlc_pair.1.input.len(), 1);
1515 assert_eq!(htlc_pair.1.input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1516 check_spends!(htlc_pair.1, remote_txn[0]);
1518 let events = nodes[0].node.get_and_clear_pending_msg_events();
1519 assert_eq!(events.len(), 2);
1522 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1523 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, .. } } => {
1524 assert!(update_add_htlcs.is_empty());
1525 assert!(update_fail_htlcs.is_empty());
1526 assert_eq!(update_fulfill_htlcs.len(), 1);
1527 assert!(update_fail_malformed_htlcs.is_empty());
1528 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1530 _ => panic!("Unexpected event"),
1536 fn test_basic_channel_reserve() {
1537 let chanmon_cfgs = create_chanmon_cfgs(2);
1538 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1539 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1540 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1541 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1542 let logger = test_utils::TestLogger::new();
1544 let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1545 let channel_reserve = chan_stat.channel_reserve_msat;
1547 // The 2* and +1 are for the fee spike reserve.
1548 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
1549 let commit_tx_fee = 2 * commit_tx_fee_msat(get_feerate!(nodes[0], chan.2), 1 + 1);
1550 let max_can_send = 5000000 - channel_reserve - commit_tx_fee;
1551 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1552 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, &Vec::new(), max_can_send + 1, TEST_FINAL_CLTV, &logger).unwrap();
1553 let err = nodes[0].node.send_payment(&route, our_payment_hash, &None).err().unwrap();
1555 PaymentSendFailure::AllFailedRetrySafe(ref fails) => {
1557 &APIError::ChannelUnavailable{ref err} =>
1558 assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)),
1559 _ => panic!("Unexpected error variant"),
1562 _ => panic!("Unexpected error variant"),
1564 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1565 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);
1567 send_payment(&nodes[0], &vec![&nodes[1]], max_can_send, max_can_send);
1571 fn test_fee_spike_violation_fails_htlc() {
1572 let chanmon_cfgs = create_chanmon_cfgs(2);
1573 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1574 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1575 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1576 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1577 let logger = test_utils::TestLogger::new();
1579 macro_rules! get_route_and_payment_hash {
1580 ($recv_value: expr) => {{
1581 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[1]);
1582 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler.network_graph.read().unwrap();
1583 let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes.last().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1584 (route, payment_hash, payment_preimage)
1588 let (route, payment_hash, _) = get_route_and_payment_hash!(3460001);
1589 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1590 let secp_ctx = Secp256k1::new();
1591 let session_priv = SecretKey::from_slice(&[42; 32]).expect("RNG is bad!");
1593 let cur_height = nodes[1].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1595 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1596 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3460001, &None, cur_height).unwrap();
1597 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1598 let msg = msgs::UpdateAddHTLC {
1601 amount_msat: htlc_msat,
1602 payment_hash: payment_hash,
1603 cltv_expiry: htlc_cltv,
1604 onion_routing_packet: onion_packet,
1607 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1609 // Now manually create the commitment_signed message corresponding to the update_add
1610 // nodes[0] just sent. In the code for construction of this message, "local" refers
1611 // to the sender of the message, and "remote" refers to the receiver.
1613 let feerate_per_kw = get_feerate!(nodes[0], chan.2);
1615 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
1617 // Get the EnforcingChannelKeys for each channel, which will be used to (1) get the keys
1618 // needed to sign the new commitment tx and (2) sign the new commitment tx.
1619 let (local_revocation_basepoint, local_htlc_basepoint, local_secret, next_local_point) = {
1620 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
1621 let local_chan = chan_lock.by_id.get(&chan.2).unwrap();
1622 let chan_keys = local_chan.get_keys();
1623 let pubkeys = chan_keys.pubkeys();
1624 (pubkeys.revocation_basepoint, pubkeys.htlc_basepoint,
1625 chan_keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER),
1626 chan_keys.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 2, &secp_ctx))
1628 let (remote_delayed_payment_basepoint, remote_htlc_basepoint,remote_point) = {
1629 let chan_lock = nodes[1].node.channel_state.lock().unwrap();
1630 let remote_chan = chan_lock.by_id.get(&chan.2).unwrap();
1631 let chan_keys = remote_chan.get_keys();
1632 let pubkeys = chan_keys.pubkeys();
1633 (pubkeys.delayed_payment_basepoint, pubkeys.htlc_basepoint,
1634 chan_keys.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 1, &secp_ctx))
1637 // Assemble the set of keys we can use for signatures for our commitment_signed message.
1638 let commit_tx_keys = chan_utils::TxCreationKeys::derive_new(&secp_ctx, &remote_point, &remote_delayed_payment_basepoint,
1639 &remote_htlc_basepoint, &local_revocation_basepoint, &local_htlc_basepoint).unwrap();
1641 // Build the remote commitment transaction so we can sign it, and then later use the
1642 // signature for the commitment_signed message.
1643 let local_chan_balance = 1313;
1645 let accepted_htlc_info = chan_utils::HTLCOutputInCommitment {
1647 amount_msat: 3460001,
1648 cltv_expiry: htlc_cltv,
1650 transaction_output_index: Some(1),
1653 let commitment_number = INITIAL_COMMITMENT_NUMBER - 1;
1656 let local_chan_lock = nodes[0].node.channel_state.lock().unwrap();
1657 let local_chan = local_chan_lock.by_id.get(&chan.2).unwrap();
1658 let local_chan_keys = local_chan.get_keys();
1659 let commitment_tx = CommitmentTransaction::new_with_auxiliary_htlc_data(
1663 commit_tx_keys.clone(),
1665 &mut vec![(accepted_htlc_info, ())],
1666 &local_chan.channel_transaction_parameters.as_counterparty_broadcastable()
1668 local_chan_keys.sign_counterparty_commitment(&commitment_tx, &secp_ctx).unwrap()
1671 let commit_signed_msg = msgs::CommitmentSigned {
1674 htlc_signatures: res.1
1677 // Send the commitment_signed message to the nodes[1].
1678 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commit_signed_msg);
1679 let _ = nodes[1].node.get_and_clear_pending_msg_events();
1681 // Send the RAA to nodes[1].
1682 let raa_msg = msgs::RevokeAndACK {
1684 per_commitment_secret: local_secret,
1685 next_per_commitment_point: next_local_point
1687 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_msg);
1689 let events = nodes[1].node.get_and_clear_pending_msg_events();
1690 assert_eq!(events.len(), 1);
1691 // Make sure the HTLC failed in the way we expect.
1693 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, .. }, .. } => {
1694 assert_eq!(update_fail_htlcs.len(), 1);
1695 update_fail_htlcs[0].clone()
1697 _ => panic!("Unexpected event"),
1699 nodes[1].logger.assert_log("lightning::ln::channel".to_string(), "Attempting to fail HTLC due to fee spike buffer violation".to_string(), 1);
1701 check_added_monitors!(nodes[1], 2);
1705 fn test_chan_reserve_violation_outbound_htlc_inbound_chan() {
1706 let mut chanmon_cfgs = create_chanmon_cfgs(2);
1707 // Set the fee rate for the channel very high, to the point where the fundee
1708 // sending any amount would result in a channel reserve violation. In this test
1709 // we check that we would be prevented from sending an HTLC in this situation.
1710 chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1711 chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1712 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1713 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1714 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1715 let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1716 let logger = test_utils::TestLogger::new();
1718 macro_rules! get_route_and_payment_hash {
1719 ($recv_value: expr) => {{
1720 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[1]);
1721 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1722 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, &Vec::new(), $recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1723 (route, payment_hash, payment_preimage)
1727 let (route, our_payment_hash, _) = get_route_and_payment_hash!(1000);
1728 unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
1729 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1730 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1731 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);
1735 fn test_chan_reserve_violation_inbound_htlc_outbound_channel() {
1736 let mut chanmon_cfgs = create_chanmon_cfgs(2);
1737 // Set the fee rate for the channel very high, to the point where the funder
1738 // receiving 1 update_add_htlc would result in them closing the channel due
1739 // to channel reserve violation. This close could also happen if the fee went
1740 // up a more realistic amount, but many HTLCs were outstanding at the time of
1741 // the update_add_htlc.
1742 chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1743 chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1744 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1745 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1746 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1747 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1748 let logger = test_utils::TestLogger::new();
1750 macro_rules! get_route_and_payment_hash {
1751 ($recv_value: expr) => {{
1752 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[1]);
1753 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1754 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, &Vec::new(), $recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1755 (route, payment_hash, payment_preimage)
1759 let (route, payment_hash, _) = get_route_and_payment_hash!(1000);
1760 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1761 let secp_ctx = Secp256k1::new();
1762 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1763 let cur_height = nodes[1].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1764 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1765 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 1000, &None, cur_height).unwrap();
1766 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1767 let msg = msgs::UpdateAddHTLC {
1770 amount_msat: htlc_msat + 1,
1771 payment_hash: payment_hash,
1772 cltv_expiry: htlc_cltv,
1773 onion_routing_packet: onion_packet,
1776 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &msg);
1777 // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1778 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);
1779 assert_eq!(nodes[0].node.list_channels().len(), 0);
1780 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
1781 assert_eq!(err_msg.data, "Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value");
1782 check_added_monitors!(nodes[0], 1);
1786 fn test_chan_reserve_violation_inbound_htlc_inbound_chan() {
1787 let chanmon_cfgs = create_chanmon_cfgs(3);
1788 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1789 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1790 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1791 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1792 let _ = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1793 let logger = test_utils::TestLogger::new();
1795 macro_rules! get_route_and_payment_hash {
1796 ($recv_value: expr) => {{
1797 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1798 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1799 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, &Vec::new(), $recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1800 (route, payment_hash, payment_preimage)
1805 let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1806 let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1807 let feerate = get_feerate!(nodes[0], chan.2);
1809 // Add a 2* and +1 for the fee spike reserve.
1810 let commit_tx_fee_2_htlc = 2*commit_tx_fee_msat(feerate, 2 + 1);
1811 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;
1812 let amt_msat_1 = recv_value_1 + total_routing_fee_msat;
1814 // Add a pending HTLC.
1815 let (route_1, our_payment_hash_1, _) = get_route_and_payment_hash!(amt_msat_1);
1816 let payment_event_1 = {
1817 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &None).unwrap();
1818 check_added_monitors!(nodes[0], 1);
1820 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1821 assert_eq!(events.len(), 1);
1822 SendEvent::from_event(events.remove(0))
1824 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1826 // Attempt to trigger a channel reserve violation --> payment failure.
1827 let commit_tx_fee_2_htlcs = commit_tx_fee_msat(feerate, 2);
1828 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;
1829 let amt_msat_2 = recv_value_2 + total_routing_fee_msat;
1830 let (route_2, _, _) = get_route_and_payment_hash!(amt_msat_2);
1832 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1833 let secp_ctx = Secp256k1::new();
1834 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1835 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1836 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route_2.paths[0], &session_priv).unwrap();
1837 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route_2.paths[0], recv_value_2, &None, cur_height).unwrap();
1838 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash_1);
1839 let msg = msgs::UpdateAddHTLC {
1842 amount_msat: htlc_msat + 1,
1843 payment_hash: our_payment_hash_1,
1844 cltv_expiry: htlc_cltv,
1845 onion_routing_packet: onion_packet,
1848 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1849 // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1850 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote HTLC add would put them under remote reserve value".to_string(), 1);
1851 assert_eq!(nodes[1].node.list_channels().len(), 1);
1852 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1853 assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
1854 check_added_monitors!(nodes[1], 1);
1858 fn test_inbound_outbound_capacity_is_not_zero() {
1859 let chanmon_cfgs = create_chanmon_cfgs(2);
1860 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1861 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1862 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1863 let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1864 let channels0 = node_chanmgrs[0].list_channels();
1865 let channels1 = node_chanmgrs[1].list_channels();
1866 assert_eq!(channels0.len(), 1);
1867 assert_eq!(channels1.len(), 1);
1869 assert_eq!(channels0[0].inbound_capacity_msat, 95000000);
1870 assert_eq!(channels1[0].outbound_capacity_msat, 95000000);
1872 assert_eq!(channels0[0].outbound_capacity_msat, 100000 * 1000 - 95000000);
1873 assert_eq!(channels1[0].inbound_capacity_msat, 100000 * 1000 - 95000000);
1876 fn commit_tx_fee_msat(feerate: u32, num_htlcs: u64) -> u64 {
1877 (COMMITMENT_TX_BASE_WEIGHT + num_htlcs * COMMITMENT_TX_WEIGHT_PER_HTLC) * feerate as u64 / 1000 * 1000
1881 fn test_channel_reserve_holding_cell_htlcs() {
1882 let chanmon_cfgs = create_chanmon_cfgs(3);
1883 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1884 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1885 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1886 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1887 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1888 let logger = test_utils::TestLogger::new();
1890 let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1891 let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1893 let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1894 let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1896 macro_rules! get_route_and_payment_hash {
1897 ($recv_value: expr) => {{
1898 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1899 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1900 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, &Vec::new(), $recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1901 (route, payment_hash, payment_preimage)
1905 macro_rules! expect_forward {
1907 let mut events = $node.node.get_and_clear_pending_msg_events();
1908 assert_eq!(events.len(), 1);
1909 check_added_monitors!($node, 1);
1910 let payment_event = SendEvent::from_event(events.remove(0));
1915 let feemsat = 239; // somehow we know?
1916 let total_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1917 let feerate = get_feerate!(nodes[0], chan_1.2);
1919 let recv_value_0 = stat01.counterparty_max_htlc_value_in_flight_msat - total_fee_msat;
1921 // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1923 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_0 + 1);
1924 assert!(route.paths[0].iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1925 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
1926 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)));
1927 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1928 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);
1931 // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1932 // nodes[0]'s wealth
1934 let amt_msat = recv_value_0 + total_fee_msat;
1935 // 3 for the 3 HTLCs that will be sent, 2* and +1 for the fee spike reserve.
1936 // Also, ensure that each payment has enough to be over the dust limit to
1937 // ensure it'll be included in each commit tx fee calculation.
1938 let commit_tx_fee_all_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1939 let ensure_htlc_amounts_above_dust_buffer = 3 * (stat01.counterparty_dust_limit_msat + 1000);
1940 if stat01.value_to_self_msat < stat01.channel_reserve_msat + commit_tx_fee_all_htlcs + ensure_htlc_amounts_above_dust_buffer + amt_msat {
1943 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0, recv_value_0);
1945 let (stat01_, stat11_, stat12_, stat22_) = (
1946 get_channel_value_stat!(nodes[0], chan_1.2),
1947 get_channel_value_stat!(nodes[1], chan_1.2),
1948 get_channel_value_stat!(nodes[1], chan_2.2),
1949 get_channel_value_stat!(nodes[2], chan_2.2),
1952 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1953 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1954 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1955 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1956 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1959 // adding pending output.
1960 // 2* and +1 HTLCs on the commit tx fee for the fee spike reserve.
1961 // The reason we're dividing by two here is as follows: the dividend is the total outbound liquidity
1962 // after fees, the channel reserve, and the fee spike buffer are removed. We eventually want to
1963 // divide this quantity into 3 portions, that will each be sent in an HTLC. This allows us
1964 // to test channel channel reserve policy at the edges of what amount is sendable, i.e.
1965 // cases where 1 msat over X amount will cause a payment failure, but anything less than
1966 // that can be sent successfully. So, dividing by two is a somewhat arbitrary way of getting
1967 // the amount of the first of these aforementioned 3 payments. The reason we split into 3 payments
1968 // is to test the behavior of the holding cell with respect to channel reserve and commit tx fee
1970 let commit_tx_fee_2_htlcs = 2*commit_tx_fee_msat(feerate, 2 + 1);
1971 let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs)/2;
1972 let amt_msat_1 = recv_value_1 + total_fee_msat;
1974 let (route_1, our_payment_hash_1, our_payment_preimage_1) = get_route_and_payment_hash!(recv_value_1);
1975 let payment_event_1 = {
1976 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &None).unwrap();
1977 check_added_monitors!(nodes[0], 1);
1979 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1980 assert_eq!(events.len(), 1);
1981 SendEvent::from_event(events.remove(0))
1983 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1985 // channel reserve test with htlc pending output > 0
1986 let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs;
1988 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
1989 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
1990 assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
1991 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1994 // split the rest to test holding cell
1995 let commit_tx_fee_3_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1996 let additional_htlc_cost_msat = commit_tx_fee_3_htlcs - commit_tx_fee_2_htlcs;
1997 let recv_value_21 = recv_value_2/2 - additional_htlc_cost_msat/2;
1998 let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat - additional_htlc_cost_msat;
2000 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
2001 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);
2004 // now see if they go through on both sides
2005 let (route_21, our_payment_hash_21, our_payment_preimage_21) = get_route_and_payment_hash!(recv_value_21);
2006 // but this will stuck in the holding cell
2007 nodes[0].node.send_payment(&route_21, our_payment_hash_21, &None).unwrap();
2008 check_added_monitors!(nodes[0], 0);
2009 let events = nodes[0].node.get_and_clear_pending_events();
2010 assert_eq!(events.len(), 0);
2012 // test with outbound holding cell amount > 0
2014 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_22+1);
2015 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
2016 assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
2017 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2018 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);
2021 let (route_22, our_payment_hash_22, our_payment_preimage_22) = get_route_and_payment_hash!(recv_value_22);
2022 // this will also stuck in the holding cell
2023 nodes[0].node.send_payment(&route_22, our_payment_hash_22, &None).unwrap();
2024 check_added_monitors!(nodes[0], 0);
2025 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
2026 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2028 // flush the pending htlc
2029 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
2030 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2031 check_added_monitors!(nodes[1], 1);
2033 // the pending htlc should be promoted to committed
2034 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
2035 check_added_monitors!(nodes[0], 1);
2036 let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2038 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
2039 let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2040 // No commitment_signed so get_event_msg's assert(len == 1) passes
2041 check_added_monitors!(nodes[0], 1);
2043 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
2044 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2045 check_added_monitors!(nodes[1], 1);
2047 expect_pending_htlcs_forwardable!(nodes[1]);
2049 let ref payment_event_11 = expect_forward!(nodes[1]);
2050 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
2051 commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
2053 expect_pending_htlcs_forwardable!(nodes[2]);
2054 expect_payment_received!(nodes[2], our_payment_hash_1, recv_value_1);
2056 // flush the htlcs in the holding cell
2057 assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
2058 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
2059 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
2060 commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
2061 expect_pending_htlcs_forwardable!(nodes[1]);
2063 let ref payment_event_3 = expect_forward!(nodes[1]);
2064 assert_eq!(payment_event_3.msgs.len(), 2);
2065 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
2066 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
2068 commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
2069 expect_pending_htlcs_forwardable!(nodes[2]);
2071 let events = nodes[2].node.get_and_clear_pending_events();
2072 assert_eq!(events.len(), 2);
2074 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
2075 assert_eq!(our_payment_hash_21, *payment_hash);
2076 assert_eq!(*payment_secret, None);
2077 assert_eq!(recv_value_21, amt);
2079 _ => panic!("Unexpected event"),
2082 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
2083 assert_eq!(our_payment_hash_22, *payment_hash);
2084 assert_eq!(None, *payment_secret);
2085 assert_eq!(recv_value_22, amt);
2087 _ => panic!("Unexpected event"),
2090 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1, recv_value_1);
2091 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21, recv_value_21);
2092 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22, recv_value_22);
2094 let commit_tx_fee_0_htlcs = 2*commit_tx_fee_msat(feerate, 1);
2095 let recv_value_3 = commit_tx_fee_2_htlcs - commit_tx_fee_0_htlcs - total_fee_msat;
2097 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_3 + 1);
2098 let err = nodes[0].node.send_payment(&route, our_payment_hash, &None).err().unwrap();
2100 PaymentSendFailure::AllFailedRetrySafe(ref fails) => {
2102 &APIError::ChannelUnavailable{ref err} =>
2103 assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)),
2104 _ => panic!("Unexpected error variant"),
2107 _ => panic!("Unexpected error variant"),
2109 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2110 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(), 3);
2113 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_3, recv_value_3);
2115 let commit_tx_fee_1_htlc = 2*commit_tx_fee_msat(feerate, 1 + 1);
2116 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);
2117 let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
2118 assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
2119 assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat + commit_tx_fee_1_htlc);
2121 let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
2122 assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22 + recv_value_3);
2126 fn channel_reserve_in_flight_removes() {
2127 // In cases where one side claims an HTLC, it thinks it has additional available funds that it
2128 // can send to its counterparty, but due to update ordering, the other side may not yet have
2129 // considered those HTLCs fully removed.
2130 // This tests that we don't count HTLCs which will not be included in the next remote
2131 // commitment transaction towards the reserve value (as it implies no commitment transaction
2132 // will be generated which violates the remote reserve value).
2133 // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
2135 // * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
2136 // you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
2137 // you only consider the value of the first HTLC, it may not),
2138 // * start routing a third HTLC from A to B,
2139 // * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
2140 // the other claim in its holding cell, as it immediately goes into AwaitingRAA),
2141 // * deliver the first fulfill from B
2142 // * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
2144 // * deliver A's response CS and RAA.
2145 // This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
2146 // removed it fully. B now has the push_msat plus the first two HTLCs in value.
2147 // * Now B happily sends another HTLC, potentially violating its reserve value from A's point
2148 // of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
2149 let chanmon_cfgs = create_chanmon_cfgs(2);
2150 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2151 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2152 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2153 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2154 let logger = test_utils::TestLogger::new();
2156 let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
2157 // Route the first two HTLCs.
2158 let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
2159 let (payment_preimage_2, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
2161 // Start routing the third HTLC (this is just used to get everyone in the right state).
2162 let (payment_preimage_3, payment_hash_3) = get_payment_preimage_hash!(nodes[0]);
2164 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
2165 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, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
2166 nodes[0].node.send_payment(&route, payment_hash_3, &None).unwrap();
2167 check_added_monitors!(nodes[0], 1);
2168 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2169 assert_eq!(events.len(), 1);
2170 SendEvent::from_event(events.remove(0))
2173 // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
2174 // initial fulfill/CS.
2175 assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000));
2176 check_added_monitors!(nodes[1], 1);
2177 let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2179 // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
2180 // remove the second HTLC when we send the HTLC back from B to A.
2181 assert!(nodes[1].node.claim_funds(payment_preimage_2, &None, 20000));
2182 check_added_monitors!(nodes[1], 1);
2183 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2185 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
2186 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
2187 check_added_monitors!(nodes[0], 1);
2188 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2189 expect_payment_sent!(nodes[0], payment_preimage_1);
2191 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
2192 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
2193 check_added_monitors!(nodes[1], 1);
2194 // B is already AwaitingRAA, so cant generate a CS here
2195 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2197 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2198 check_added_monitors!(nodes[1], 1);
2199 let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2201 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2202 check_added_monitors!(nodes[0], 1);
2203 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2205 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2206 check_added_monitors!(nodes[1], 1);
2207 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2209 // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
2210 // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
2211 // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
2212 // can no longer broadcast a commitment transaction with it and B has the preimage so can go
2213 // on-chain as necessary).
2214 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
2215 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
2216 check_added_monitors!(nodes[0], 1);
2217 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2218 expect_payment_sent!(nodes[0], payment_preimage_2);
2220 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2221 check_added_monitors!(nodes[1], 1);
2222 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2224 expect_pending_htlcs_forwardable!(nodes[1]);
2225 expect_payment_received!(nodes[1], payment_hash_3, 100000);
2227 // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
2228 // resolve the second HTLC from A's point of view.
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 // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
2234 // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
2235 let (payment_preimage_4, payment_hash_4) = get_payment_preimage_hash!(nodes[1]);
2237 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
2238 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, &[], 10000, TEST_FINAL_CLTV, &logger).unwrap();
2239 nodes[1].node.send_payment(&route, payment_hash_4, &None).unwrap();
2240 check_added_monitors!(nodes[1], 1);
2241 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
2242 assert_eq!(events.len(), 1);
2243 SendEvent::from_event(events.remove(0))
2246 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
2247 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
2248 check_added_monitors!(nodes[0], 1);
2249 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2251 // Now just resolve all the outstanding messages/HTLCs for completeness...
2253 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2254 check_added_monitors!(nodes[1], 1);
2255 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2257 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2258 check_added_monitors!(nodes[1], 1);
2260 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2261 check_added_monitors!(nodes[0], 1);
2262 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2264 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2265 check_added_monitors!(nodes[1], 1);
2266 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2268 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2269 check_added_monitors!(nodes[0], 1);
2271 expect_pending_htlcs_forwardable!(nodes[0]);
2272 expect_payment_received!(nodes[0], payment_hash_4, 10000);
2274 claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4, 10_000);
2275 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3, 100_000);
2279 fn channel_monitor_network_test() {
2280 // Simple test which builds a network of ChannelManagers, connects them to each other, and
2281 // tests that ChannelMonitor is able to recover from various states.
2282 let chanmon_cfgs = create_chanmon_cfgs(5);
2283 let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
2284 let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
2285 let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
2287 // Create some initial channels
2288 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2289 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2290 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
2291 let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
2293 // Rebalance the network a bit by relaying one payment through all the channels...
2294 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2295 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2296 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2297 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2299 // Simple case with no pending HTLCs:
2300 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
2301 check_added_monitors!(nodes[1], 1);
2303 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
2304 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2305 connect_block(&nodes[0], &Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
2306 check_added_monitors!(nodes[0], 1);
2307 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
2309 get_announce_close_broadcast_events(&nodes, 0, 1);
2310 assert_eq!(nodes[0].node.list_channels().len(), 0);
2311 assert_eq!(nodes[1].node.list_channels().len(), 1);
2313 // One pending HTLC is discarded by the force-close:
2314 let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
2316 // Simple case of one pending HTLC to HTLC-Timeout
2317 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
2318 check_added_monitors!(nodes[1], 1);
2320 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
2321 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2322 connect_block(&nodes[2], &Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
2323 check_added_monitors!(nodes[2], 1);
2324 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
2326 get_announce_close_broadcast_events(&nodes, 1, 2);
2327 assert_eq!(nodes[1].node.list_channels().len(), 0);
2328 assert_eq!(nodes[2].node.list_channels().len(), 1);
2330 macro_rules! claim_funds {
2331 ($node: expr, $prev_node: expr, $preimage: expr, $amount: expr) => {
2333 assert!($node.node.claim_funds($preimage, &None, $amount));
2334 check_added_monitors!($node, 1);
2336 let events = $node.node.get_and_clear_pending_msg_events();
2337 assert_eq!(events.len(), 1);
2339 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2340 assert!(update_add_htlcs.is_empty());
2341 assert!(update_fail_htlcs.is_empty());
2342 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2344 _ => panic!("Unexpected event"),
2350 // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2351 // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2352 nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2353 check_added_monitors!(nodes[2], 1);
2354 let node2_commitment_txid;
2356 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2357 node2_commitment_txid = node_txn[0].txid();
2359 // Claim the payment on nodes[3], giving it knowledge of the preimage
2360 claim_funds!(nodes[3], nodes[2], payment_preimage_1, 3_000_000);
2362 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2363 connect_block(&nodes[3], &Block { header, txdata: vec![node_txn[0].clone()] }, 1);
2364 check_added_monitors!(nodes[3], 1);
2366 check_preimage_claim(&nodes[3], &node_txn);
2368 get_announce_close_broadcast_events(&nodes, 2, 3);
2369 assert_eq!(nodes[2].node.list_channels().len(), 0);
2370 assert_eq!(nodes[3].node.list_channels().len(), 1);
2372 { // Cheat and reset nodes[4]'s height to 1
2373 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2374 connect_block(&nodes[4], &Block { header, txdata: vec![] }, 1);
2377 assert_eq!(nodes[3].node.latest_block_height.load(Ordering::Acquire), 1);
2378 assert_eq!(nodes[4].node.latest_block_height.load(Ordering::Acquire), 1);
2379 // One pending HTLC to time out:
2380 let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2381 // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2384 let (close_chan_update_1, close_chan_update_2) = {
2385 let mut block = Block {
2386 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
2389 connect_block(&nodes[3], &block, 2);
2390 for i in 3..TEST_FINAL_CLTV + 2 + LATENCY_GRACE_PERIOD_BLOCKS + 1 {
2392 header: BlockHeader { version: 0x20000000, prev_blockhash: block.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
2395 connect_block(&nodes[3], &block, i);
2397 let events = nodes[3].node.get_and_clear_pending_msg_events();
2398 assert_eq!(events.len(), 1);
2399 let close_chan_update_1 = match events[0] {
2400 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2403 _ => panic!("Unexpected event"),
2405 check_added_monitors!(nodes[3], 1);
2407 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2409 let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2410 node_txn.retain(|tx| {
2411 if tx.input[0].previous_output.txid == node2_commitment_txid {
2417 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2419 // Claim the payment on nodes[4], giving it knowledge of the preimage
2420 claim_funds!(nodes[4], nodes[3], payment_preimage_2, 3_000_000);
2423 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
2427 connect_block(&nodes[4], &block, 2);
2428 for i in 3..TEST_FINAL_CLTV + 2 - CLTV_CLAIM_BUFFER + 1 {
2430 header: BlockHeader { version: 0x20000000, prev_blockhash: block.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
2433 connect_block(&nodes[4], &block, i);
2435 let events = nodes[4].node.get_and_clear_pending_msg_events();
2436 assert_eq!(events.len(), 1);
2437 let close_chan_update_2 = match events[0] {
2438 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2441 _ => panic!("Unexpected event"),
2443 check_added_monitors!(nodes[4], 1);
2444 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2447 header: BlockHeader { version: 0x20000000, prev_blockhash: block.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
2448 txdata: vec![node_txn[0].clone()],
2450 connect_block(&nodes[4], &block, TEST_FINAL_CLTV - 5);
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);
2462 fn test_justice_tx() {
2463 // Test justice txn built on revoked HTLC-Success tx, against both sides
2464 let mut alice_config = UserConfig::default();
2465 alice_config.channel_options.announced_channel = true;
2466 alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2467 alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2468 let mut bob_config = UserConfig::default();
2469 bob_config.channel_options.announced_channel = true;
2470 bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2471 bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2472 let user_cfgs = [Some(alice_config), Some(bob_config)];
2473 let mut chanmon_cfgs = create_chanmon_cfgs(2);
2474 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2475 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
2476 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2477 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2478 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2479 // Create some new channels:
2480 let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2482 // A pending HTLC which will be revoked:
2483 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2484 // Get the will-be-revoked local txn from nodes[0]
2485 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2486 assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2487 assert_eq!(revoked_local_txn[0].input.len(), 1);
2488 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2489 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2490 assert_eq!(revoked_local_txn[1].input.len(), 1);
2491 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2492 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2493 // Revoke the old state
2494 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 3_000_000);
2497 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2498 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2500 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2501 assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2502 assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2504 check_spends!(node_txn[0], revoked_local_txn[0]);
2505 node_txn.swap_remove(0);
2506 node_txn.truncate(1);
2508 check_added_monitors!(nodes[1], 1);
2509 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2511 connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2512 // Verify broadcast of revoked HTLC-timeout
2513 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2514 header = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2515 check_added_monitors!(nodes[0], 1);
2516 // Broadcast revoked HTLC-timeout on node 1
2517 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[1].clone()] }, 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 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2545 connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2547 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2548 assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2549 assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2551 check_spends!(node_txn[0], revoked_local_txn[0]);
2552 node_txn.swap_remove(0);
2554 check_added_monitors!(nodes[0], 1);
2555 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2557 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2558 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2559 header = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2560 check_added_monitors!(nodes[1], 1);
2561 connect_block(&nodes[0], &Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2562 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2564 get_announce_close_broadcast_events(&nodes, 0, 1);
2565 assert_eq!(nodes[0].node.list_channels().len(), 0);
2566 assert_eq!(nodes[1].node.list_channels().len(), 0);
2570 fn revoked_output_claim() {
2571 // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2572 // transaction is broadcast by its counterparty
2573 let chanmon_cfgs = create_chanmon_cfgs(2);
2574 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2575 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2576 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2577 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2578 // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2579 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2580 assert_eq!(revoked_local_txn.len(), 1);
2581 // Only output is the full channel value back to nodes[0]:
2582 assert_eq!(revoked_local_txn[0].output.len(), 1);
2583 // Send a payment through, updating everyone's latest commitment txn
2584 send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000, 5_000_000);
2586 // Inform nodes[1] that nodes[0] broadcast a stale tx
2587 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2588 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2589 check_added_monitors!(nodes[1], 1);
2590 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2591 assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2593 check_spends!(node_txn[0], revoked_local_txn[0]);
2594 check_spends!(node_txn[1], chan_1.3);
2596 // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2597 connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2598 get_announce_close_broadcast_events(&nodes, 0, 1);
2599 check_added_monitors!(nodes[0], 1)
2603 fn claim_htlc_outputs_shared_tx() {
2604 // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2605 let mut chanmon_cfgs = create_chanmon_cfgs(2);
2606 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2607 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2608 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2609 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2611 // Create some new channel:
2612 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2614 // Rebalance the network to generate htlc in the two directions
2615 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2616 // 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
2617 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2618 let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2620 // Get the will-be-revoked local txn from node[0]
2621 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2622 assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2623 assert_eq!(revoked_local_txn[0].input.len(), 1);
2624 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2625 assert_eq!(revoked_local_txn[1].input.len(), 1);
2626 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2627 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2628 check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2630 //Revoke the old state
2631 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2634 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2635 connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2636 check_added_monitors!(nodes[0], 1);
2637 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2638 check_added_monitors!(nodes[1], 1);
2639 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.block_hash());
2640 expect_payment_failed!(nodes[1], payment_hash_2, true);
2642 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2643 assert_eq!(node_txn.len(), 3); // ChannelMonitor: penalty tx, ChannelManager: local commitment + HTLC-timeout
2645 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2646 check_spends!(node_txn[0], revoked_local_txn[0]);
2648 let mut witness_lens = BTreeSet::new();
2649 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2650 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2651 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2652 assert_eq!(witness_lens.len(), 3);
2653 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2654 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2655 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2657 // Next nodes[1] broadcasts its current local tx state:
2658 assert_eq!(node_txn[1].input.len(), 1);
2659 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2661 assert_eq!(node_txn[2].input.len(), 1);
2662 let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
2663 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2664 assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
2665 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2666 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
2668 get_announce_close_broadcast_events(&nodes, 0, 1);
2669 assert_eq!(nodes[0].node.list_channels().len(), 0);
2670 assert_eq!(nodes[1].node.list_channels().len(), 0);
2674 fn claim_htlc_outputs_single_tx() {
2675 // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2676 let mut chanmon_cfgs = create_chanmon_cfgs(2);
2677 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2678 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2679 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2680 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2682 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2684 // Rebalance the network to generate htlc in the two directions
2685 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2686 // 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
2687 // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2688 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2689 let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2691 // Get the will-be-revoked local txn from node[0]
2692 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2694 //Revoke the old state
2695 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2698 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2699 connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2700 check_added_monitors!(nodes[0], 1);
2701 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2702 check_added_monitors!(nodes[1], 1);
2703 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
2705 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 200, true, header.block_hash());
2706 expect_payment_failed!(nodes[1], payment_hash_2, true);
2708 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2709 assert_eq!(node_txn.len(), 9);
2710 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2711 // ChannelManager: local commmitment + local HTLC-timeout (2)
2712 // 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)
2713 // ChannelMonitor: local commitment + local HTLC-timeout (2)
2715 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2716 assert_eq!(node_txn[2].input.len(), 1);
2717 check_spends!(node_txn[2], chan_1.3);
2718 assert_eq!(node_txn[3].input.len(), 1);
2719 let witness_script = node_txn[3].input[0].witness.last().unwrap();
2720 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2721 check_spends!(node_txn[3], node_txn[2]);
2723 // Justice transactions are indices 1-2-4
2724 assert_eq!(node_txn[0].input.len(), 1);
2725 assert_eq!(node_txn[1].input.len(), 1);
2726 assert_eq!(node_txn[4].input.len(), 1);
2728 check_spends!(node_txn[0], revoked_local_txn[0]);
2729 check_spends!(node_txn[1], revoked_local_txn[0]);
2730 check_spends!(node_txn[4], revoked_local_txn[0]);
2732 let mut witness_lens = BTreeSet::new();
2733 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2734 witness_lens.insert(node_txn[1].input[0].witness.last().unwrap().len());
2735 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2736 assert_eq!(witness_lens.len(), 3);
2737 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2738 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2739 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2741 get_announce_close_broadcast_events(&nodes, 0, 1);
2742 assert_eq!(nodes[0].node.list_channels().len(), 0);
2743 assert_eq!(nodes[1].node.list_channels().len(), 0);
2747 fn test_htlc_on_chain_success() {
2748 // Test that in case of a unilateral close onchain, we detect the state of output and pass
2749 // the preimage backward accordingly. So here we test that ChannelManager is
2750 // broadcasting the right event to other nodes in payment path.
2751 // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2752 // A --------------------> B ----------------------> C (preimage)
2753 // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2754 // commitment transaction was broadcast.
2755 // Then, B should learn the preimage from said transactions, attempting to claim backwards
2757 // B should be able to claim via preimage if A then broadcasts its local tx.
2758 // Finally, when A sees B's latest local commitment transaction it should be able to claim
2759 // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2760 // PaymentSent event).
2762 let chanmon_cfgs = create_chanmon_cfgs(3);
2763 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2764 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2765 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2767 // Create some initial channels
2768 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2769 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2771 // Rebalance the network a bit by relaying one payment through all the channels...
2772 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2773 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2775 let (our_payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2776 let (our_payment_preimage_2, _payment_hash_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2777 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2779 // Broadcast legit commitment tx from C on B's chain
2780 // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2781 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2782 assert_eq!(commitment_tx.len(), 1);
2783 check_spends!(commitment_tx[0], chan_2.3);
2784 nodes[2].node.claim_funds(our_payment_preimage, &None, 3_000_000);
2785 nodes[2].node.claim_funds(our_payment_preimage_2, &None, 3_000_000);
2786 check_added_monitors!(nodes[2], 2);
2787 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2788 assert!(updates.update_add_htlcs.is_empty());
2789 assert!(updates.update_fail_htlcs.is_empty());
2790 assert!(updates.update_fail_malformed_htlcs.is_empty());
2791 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2793 connect_block(&nodes[2], &Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2794 check_closed_broadcast!(nodes[2], false);
2795 check_added_monitors!(nodes[2], 1);
2796 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)
2797 assert_eq!(node_txn.len(), 5);
2798 assert_eq!(node_txn[0], node_txn[3]);
2799 assert_eq!(node_txn[1], node_txn[4]);
2800 assert_eq!(node_txn[2], commitment_tx[0]);
2801 check_spends!(node_txn[0], commitment_tx[0]);
2802 check_spends!(node_txn[1], commitment_tx[0]);
2803 assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2804 assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2805 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2806 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2807 assert_eq!(node_txn[0].lock_time, 0);
2808 assert_eq!(node_txn[1].lock_time, 0);
2810 // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2811 connect_block(&nodes[1], &Block { header, txdata: node_txn}, 1);
2813 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2814 assert_eq!(added_monitors.len(), 1);
2815 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2816 added_monitors.clear();
2818 let events = nodes[1].node.get_and_clear_pending_msg_events();
2820 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2821 assert_eq!(added_monitors.len(), 2);
2822 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2823 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2824 added_monitors.clear();
2826 assert_eq!(events.len(), 2);
2828 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2829 _ => panic!("Unexpected event"),
2832 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, .. } } => {
2833 assert!(update_add_htlcs.is_empty());
2834 assert!(update_fail_htlcs.is_empty());
2835 assert_eq!(update_fulfill_htlcs.len(), 1);
2836 assert!(update_fail_malformed_htlcs.is_empty());
2837 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2839 _ => panic!("Unexpected event"),
2841 macro_rules! check_tx_local_broadcast {
2842 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2843 let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2844 assert_eq!(node_txn.len(), 5);
2845 // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2846 // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout
2847 check_spends!(node_txn[0], $commitment_tx);
2848 check_spends!(node_txn[1], $commitment_tx);
2849 assert_ne!(node_txn[0].lock_time, 0);
2850 assert_ne!(node_txn[1].lock_time, 0);
2852 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2853 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2854 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2855 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2857 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2858 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2859 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2860 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2862 check_spends!(node_txn[2], $chan_tx);
2863 check_spends!(node_txn[3], node_txn[2]);
2864 check_spends!(node_txn[4], node_txn[2]);
2865 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), 71);
2866 assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2867 assert_eq!(node_txn[4].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2868 assert!(node_txn[3].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2869 assert!(node_txn[4].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2870 assert_ne!(node_txn[3].lock_time, 0);
2871 assert_ne!(node_txn[4].lock_time, 0);
2875 // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2876 // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2877 // timeout-claim of the output that nodes[2] just claimed via success.
2878 check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2880 // Broadcast legit commitment tx from A on B's chain
2881 // Broadcast preimage tx by B on offered output from A commitment tx on A's chain
2882 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2883 check_spends!(commitment_tx[0], chan_1.3);
2884 connect_block(&nodes[1], &Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2885 check_closed_broadcast!(nodes[1], false);
2886 check_added_monitors!(nodes[1], 1);
2887 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 1 (HTLC-Success)
2888 assert_eq!(node_txn.len(), 4);
2889 check_spends!(node_txn[0], commitment_tx[0]);
2890 assert_eq!(node_txn[0].input.len(), 2);
2891 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2892 assert_eq!(node_txn[0].input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2893 assert_eq!(node_txn[0].lock_time, 0);
2894 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2895 check_spends!(node_txn[1], chan_1.3);
2896 assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2897 check_spends!(node_txn[2], node_txn[1]);
2898 check_spends!(node_txn[3], node_txn[1]);
2899 // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2900 // we already checked the same situation with A.
2902 // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2903 connect_block(&nodes[0], &Block { header, txdata: vec![commitment_tx[0].clone(), node_txn[0].clone()] }, 1);
2904 check_closed_broadcast!(nodes[0], false);
2905 check_added_monitors!(nodes[0], 1);
2906 let events = nodes[0].node.get_and_clear_pending_events();
2907 assert_eq!(events.len(), 2);
2908 let mut first_claimed = false;
2909 for event in events {
2911 Event::PaymentSent { payment_preimage } => {
2912 if payment_preimage == our_payment_preimage {
2913 assert!(!first_claimed);
2914 first_claimed = true;
2916 assert_eq!(payment_preimage, our_payment_preimage_2);
2919 _ => panic!("Unexpected event"),
2922 check_tx_local_broadcast!(nodes[0], true, commitment_tx[0], chan_1.3);
2926 fn test_htlc_on_chain_timeout() {
2927 // Test that in case of a unilateral close onchain, we detect the state of output and
2928 // timeout the HTLC backward accordingly. So here we test that ChannelManager is
2929 // broadcasting the right event to other nodes in payment path.
2930 // A ------------------> B ----------------------> C (timeout)
2931 // B's commitment tx C's commitment tx
2933 // B's HTLC timeout tx B's timeout tx
2935 let chanmon_cfgs = create_chanmon_cfgs(3);
2936 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2937 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2938 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2940 // Create some intial channels
2941 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2942 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2944 // Rebalance the network a bit by relaying one payment thorugh all the channels...
2945 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2946 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2948 let (_payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2949 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2951 // Broadcast legit commitment tx from C on B's chain
2952 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2953 check_spends!(commitment_tx[0], chan_2.3);
2954 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
2955 check_added_monitors!(nodes[2], 0);
2956 expect_pending_htlcs_forwardable!(nodes[2]);
2957 check_added_monitors!(nodes[2], 1);
2959 let events = nodes[2].node.get_and_clear_pending_msg_events();
2960 assert_eq!(events.len(), 1);
2962 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, .. } } => {
2963 assert!(update_add_htlcs.is_empty());
2964 assert!(!update_fail_htlcs.is_empty());
2965 assert!(update_fulfill_htlcs.is_empty());
2966 assert!(update_fail_malformed_htlcs.is_empty());
2967 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2969 _ => panic!("Unexpected event"),
2971 connect_block(&nodes[2], &Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2972 check_closed_broadcast!(nodes[2], false);
2973 check_added_monitors!(nodes[2], 1);
2974 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2975 assert_eq!(node_txn.len(), 1);
2976 check_spends!(node_txn[0], chan_2.3);
2977 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2979 // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2980 // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2981 connect_block(&nodes[1], &Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2984 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2985 assert_eq!(node_txn.len(), 5); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (local commitment tx + HTLC-timeout), 1 timeout tx
2986 assert_eq!(node_txn[1], node_txn[3]);
2987 assert_eq!(node_txn[2], node_txn[4]);
2989 check_spends!(node_txn[0], commitment_tx[0]);
2990 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2992 check_spends!(node_txn[1], chan_2.3);
2993 check_spends!(node_txn[2], node_txn[1]);
2994 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2995 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2997 timeout_tx = node_txn[0].clone();
3001 connect_block(&nodes[1], &Block { header, txdata: vec![timeout_tx]}, 1);
3002 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.block_hash());
3003 check_added_monitors!(nodes[1], 1);
3004 check_closed_broadcast!(nodes[1], false);
3006 expect_pending_htlcs_forwardable!(nodes[1]);
3007 check_added_monitors!(nodes[1], 1);
3008 let events = nodes[1].node.get_and_clear_pending_msg_events();
3009 assert_eq!(events.len(), 1);
3011 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, .. } } => {
3012 assert!(update_add_htlcs.is_empty());
3013 assert!(!update_fail_htlcs.is_empty());
3014 assert!(update_fulfill_htlcs.is_empty());
3015 assert!(update_fail_malformed_htlcs.is_empty());
3016 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3018 _ => panic!("Unexpected event"),
3020 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // Well... here we detect our own htlc_timeout_tx so no tx to be generated
3021 assert_eq!(node_txn.len(), 0);
3023 // Broadcast legit commitment tx from B on A's chain
3024 let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
3025 check_spends!(commitment_tx[0], chan_1.3);
3027 connect_block(&nodes[0], &Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
3028 check_closed_broadcast!(nodes[0], false);
3029 check_added_monitors!(nodes[0], 1);
3030 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 1 timeout tx
3031 assert_eq!(node_txn.len(), 3);
3032 check_spends!(node_txn[0], commitment_tx[0]);
3033 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3034 check_spends!(node_txn[1], chan_1.3);
3035 check_spends!(node_txn[2], node_txn[1]);
3036 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
3037 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3041 fn test_simple_commitment_revoked_fail_backward() {
3042 // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
3043 // and fail backward accordingly.
3045 let chanmon_cfgs = create_chanmon_cfgs(3);
3046 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3047 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3048 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3050 // Create some initial channels
3051 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3052 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3054 let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3055 // Get the will-be-revoked local txn from nodes[2]
3056 let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3057 // Revoke the old state
3058 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, 3_000_000);
3060 let (_, payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3062 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
3063 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3064 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.block_hash());
3065 check_added_monitors!(nodes[1], 1);
3066 check_closed_broadcast!(nodes[1], false);
3068 expect_pending_htlcs_forwardable!(nodes[1]);
3069 check_added_monitors!(nodes[1], 1);
3070 let events = nodes[1].node.get_and_clear_pending_msg_events();
3071 assert_eq!(events.len(), 1);
3073 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, .. } } => {
3074 assert!(update_add_htlcs.is_empty());
3075 assert_eq!(update_fail_htlcs.len(), 1);
3076 assert!(update_fulfill_htlcs.is_empty());
3077 assert!(update_fail_malformed_htlcs.is_empty());
3078 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3080 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3081 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3083 let events = nodes[0].node.get_and_clear_pending_msg_events();
3084 assert_eq!(events.len(), 1);
3086 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3087 _ => panic!("Unexpected event"),
3089 expect_payment_failed!(nodes[0], payment_hash, false);
3091 _ => panic!("Unexpected event"),
3095 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
3096 // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
3097 // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
3098 // commitment transaction anymore.
3099 // To do this, we have the peer which will broadcast a revoked commitment transaction send
3100 // a number of update_fail/commitment_signed updates without ever sending the RAA in
3101 // response to our commitment_signed. This is somewhat misbehavior-y, though not
3102 // technically disallowed and we should probably handle it reasonably.
3103 // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
3104 // failed/fulfilled backwards must be in at least one of the latest two remote commitment
3106 // * Once we move it out of our holding cell/add it, we will immediately include it in a
3107 // commitment_signed (implying it will be in the latest remote commitment transaction).
3108 // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
3109 // and once they revoke the previous commitment transaction (allowing us to send a new
3110 // commitment_signed) we will be free to fail/fulfill the HTLC backwards.
3111 let chanmon_cfgs = create_chanmon_cfgs(3);
3112 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3113 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3114 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3116 // Create some initial channels
3117 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3118 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3120 let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], if no_to_remote { 10_000 } else { 3_000_000 });
3121 // Get the will-be-revoked local txn from nodes[2]
3122 let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3123 assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
3124 // Revoke the old state
3125 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, if no_to_remote { 10_000 } else { 3_000_000});
3127 let value = if use_dust {
3128 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
3129 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
3130 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().holder_dust_limit_satoshis * 1000
3133 let (_, first_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3134 let (_, second_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3135 let (_, third_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3137 assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash, &None));
3138 expect_pending_htlcs_forwardable!(nodes[2]);
3139 check_added_monitors!(nodes[2], 1);
3140 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3141 assert!(updates.update_add_htlcs.is_empty());
3142 assert!(updates.update_fulfill_htlcs.is_empty());
3143 assert!(updates.update_fail_malformed_htlcs.is_empty());
3144 assert_eq!(updates.update_fail_htlcs.len(), 1);
3145 assert!(updates.update_fee.is_none());
3146 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3147 let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
3148 // Drop the last RAA from 3 -> 2
3150 assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash, &None));
3151 expect_pending_htlcs_forwardable!(nodes[2]);
3152 check_added_monitors!(nodes[2], 1);
3153 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3154 assert!(updates.update_add_htlcs.is_empty());
3155 assert!(updates.update_fulfill_htlcs.is_empty());
3156 assert!(updates.update_fail_malformed_htlcs.is_empty());
3157 assert_eq!(updates.update_fail_htlcs.len(), 1);
3158 assert!(updates.update_fee.is_none());
3159 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3160 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3161 check_added_monitors!(nodes[1], 1);
3162 // Note that nodes[1] is in AwaitingRAA, so won't send a CS
3163 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3164 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3165 check_added_monitors!(nodes[2], 1);
3167 assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash, &None));
3168 expect_pending_htlcs_forwardable!(nodes[2]);
3169 check_added_monitors!(nodes[2], 1);
3170 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3171 assert!(updates.update_add_htlcs.is_empty());
3172 assert!(updates.update_fulfill_htlcs.is_empty());
3173 assert!(updates.update_fail_malformed_htlcs.is_empty());
3174 assert_eq!(updates.update_fail_htlcs.len(), 1);
3175 assert!(updates.update_fee.is_none());
3176 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3177 // At this point first_payment_hash has dropped out of the latest two commitment
3178 // transactions that nodes[1] is tracking...
3179 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3180 check_added_monitors!(nodes[1], 1);
3181 // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
3182 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3183 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3184 check_added_monitors!(nodes[2], 1);
3186 // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
3187 // on nodes[2]'s RAA.
3188 let (_, fourth_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3189 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3190 let logger = test_utils::TestLogger::new();
3191 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, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3192 nodes[1].node.send_payment(&route, fourth_payment_hash, &None).unwrap();
3193 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3194 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3195 check_added_monitors!(nodes[1], 0);
3198 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
3199 // One monitor for the new revocation preimage, no second on as we won't generate a new
3200 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
3201 check_added_monitors!(nodes[1], 1);
3202 let events = nodes[1].node.get_and_clear_pending_events();
3203 assert_eq!(events.len(), 1);
3205 Event::PendingHTLCsForwardable { .. } => { },
3206 _ => panic!("Unexpected event"),
3208 // Deliberately don't process the pending fail-back so they all fail back at once after
3209 // block connection just like the !deliver_bs_raa case
3212 let mut failed_htlcs = HashSet::new();
3213 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3215 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
3216 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3217 check_added_monitors!(nodes[1], 1);
3218 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.block_hash());
3220 let events = nodes[1].node.get_and_clear_pending_events();
3221 assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
3223 Event::PaymentFailed { ref payment_hash, .. } => {
3224 assert_eq!(*payment_hash, fourth_payment_hash);
3226 _ => panic!("Unexpected event"),
3228 if !deliver_bs_raa {
3230 Event::PendingHTLCsForwardable { .. } => { },
3231 _ => panic!("Unexpected event"),
3234 nodes[1].node.process_pending_htlc_forwards();
3235 check_added_monitors!(nodes[1], 1);
3237 let events = nodes[1].node.get_and_clear_pending_msg_events();
3238 assert_eq!(events.len(), if deliver_bs_raa { 3 } else { 2 });
3239 match events[if deliver_bs_raa { 1 } else { 0 }] {
3240 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
3241 _ => panic!("Unexpected event"),
3245 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, .. } } => {
3246 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
3247 assert_eq!(update_add_htlcs.len(), 1);
3248 assert!(update_fulfill_htlcs.is_empty());
3249 assert!(update_fail_htlcs.is_empty());
3250 assert!(update_fail_malformed_htlcs.is_empty());
3252 _ => panic!("Unexpected event"),
3255 match events[if deliver_bs_raa { 2 } else { 1 }] {
3256 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, .. } } => {
3257 assert!(update_add_htlcs.is_empty());
3258 assert_eq!(update_fail_htlcs.len(), 3);
3259 assert!(update_fulfill_htlcs.is_empty());
3260 assert!(update_fail_malformed_htlcs.is_empty());
3261 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3263 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3264 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
3265 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
3267 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3269 let events = nodes[0].node.get_and_clear_pending_msg_events();
3270 // If we delivered B's RAA we got an unknown preimage error, not something
3271 // that we should update our routing table for.
3272 assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
3273 for event in events {
3275 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3276 _ => panic!("Unexpected event"),
3279 let events = nodes[0].node.get_and_clear_pending_events();
3280 assert_eq!(events.len(), 3);
3282 Event::PaymentFailed { ref payment_hash, .. } => {
3283 assert!(failed_htlcs.insert(payment_hash.0));
3285 _ => panic!("Unexpected event"),
3288 Event::PaymentFailed { ref payment_hash, .. } => {
3289 assert!(failed_htlcs.insert(payment_hash.0));
3291 _ => panic!("Unexpected event"),
3294 Event::PaymentFailed { ref payment_hash, .. } => {
3295 assert!(failed_htlcs.insert(payment_hash.0));
3297 _ => panic!("Unexpected event"),
3300 _ => panic!("Unexpected event"),
3303 assert!(failed_htlcs.contains(&first_payment_hash.0));
3304 assert!(failed_htlcs.contains(&second_payment_hash.0));
3305 assert!(failed_htlcs.contains(&third_payment_hash.0));
3309 fn test_commitment_revoked_fail_backward_exhaustive_a() {
3310 do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
3311 do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
3312 do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
3313 do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
3317 fn test_commitment_revoked_fail_backward_exhaustive_b() {
3318 do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
3319 do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
3320 do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
3321 do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
3325 fn fail_backward_pending_htlc_upon_channel_failure() {
3326 let chanmon_cfgs = create_chanmon_cfgs(2);
3327 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3328 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3329 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3330 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
3331 let logger = test_utils::TestLogger::new();
3333 // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
3335 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
3336 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3337 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, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3338 nodes[0].node.send_payment(&route, payment_hash, &None).unwrap();
3339 check_added_monitors!(nodes[0], 1);
3341 let payment_event = {
3342 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3343 assert_eq!(events.len(), 1);
3344 SendEvent::from_event(events.remove(0))
3346 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3347 assert_eq!(payment_event.msgs.len(), 1);
3350 // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3351 let (_, failed_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3353 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3354 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, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3355 nodes[0].node.send_payment(&route, failed_payment_hash, &None).unwrap();
3356 check_added_monitors!(nodes[0], 0);
3358 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3361 // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3363 let (_, payment_hash) = get_payment_preimage_hash!(nodes[1]);
3365 let secp_ctx = Secp256k1::new();
3366 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
3367 let current_height = nodes[1].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
3368 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3369 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, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3370 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &None, current_height).unwrap();
3371 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3372 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3374 // Send a 0-msat update_add_htlc to fail the channel.
3375 let update_add_htlc = msgs::UpdateAddHTLC {
3381 onion_routing_packet,
3383 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3386 // Check that Alice fails backward the pending HTLC from the second payment.
3387 expect_payment_failed!(nodes[0], failed_payment_hash, true);
3388 check_closed_broadcast!(nodes[0], true);
3389 check_added_monitors!(nodes[0], 1);
3393 fn test_htlc_ignore_latest_remote_commitment() {
3394 // Test that HTLC transactions spending the latest remote commitment transaction are simply
3395 // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3396 let chanmon_cfgs = create_chanmon_cfgs(2);
3397 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3398 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3399 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3400 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3402 route_payment(&nodes[0], &[&nodes[1]], 10000000);
3403 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
3404 check_closed_broadcast!(nodes[0], false);
3405 check_added_monitors!(nodes[0], 1);
3407 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3408 assert_eq!(node_txn.len(), 2);
3410 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3411 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
3412 check_closed_broadcast!(nodes[1], false);
3413 check_added_monitors!(nodes[1], 1);
3415 // Duplicate the connect_block call since this may happen due to other listeners
3416 // registering new transactions
3417 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
3421 fn test_force_close_fail_back() {
3422 // Check which HTLCs are failed-backwards on channel force-closure
3423 let chanmon_cfgs = create_chanmon_cfgs(3);
3424 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3425 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3426 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3427 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3428 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3429 let logger = test_utils::TestLogger::new();
3431 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3433 let mut payment_event = {
3434 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3435 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, &Vec::new(), 1000000, 42, &logger).unwrap();
3436 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
3437 check_added_monitors!(nodes[0], 1);
3439 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3440 assert_eq!(events.len(), 1);
3441 SendEvent::from_event(events.remove(0))
3444 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3445 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3447 expect_pending_htlcs_forwardable!(nodes[1]);
3449 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3450 assert_eq!(events_2.len(), 1);
3451 payment_event = SendEvent::from_event(events_2.remove(0));
3452 assert_eq!(payment_event.msgs.len(), 1);
3454 check_added_monitors!(nodes[1], 1);
3455 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3456 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3457 check_added_monitors!(nodes[2], 1);
3458 let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3460 // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3461 // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3462 // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3464 nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id).unwrap();
3465 check_closed_broadcast!(nodes[2], false);
3466 check_added_monitors!(nodes[2], 1);
3468 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3469 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3470 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3471 // back to nodes[1] upon timeout otherwise.
3472 assert_eq!(node_txn.len(), 1);
3477 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
3478 txdata: vec![tx.clone()],
3480 connect_block(&nodes[1], &block, 1);
3482 // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3483 check_closed_broadcast!(nodes[1], false);
3484 check_added_monitors!(nodes[1], 1);
3486 // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3488 let mut monitors = nodes[2].chain_monitor.chain_monitor.monitors.lock().unwrap();
3489 monitors.get_mut(&OutPoint{ txid: Txid::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), index: 0 }).unwrap()
3490 .provide_payment_preimage(&our_payment_hash, &our_payment_preimage, &node_cfgs[2].tx_broadcaster, &node_cfgs[2].fee_estimator, &&logger);
3492 connect_block(&nodes[2], &block, 1);
3493 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3494 assert_eq!(node_txn.len(), 1);
3495 assert_eq!(node_txn[0].input.len(), 1);
3496 assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3497 assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3498 assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3500 check_spends!(node_txn[0], tx);
3504 fn test_unconf_chan() {
3505 // After creating a chan between nodes, we disconnect all blocks previously seen to force a channel close on nodes[0] side
3506 let chanmon_cfgs = create_chanmon_cfgs(2);
3507 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3508 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3509 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3510 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3512 let channel_state = nodes[0].node.channel_state.lock().unwrap();
3513 assert_eq!(channel_state.by_id.len(), 1);
3514 assert_eq!(channel_state.short_to_id.len(), 1);
3515 mem::drop(channel_state);
3517 let mut headers = Vec::new();
3518 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3519 headers.push(header.clone());
3521 header = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3522 headers.push(header.clone());
3524 while !headers.is_empty() {
3525 nodes[0].node.block_disconnected(&headers.pop().unwrap());
3527 check_closed_broadcast!(nodes[0], false);
3528 check_added_monitors!(nodes[0], 1);
3529 let channel_state = nodes[0].node.channel_state.lock().unwrap();
3530 assert_eq!(channel_state.by_id.len(), 0);
3531 assert_eq!(channel_state.short_to_id.len(), 0);
3535 fn test_simple_peer_disconnect() {
3536 // Test that we can reconnect when there are no lost messages
3537 let chanmon_cfgs = create_chanmon_cfgs(3);
3538 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3539 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3540 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3541 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3542 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3544 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3545 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3546 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3548 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3549 let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3550 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3551 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1, 1_000_000);
3553 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3554 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3555 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3557 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3558 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3559 let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3560 let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3562 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3563 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3565 claim_payment_along_route(&nodes[0], &vec!(&nodes[1], &nodes[2]), true, payment_preimage_3, 1_000_000);
3566 fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3568 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3570 let events = nodes[0].node.get_and_clear_pending_events();
3571 assert_eq!(events.len(), 2);
3573 Event::PaymentSent { payment_preimage } => {
3574 assert_eq!(payment_preimage, payment_preimage_3);
3576 _ => panic!("Unexpected event"),
3579 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3580 assert_eq!(payment_hash, payment_hash_5);
3581 assert!(rejected_by_dest);
3583 _ => panic!("Unexpected event"),
3587 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4, 1_000_000);
3588 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3591 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
3592 // Test that we can reconnect when in-flight HTLC updates get dropped
3593 let chanmon_cfgs = create_chanmon_cfgs(2);
3594 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3595 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3596 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3597 if messages_delivered == 0 {
3598 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3599 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3601 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3604 let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
3606 let logger = test_utils::TestLogger::new();
3607 let payment_event = {
3608 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3609 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3610 &nodes[1].node.get_our_node_id(), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3611 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3612 nodes[0].node.send_payment(&route, payment_hash_1, &None).unwrap();
3613 check_added_monitors!(nodes[0], 1);
3615 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3616 assert_eq!(events.len(), 1);
3617 SendEvent::from_event(events.remove(0))
3619 assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3621 if messages_delivered < 2 {
3622 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3624 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3625 if messages_delivered >= 3 {
3626 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3627 check_added_monitors!(nodes[1], 1);
3628 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3630 if messages_delivered >= 4 {
3631 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3632 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3633 check_added_monitors!(nodes[0], 1);
3635 if messages_delivered >= 5 {
3636 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3637 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3638 // No commitment_signed so get_event_msg's assert(len == 1) passes
3639 check_added_monitors!(nodes[0], 1);
3641 if messages_delivered >= 6 {
3642 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3643 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3644 check_added_monitors!(nodes[1], 1);
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 if messages_delivered < 3 {
3654 // Even if the funding_locked messages get exchanged, as long as nothing further was
3655 // received on either side, both sides will need to resend them.
3656 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3657 } else if messages_delivered == 3 {
3658 // nodes[0] still wants its RAA + commitment_signed
3659 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3660 } else if messages_delivered == 4 {
3661 // nodes[0] still wants its commitment_signed
3662 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3663 } else if messages_delivered == 5 {
3664 // nodes[1] still wants its final RAA
3665 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3666 } else if messages_delivered == 6 {
3667 // Everything was delivered...
3668 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3671 let events_1 = nodes[1].node.get_and_clear_pending_events();
3672 assert_eq!(events_1.len(), 1);
3674 Event::PendingHTLCsForwardable { .. } => { },
3675 _ => panic!("Unexpected event"),
3678 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3679 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3680 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3682 nodes[1].node.process_pending_htlc_forwards();
3684 let events_2 = nodes[1].node.get_and_clear_pending_events();
3685 assert_eq!(events_2.len(), 1);
3687 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
3688 assert_eq!(payment_hash_1, *payment_hash);
3689 assert_eq!(*payment_secret, None);
3690 assert_eq!(amt, 1000000);
3692 _ => panic!("Unexpected event"),
3695 nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000);
3696 check_added_monitors!(nodes[1], 1);
3698 let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3699 assert_eq!(events_3.len(), 1);
3700 let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3701 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3702 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3703 assert!(updates.update_add_htlcs.is_empty());
3704 assert!(updates.update_fail_htlcs.is_empty());
3705 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3706 assert!(updates.update_fail_malformed_htlcs.is_empty());
3707 assert!(updates.update_fee.is_none());
3708 (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3710 _ => panic!("Unexpected event"),
3713 if messages_delivered >= 1 {
3714 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3716 let events_4 = nodes[0].node.get_and_clear_pending_events();
3717 assert_eq!(events_4.len(), 1);
3719 Event::PaymentSent { ref payment_preimage } => {
3720 assert_eq!(payment_preimage_1, *payment_preimage);
3722 _ => panic!("Unexpected event"),
3725 if messages_delivered >= 2 {
3726 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3727 check_added_monitors!(nodes[0], 1);
3728 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3730 if messages_delivered >= 3 {
3731 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3732 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3733 check_added_monitors!(nodes[1], 1);
3735 if messages_delivered >= 4 {
3736 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3737 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3738 // No commitment_signed so get_event_msg's assert(len == 1) passes
3739 check_added_monitors!(nodes[1], 1);
3741 if messages_delivered >= 5 {
3742 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3743 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3744 check_added_monitors!(nodes[0], 1);
3751 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3752 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3753 if messages_delivered < 2 {
3754 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3755 //TODO: Deduplicate PaymentSent events, then enable this if:
3756 //if messages_delivered < 1 {
3757 let events_4 = nodes[0].node.get_and_clear_pending_events();
3758 assert_eq!(events_4.len(), 1);
3760 Event::PaymentSent { ref payment_preimage } => {
3761 assert_eq!(payment_preimage_1, *payment_preimage);
3763 _ => panic!("Unexpected event"),
3766 } else if messages_delivered == 2 {
3767 // nodes[0] still wants its RAA + commitment_signed
3768 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3769 } else if messages_delivered == 3 {
3770 // nodes[0] still wants its commitment_signed
3771 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3772 } else if messages_delivered == 4 {
3773 // nodes[1] still wants its final RAA
3774 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3775 } else if messages_delivered == 5 {
3776 // Everything was delivered...
3777 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3780 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3781 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3782 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3784 // Channel should still work fine...
3785 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3786 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3787 &nodes[1].node.get_our_node_id(), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3788 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3789 let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3790 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3794 fn test_drop_messages_peer_disconnect_a() {
3795 do_test_drop_messages_peer_disconnect(0);
3796 do_test_drop_messages_peer_disconnect(1);
3797 do_test_drop_messages_peer_disconnect(2);
3798 do_test_drop_messages_peer_disconnect(3);
3802 fn test_drop_messages_peer_disconnect_b() {
3803 do_test_drop_messages_peer_disconnect(4);
3804 do_test_drop_messages_peer_disconnect(5);
3805 do_test_drop_messages_peer_disconnect(6);
3809 fn test_funding_peer_disconnect() {
3810 // Test that we can lock in our funding tx while disconnected
3811 let chanmon_cfgs = create_chanmon_cfgs(2);
3812 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3813 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3814 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3815 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3817 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3818 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3820 confirm_transaction(&nodes[0], &tx);
3821 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3822 assert_eq!(events_1.len(), 1);
3824 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3825 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3827 _ => panic!("Unexpected event"),
3830 reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3832 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3833 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3835 confirm_transaction(&nodes[1], &tx);
3836 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3837 assert_eq!(events_2.len(), 2);
3838 let funding_locked = match events_2[0] {
3839 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3840 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3843 _ => panic!("Unexpected event"),
3845 let bs_announcement_sigs = match events_2[1] {
3846 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3847 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3850 _ => panic!("Unexpected event"),
3853 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3855 nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3856 nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3857 let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3858 assert_eq!(events_3.len(), 2);
3859 let as_announcement_sigs = match events_3[0] {
3860 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3861 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3864 _ => panic!("Unexpected event"),
3866 let (as_announcement, as_update) = match events_3[1] {
3867 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3868 (msg.clone(), update_msg.clone())
3870 _ => panic!("Unexpected event"),
3873 nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3874 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3875 assert_eq!(events_4.len(), 1);
3876 let (_, bs_update) = match events_4[0] {
3877 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3878 (msg.clone(), update_msg.clone())
3880 _ => panic!("Unexpected event"),
3883 nodes[0].net_graph_msg_handler.handle_channel_announcement(&as_announcement).unwrap();
3884 nodes[0].net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
3885 nodes[0].net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
3887 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3888 let logger = test_utils::TestLogger::new();
3889 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, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3890 let (payment_preimage, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3891 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage, 1_000_000);
3895 fn test_drop_messages_peer_disconnect_dual_htlc() {
3896 // Test that we can handle reconnecting when both sides of a channel have pending
3897 // commitment_updates when we disconnect.
3898 let chanmon_cfgs = create_chanmon_cfgs(2);
3899 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3900 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3901 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3902 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3903 let logger = test_utils::TestLogger::new();
3905 let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3907 // Now try to send a second payment which will fail to send
3908 let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
3909 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3910 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, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3911 nodes[0].node.send_payment(&route, payment_hash_2, &None).unwrap();
3912 check_added_monitors!(nodes[0], 1);
3914 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3915 assert_eq!(events_1.len(), 1);
3917 MessageSendEvent::UpdateHTLCs { .. } => {},
3918 _ => panic!("Unexpected event"),
3921 assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000));
3922 check_added_monitors!(nodes[1], 1);
3924 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3925 assert_eq!(events_2.len(), 1);
3927 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 } } => {
3928 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3929 assert!(update_add_htlcs.is_empty());
3930 assert_eq!(update_fulfill_htlcs.len(), 1);
3931 assert!(update_fail_htlcs.is_empty());
3932 assert!(update_fail_malformed_htlcs.is_empty());
3933 assert!(update_fee.is_none());
3935 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3936 let events_3 = nodes[0].node.get_and_clear_pending_events();
3937 assert_eq!(events_3.len(), 1);
3939 Event::PaymentSent { ref payment_preimage } => {
3940 assert_eq!(*payment_preimage, payment_preimage_1);
3942 _ => panic!("Unexpected event"),
3945 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
3946 let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3947 // No commitment_signed so get_event_msg's assert(len == 1) passes
3948 check_added_monitors!(nodes[0], 1);
3950 _ => panic!("Unexpected event"),
3953 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3954 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3956 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3957 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3958 assert_eq!(reestablish_1.len(), 1);
3959 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3960 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3961 assert_eq!(reestablish_2.len(), 1);
3963 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3964 let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3965 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3966 let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3968 assert!(as_resp.0.is_none());
3969 assert!(bs_resp.0.is_none());
3971 assert!(bs_resp.1.is_none());
3972 assert!(bs_resp.2.is_none());
3974 assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3976 assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3977 assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3978 assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3979 assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3980 assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3981 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
3982 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
3983 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3984 // No commitment_signed so get_event_msg's assert(len == 1) passes
3985 check_added_monitors!(nodes[1], 1);
3987 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
3988 let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3989 assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
3990 assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
3991 assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
3992 assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
3993 assert!(bs_second_commitment_signed.update_fee.is_none());
3994 check_added_monitors!(nodes[1], 1);
3996 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3997 let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3998 assert!(as_commitment_signed.update_add_htlcs.is_empty());
3999 assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
4000 assert!(as_commitment_signed.update_fail_htlcs.is_empty());
4001 assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
4002 assert!(as_commitment_signed.update_fee.is_none());
4003 check_added_monitors!(nodes[0], 1);
4005 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
4006 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4007 // No commitment_signed so get_event_msg's assert(len == 1) passes
4008 check_added_monitors!(nodes[0], 1);
4010 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
4011 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4012 // No commitment_signed so get_event_msg's assert(len == 1) passes
4013 check_added_monitors!(nodes[1], 1);
4015 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
4016 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4017 check_added_monitors!(nodes[1], 1);
4019 expect_pending_htlcs_forwardable!(nodes[1]);
4021 let events_5 = nodes[1].node.get_and_clear_pending_events();
4022 assert_eq!(events_5.len(), 1);
4024 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt: _ } => {
4025 assert_eq!(payment_hash_2, *payment_hash);
4026 assert_eq!(*payment_secret, None);
4028 _ => panic!("Unexpected event"),
4031 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
4032 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4033 check_added_monitors!(nodes[0], 1);
4035 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
4038 fn do_test_htlc_timeout(send_partial_mpp: bool) {
4039 // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
4040 // to avoid our counterparty failing the channel.
4041 let chanmon_cfgs = create_chanmon_cfgs(2);
4042 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4043 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4044 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4046 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4047 let logger = test_utils::TestLogger::new();
4049 let our_payment_hash = if send_partial_mpp {
4050 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4051 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, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4052 let (_, our_payment_hash) = get_payment_preimage_hash!(&nodes[0]);
4053 let payment_secret = PaymentSecret([0xdb; 32]);
4054 // Use the utility function send_payment_along_path to send the payment with MPP data which
4055 // indicates there are more HTLCs coming.
4056 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200000, CHAN_CONFIRM_DEPTH).unwrap();
4057 check_added_monitors!(nodes[0], 1);
4058 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4059 assert_eq!(events.len(), 1);
4060 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
4061 // hop should *not* yet generate any PaymentReceived event(s).
4062 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false);
4065 route_payment(&nodes[0], &[&nodes[1]], 100000).1
4068 let mut block = Block {
4069 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
4072 connect_block(&nodes[0], &block, 101);
4073 connect_block(&nodes[1], &block, 101);
4074 for i in 102..TEST_FINAL_CLTV + 100 + 1 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS {
4075 block.header.prev_blockhash = block.block_hash();
4076 connect_block(&nodes[0], &block, i);
4077 connect_block(&nodes[1], &block, i);
4080 expect_pending_htlcs_forwardable!(nodes[1]);
4082 check_added_monitors!(nodes[1], 1);
4083 let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4084 assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
4085 assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
4086 assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
4087 assert!(htlc_timeout_updates.update_fee.is_none());
4089 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
4090 commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
4091 // 100_000 msat as u64, followed by a height of 123 as u32
4092 let mut expected_failure_data = byte_utils::be64_to_array(100_000).to_vec();
4093 expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(123));
4094 expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
4098 fn test_htlc_timeout() {
4099 do_test_htlc_timeout(true);
4100 do_test_htlc_timeout(false);
4103 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
4104 // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
4105 let chanmon_cfgs = create_chanmon_cfgs(3);
4106 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4107 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4108 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4109 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4110 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
4111 let logger = test_utils::TestLogger::new();
4113 // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
4114 let (_, first_payment_hash) = get_payment_preimage_hash!(nodes[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, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4118 nodes[1].node.send_payment(&route, first_payment_hash, &None).unwrap();
4120 assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
4121 check_added_monitors!(nodes[1], 1);
4123 // Now attempt to route a second payment, which should be placed in the holding cell
4124 let (_, second_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4126 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4127 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, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4128 nodes[0].node.send_payment(&route, second_payment_hash, &None).unwrap();
4129 check_added_monitors!(nodes[0], 1);
4130 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4131 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
4132 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4133 expect_pending_htlcs_forwardable!(nodes[1]);
4134 check_added_monitors!(nodes[1], 0);
4136 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4137 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, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4138 nodes[1].node.send_payment(&route, second_payment_hash, &None).unwrap();
4139 check_added_monitors!(nodes[1], 0);
4142 let mut block = Block {
4143 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
4146 connect_block(&nodes[1], &block, 101);
4147 for i in 102..TEST_FINAL_CLTV + 100 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS {
4148 block.header.prev_blockhash = block.block_hash();
4149 connect_block(&nodes[1], &block, i);
4152 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4153 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4155 block.header.prev_blockhash = block.block_hash();
4156 connect_block(&nodes[1], &block, TEST_FINAL_CLTV + 100 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS);
4159 expect_pending_htlcs_forwardable!(nodes[1]);
4160 check_added_monitors!(nodes[1], 1);
4161 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
4162 assert_eq!(fail_commit.len(), 1);
4163 match fail_commit[0] {
4164 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
4165 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
4166 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
4168 _ => unreachable!(),
4170 expect_payment_failed!(nodes[0], second_payment_hash, false);
4171 if let &MessageSendEvent::PaymentFailureNetworkUpdate { ref update } = &nodes[0].node.get_and_clear_pending_msg_events()[0] {
4173 &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {},
4174 _ => panic!("Unexpected event"),
4177 panic!("Unexpected event");
4180 expect_payment_failed!(nodes[1], second_payment_hash, true);
4185 fn test_holding_cell_htlc_add_timeouts() {
4186 do_test_holding_cell_htlc_add_timeouts(false);
4187 do_test_holding_cell_htlc_add_timeouts(true);
4191 fn test_invalid_channel_announcement() {
4192 //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
4193 let secp_ctx = Secp256k1::new();
4194 let chanmon_cfgs = create_chanmon_cfgs(2);
4195 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4196 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4197 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4199 let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
4201 let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
4202 let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
4203 let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4204 let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4206 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 } );
4208 let as_bitcoin_key = as_chan.get_keys().inner.holder_channel_pubkeys.funding_pubkey;
4209 let bs_bitcoin_key = bs_chan.get_keys().inner.holder_channel_pubkeys.funding_pubkey;
4211 let as_network_key = nodes[0].node.get_our_node_id();
4212 let bs_network_key = nodes[1].node.get_our_node_id();
4214 let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
4216 let mut chan_announcement;
4218 macro_rules! dummy_unsigned_msg {
4220 msgs::UnsignedChannelAnnouncement {
4221 features: ChannelFeatures::known(),
4222 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4223 short_channel_id: as_chan.get_short_channel_id().unwrap(),
4224 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
4225 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
4226 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
4227 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
4228 excess_data: Vec::new(),
4233 macro_rules! sign_msg {
4234 ($unsigned_msg: expr) => {
4235 let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
4236 let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_keys().inner.funding_key);
4237 let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_keys().inner.funding_key);
4238 let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
4239 let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
4240 chan_announcement = msgs::ChannelAnnouncement {
4241 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
4242 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
4243 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
4244 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
4245 contents: $unsigned_msg
4250 let unsigned_msg = dummy_unsigned_msg!();
4251 sign_msg!(unsigned_msg);
4252 assert_eq!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).unwrap(), true);
4253 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 } );
4255 // Configured with Network::Testnet
4256 let mut unsigned_msg = dummy_unsigned_msg!();
4257 unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.block_hash();
4258 sign_msg!(unsigned_msg);
4259 assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4261 let mut unsigned_msg = dummy_unsigned_msg!();
4262 unsigned_msg.chain_hash = BlockHash::hash(&[1,2,3,4,5,6,7,8,9]);
4263 sign_msg!(unsigned_msg);
4264 assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4268 fn test_no_txn_manager_serialize_deserialize() {
4269 let chanmon_cfgs = create_chanmon_cfgs(2);
4270 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4271 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4272 let logger: test_utils::TestLogger;
4273 let fee_estimator: test_utils::TestFeeEstimator;
4274 let persister: test_utils::TestPersister;
4275 let new_chain_monitor: test_utils::TestChainMonitor;
4276 let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4277 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4279 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
4281 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4283 let nodes_0_serialized = nodes[0].node.encode();
4284 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4285 nodes[0].chain_monitor.chain_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4287 logger = test_utils::TestLogger::new();
4288 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4289 persister = test_utils::TestPersister::new();
4290 let keys_manager = &chanmon_cfgs[0].keys_manager;
4291 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4292 nodes[0].chain_monitor = &new_chain_monitor;
4293 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4294 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(
4295 &mut chan_0_monitor_read, keys_manager).unwrap();
4296 assert!(chan_0_monitor_read.is_empty());
4298 let mut nodes_0_read = &nodes_0_serialized[..];
4299 let config = UserConfig::default();
4300 let (_, nodes_0_deserialized_tmp) = {
4301 let mut channel_monitors = HashMap::new();
4302 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4303 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4304 default_config: config,
4306 fee_estimator: &fee_estimator,
4307 chain_monitor: nodes[0].chain_monitor,
4308 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4313 nodes_0_deserialized = nodes_0_deserialized_tmp;
4314 assert!(nodes_0_read.is_empty());
4316 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4317 nodes[0].node = &nodes_0_deserialized;
4318 assert_eq!(nodes[0].node.list_channels().len(), 1);
4319 check_added_monitors!(nodes[0], 1);
4321 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4322 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4323 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4324 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4326 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4327 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4328 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4329 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4331 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4332 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4333 for node in nodes.iter() {
4334 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4335 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4336 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4339 send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
4343 fn test_manager_serialize_deserialize_events() {
4344 // This test makes sure the events field in ChannelManager survives de/serialization
4345 let chanmon_cfgs = create_chanmon_cfgs(2);
4346 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4347 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4348 let fee_estimator: test_utils::TestFeeEstimator;
4349 let persister: test_utils::TestPersister;
4350 let logger: test_utils::TestLogger;
4351 let new_chain_monitor: test_utils::TestChainMonitor;
4352 let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4353 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4355 // Start creating a channel, but stop right before broadcasting the event message FundingBroadcastSafe
4356 let channel_value = 100000;
4357 let push_msat = 10001;
4358 let a_flags = InitFeatures::known();
4359 let b_flags = InitFeatures::known();
4360 let node_a = nodes.remove(0);
4361 let node_b = nodes.remove(0);
4362 node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
4363 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()));
4364 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()));
4366 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&node_a, channel_value, 42);
4368 node_a.node.funding_transaction_generated(&temporary_channel_id, funding_output);
4369 check_added_monitors!(node_a, 0);
4371 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()));
4373 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
4374 assert_eq!(added_monitors.len(), 1);
4375 assert_eq!(added_monitors[0].0, funding_output);
4376 added_monitors.clear();
4379 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()));
4381 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
4382 assert_eq!(added_monitors.len(), 1);
4383 assert_eq!(added_monitors[0].0, funding_output);
4384 added_monitors.clear();
4386 // Normally, this is where node_a would check for a FundingBroadcastSafe event, but the test de/serializes first instead
4391 // Start the de/seriailization process mid-channel creation to check that the channel manager will hold onto events that are serialized
4392 let nodes_0_serialized = nodes[0].node.encode();
4393 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4394 nodes[0].chain_monitor.chain_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4396 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4397 logger = test_utils::TestLogger::new();
4398 persister = test_utils::TestPersister::new();
4399 let keys_manager = &chanmon_cfgs[0].keys_manager;
4400 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4401 nodes[0].chain_monitor = &new_chain_monitor;
4402 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4403 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(
4404 &mut chan_0_monitor_read, keys_manager).unwrap();
4405 assert!(chan_0_monitor_read.is_empty());
4407 let mut nodes_0_read = &nodes_0_serialized[..];
4408 let config = UserConfig::default();
4409 let (_, nodes_0_deserialized_tmp) = {
4410 let mut channel_monitors = HashMap::new();
4411 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4412 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4413 default_config: config,
4415 fee_estimator: &fee_estimator,
4416 chain_monitor: nodes[0].chain_monitor,
4417 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4422 nodes_0_deserialized = nodes_0_deserialized_tmp;
4423 assert!(nodes_0_read.is_empty());
4425 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4427 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4428 nodes[0].node = &nodes_0_deserialized;
4430 // After deserializing, make sure the FundingBroadcastSafe event is still held by the channel manager
4431 let events_4 = nodes[0].node.get_and_clear_pending_events();
4432 assert_eq!(events_4.len(), 1);
4434 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
4435 assert_eq!(user_channel_id, 42);
4436 assert_eq!(*funding_txo, funding_output);
4438 _ => panic!("Unexpected event"),
4441 // Make sure the channel is functioning as though the de/serialization never happened
4442 assert_eq!(nodes[0].node.list_channels().len(), 1);
4443 check_added_monitors!(nodes[0], 1);
4445 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4446 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4447 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4448 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4450 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4451 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4452 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4453 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4455 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4456 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4457 for node in nodes.iter() {
4458 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4459 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4460 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4463 send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
4467 fn test_simple_manager_serialize_deserialize() {
4468 let chanmon_cfgs = create_chanmon_cfgs(2);
4469 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4470 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4471 let logger: test_utils::TestLogger;
4472 let fee_estimator: test_utils::TestFeeEstimator;
4473 let persister: test_utils::TestPersister;
4474 let new_chain_monitor: test_utils::TestChainMonitor;
4475 let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4476 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4477 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4479 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4480 let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4482 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4484 let nodes_0_serialized = nodes[0].node.encode();
4485 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4486 nodes[0].chain_monitor.chain_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4488 logger = test_utils::TestLogger::new();
4489 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4490 persister = test_utils::TestPersister::new();
4491 let keys_manager = &chanmon_cfgs[0].keys_manager;
4492 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4493 nodes[0].chain_monitor = &new_chain_monitor;
4494 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4495 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(
4496 &mut chan_0_monitor_read, keys_manager).unwrap();
4497 assert!(chan_0_monitor_read.is_empty());
4499 let mut nodes_0_read = &nodes_0_serialized[..];
4500 let (_, nodes_0_deserialized_tmp) = {
4501 let mut channel_monitors = HashMap::new();
4502 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4503 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4504 default_config: UserConfig::default(),
4506 fee_estimator: &fee_estimator,
4507 chain_monitor: nodes[0].chain_monitor,
4508 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4513 nodes_0_deserialized = nodes_0_deserialized_tmp;
4514 assert!(nodes_0_read.is_empty());
4516 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4517 nodes[0].node = &nodes_0_deserialized;
4518 check_added_monitors!(nodes[0], 1);
4520 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4522 fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
4523 claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage, 1_000_000);
4527 fn test_manager_serialize_deserialize_inconsistent_monitor() {
4528 // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
4529 let chanmon_cfgs = create_chanmon_cfgs(4);
4530 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4531 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4532 let logger: test_utils::TestLogger;
4533 let fee_estimator: test_utils::TestFeeEstimator;
4534 let persister: test_utils::TestPersister;
4535 let new_chain_monitor: test_utils::TestChainMonitor;
4536 let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4537 let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4538 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4539 create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::known(), InitFeatures::known());
4540 let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
4542 let mut node_0_stale_monitors_serialized = Vec::new();
4543 for monitor in nodes[0].chain_monitor.chain_monitor.monitors.lock().unwrap().iter() {
4544 let mut writer = test_utils::TestVecWriter(Vec::new());
4545 monitor.1.write(&mut writer).unwrap();
4546 node_0_stale_monitors_serialized.push(writer.0);
4549 let (our_payment_preimage, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
4551 // Serialize the ChannelManager here, but the monitor we keep up-to-date
4552 let nodes_0_serialized = nodes[0].node.encode();
4554 route_payment(&nodes[0], &[&nodes[3]], 1000000);
4555 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4556 nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4557 nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4559 // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
4561 let mut node_0_monitors_serialized = Vec::new();
4562 for monitor in nodes[0].chain_monitor.chain_monitor.monitors.lock().unwrap().iter() {
4563 let mut writer = test_utils::TestVecWriter(Vec::new());
4564 monitor.1.write(&mut writer).unwrap();
4565 node_0_monitors_serialized.push(writer.0);
4568 logger = test_utils::TestLogger::new();
4569 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4570 persister = test_utils::TestPersister::new();
4571 let keys_manager = &chanmon_cfgs[0].keys_manager;
4572 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4573 nodes[0].chain_monitor = &new_chain_monitor;
4576 let mut node_0_stale_monitors = Vec::new();
4577 for serialized in node_0_stale_monitors_serialized.iter() {
4578 let mut read = &serialized[..];
4579 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut read, keys_manager).unwrap();
4580 assert!(read.is_empty());
4581 node_0_stale_monitors.push(monitor);
4584 let mut node_0_monitors = Vec::new();
4585 for serialized in node_0_monitors_serialized.iter() {
4586 let mut read = &serialized[..];
4587 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut read, keys_manager).unwrap();
4588 assert!(read.is_empty());
4589 node_0_monitors.push(monitor);
4592 let mut nodes_0_read = &nodes_0_serialized[..];
4593 if let Err(msgs::DecodeError::InvalidValue) =
4594 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4595 default_config: UserConfig::default(),
4597 fee_estimator: &fee_estimator,
4598 chain_monitor: nodes[0].chain_monitor,
4599 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4601 channel_monitors: node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4603 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
4606 let mut nodes_0_read = &nodes_0_serialized[..];
4607 let (_, nodes_0_deserialized_tmp) =
4608 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4609 default_config: UserConfig::default(),
4611 fee_estimator: &fee_estimator,
4612 chain_monitor: nodes[0].chain_monitor,
4613 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4615 channel_monitors: node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4617 nodes_0_deserialized = nodes_0_deserialized_tmp;
4618 assert!(nodes_0_read.is_empty());
4620 { // Channel close should result in a commitment tx and an HTLC tx
4621 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4622 assert_eq!(txn.len(), 2);
4623 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
4624 assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
4627 for monitor in node_0_monitors.drain(..) {
4628 assert!(nodes[0].chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor).is_ok());
4629 check_added_monitors!(nodes[0], 1);
4631 nodes[0].node = &nodes_0_deserialized;
4633 // nodes[1] and nodes[2] have no lost state with nodes[0]...
4634 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4635 reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4636 //... and we can even still claim the payment!
4637 claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage, 1_000_000);
4639 nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4640 let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4641 nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4642 nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
4643 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4644 assert_eq!(msg_events.len(), 1);
4645 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
4647 &ErrorAction::SendErrorMessage { ref msg } => {
4648 assert_eq!(msg.channel_id, channel_id);
4650 _ => panic!("Unexpected event!"),
4655 macro_rules! check_spendable_outputs {
4656 ($node: expr, $der_idx: expr, $keysinterface: expr, $chan_value: expr) => {
4658 let events = $node.chain_monitor.chain_monitor.get_and_clear_pending_events();
4659 let mut txn = Vec::new();
4660 for event in events {
4662 Event::SpendableOutputs { ref outputs } => {
4663 for outp in outputs {
4665 SpendableOutputDescriptor::StaticOutputCounterpartyPayment(ref descriptor) => {
4666 assert_eq!(descriptor.channel_value_satoshis, $chan_value);
4668 previous_output: descriptor.outpoint.into_bitcoin_outpoint(),
4669 script_sig: Script::new(),
4671 witness: Vec::new(),
4674 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4675 value: descriptor.output.value,
4677 let mut spend_tx = Transaction {
4683 spend_tx.output[0].value -= (spend_tx.get_weight() + 2 + 1 + 73 + 35 + 3) as u64 / 4; // (Max weight + 3 (to round up)) / 4
4684 let secp_ctx = Secp256k1::new();
4685 let keys = $keysinterface.derive_channel_keys($chan_value, &descriptor.channel_keys_id);
4686 let remotepubkey = keys.pubkeys().payment_point;
4687 let witness_script = Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: remotepubkey}, Network::Testnet).script_pubkey();
4688 let sighash = Message::from_slice(&bip143::SigHashCache::new(&spend_tx).signature_hash(0, &witness_script, descriptor.output.value, SigHashType::All)[..]).unwrap();
4689 let remotesig = secp_ctx.sign(&sighash, &keys.inner.payment_key);
4690 spend_tx.input[0].witness.push(remotesig.serialize_der().to_vec());
4691 spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4692 spend_tx.input[0].witness.push(remotepubkey.serialize().to_vec());
4695 SpendableOutputDescriptor::DynamicOutputP2WSH(ref descriptor) => {
4696 assert_eq!(descriptor.channel_value_satoshis, $chan_value);
4698 previous_output: descriptor.outpoint.into_bitcoin_outpoint(),
4699 script_sig: Script::new(),
4700 sequence: descriptor.to_self_delay as u32,
4701 witness: Vec::new(),
4704 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4705 value: descriptor.output.value,
4707 let mut spend_tx = Transaction {
4713 let secp_ctx = Secp256k1::new();
4714 let keys = $keysinterface.derive_channel_keys($chan_value, &descriptor.channel_keys_id);
4715 if let Ok(delayed_payment_key) = chan_utils::derive_private_key(&secp_ctx, &descriptor.per_commitment_point, &keys.inner.delayed_payment_base_key) {
4717 let delayed_payment_pubkey = PublicKey::from_secret_key(&secp_ctx, &delayed_payment_key);
4718 let witness_script = chan_utils::get_revokeable_redeemscript(&descriptor.revocation_pubkey, descriptor.to_self_delay, &delayed_payment_pubkey);
4719 spend_tx.output[0].value -= (spend_tx.get_weight() + 2 + 1 + 73 + 1 + witness_script.len() + 1 + 3) as u64 / 4; // (Max weight + 3 (to round up)) / 4
4720 let sighash = Message::from_slice(&bip143::SigHashCache::new(&spend_tx).signature_hash(0, &witness_script, descriptor.output.value, SigHashType::All)[..]).unwrap();
4721 let local_delayedsig = secp_ctx.sign(&sighash, &delayed_payment_key);
4722 spend_tx.input[0].witness.push(local_delayedsig.serialize_der().to_vec());
4723 spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4724 spend_tx.input[0].witness.push(vec!()); //MINIMALIF
4725 spend_tx.input[0].witness.push(witness_script.clone().into_bytes());
4729 SpendableOutputDescriptor::StaticOutput { ref outpoint, ref output } => {
4730 let secp_ctx = Secp256k1::new();
4732 previous_output: outpoint.into_bitcoin_outpoint(),
4733 script_sig: Script::new(),
4735 witness: Vec::new(),
4738 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4739 value: output.value,
4741 let mut spend_tx = Transaction {
4745 output: vec![outp.clone()],
4747 spend_tx.output[0].value -= (spend_tx.get_weight() + 2 + 1 + 73 + 34 + 3) as u64 / 4; // (Max weight + 3 (to round up)) / 4
4749 match ExtendedPrivKey::new_master(Network::Testnet, &$node.node_seed) {
4751 match master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx($der_idx).expect("key space exhausted")) {
4753 Err(_) => panic!("Your RNG is busted"),
4756 Err(_) => panic!("Your rng is busted"),
4759 let pubkey = ExtendedPubKey::from_private(&secp_ctx, &secret).public_key;
4760 let witness_script = Address::p2pkh(&pubkey, Network::Testnet).script_pubkey();
4761 let sighash = Message::from_slice(&bip143::SigHashCache::new(&spend_tx).signature_hash(0, &witness_script, output.value, SigHashType::All)[..]).unwrap();
4762 let sig = secp_ctx.sign(&sighash, &secret.private_key.key);
4763 spend_tx.input[0].witness.push(sig.serialize_der().to_vec());
4764 spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4765 spend_tx.input[0].witness.push(pubkey.key.serialize().to_vec());
4771 _ => panic!("Unexpected event"),
4780 fn test_claim_sizeable_push_msat() {
4781 // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4782 let chanmon_cfgs = create_chanmon_cfgs(2);
4783 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4784 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4785 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4787 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4788 nodes[1].node.force_close_channel(&chan.2).unwrap();
4789 check_closed_broadcast!(nodes[1], false);
4790 check_added_monitors!(nodes[1], 1);
4791 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4792 assert_eq!(node_txn.len(), 1);
4793 check_spends!(node_txn[0], chan.3);
4794 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
4796 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4797 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone()] }, 0);
4798 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.block_hash());
4800 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4801 assert_eq!(spend_txn.len(), 1);
4802 check_spends!(spend_txn[0], node_txn[0]);
4806 fn test_claim_on_remote_sizeable_push_msat() {
4807 // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4808 // to_remote output is encumbered by a P2WPKH
4809 let chanmon_cfgs = create_chanmon_cfgs(2);
4810 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4811 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4812 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4814 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4815 nodes[0].node.force_close_channel(&chan.2).unwrap();
4816 check_closed_broadcast!(nodes[0], false);
4817 check_added_monitors!(nodes[0], 1);
4819 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4820 assert_eq!(node_txn.len(), 1);
4821 check_spends!(node_txn[0], chan.3);
4822 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
4824 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4825 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone()] }, 0);
4826 check_closed_broadcast!(nodes[1], false);
4827 check_added_monitors!(nodes[1], 1);
4828 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.block_hash());
4830 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4831 assert_eq!(spend_txn.len(), 1);
4832 check_spends!(spend_txn[0], node_txn[0]);
4836 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4837 // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4838 // to_remote output is encumbered by a P2WPKH
4840 let chanmon_cfgs = create_chanmon_cfgs(2);
4841 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4842 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4843 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4845 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::known(), InitFeatures::known());
4846 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4847 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4848 assert_eq!(revoked_local_txn[0].input.len(), 1);
4849 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4851 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4852 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4853 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 0);
4854 check_closed_broadcast!(nodes[1], false);
4855 check_added_monitors!(nodes[1], 1);
4857 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4858 let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4859 connect_block(&nodes[1], &Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4860 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.block_hash());
4862 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4863 assert_eq!(spend_txn.len(), 2);
4864 check_spends!(spend_txn[0], revoked_local_txn[0]); // to_remote output on revoked remote commitment_tx
4865 check_spends!(spend_txn[1], node_txn[0]);
4869 fn test_static_spendable_outputs_preimage_tx() {
4870 let chanmon_cfgs = create_chanmon_cfgs(2);
4871 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4872 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4873 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4875 // Create some initial channels
4876 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4878 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4880 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4881 assert_eq!(commitment_tx[0].input.len(), 1);
4882 assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4884 // Settle A's commitment tx on B's chain
4885 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4886 assert!(nodes[1].node.claim_funds(payment_preimage, &None, 3_000_000));
4887 check_added_monitors!(nodes[1], 1);
4888 connect_block(&nodes[1], &Block { header, txdata: vec![commitment_tx[0].clone()] }, 1);
4889 check_added_monitors!(nodes[1], 1);
4890 let events = nodes[1].node.get_and_clear_pending_msg_events();
4892 MessageSendEvent::UpdateHTLCs { .. } => {},
4893 _ => panic!("Unexpected event"),
4896 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4897 _ => panic!("Unexepected event"),
4900 // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4901 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4902 assert_eq!(node_txn.len(), 3);
4903 check_spends!(node_txn[0], commitment_tx[0]);
4904 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4905 check_spends!(node_txn[1], chan_1.3);
4906 check_spends!(node_txn[2], node_txn[1]);
4908 let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4909 connect_block(&nodes[1], &Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4910 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.block_hash());
4912 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4913 assert_eq!(spend_txn.len(), 1);
4914 check_spends!(spend_txn[0], node_txn[0]);
4918 fn test_static_spendable_outputs_timeout_tx() {
4919 let chanmon_cfgs = create_chanmon_cfgs(2);
4920 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4921 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4922 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4924 // Create some initial channels
4925 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4927 // Rebalance the network a bit by relaying one payment through all the channels ...
4928 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
4930 let (_, our_payment_hash) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
4932 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4933 assert_eq!(commitment_tx[0].input.len(), 1);
4934 assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4936 // Settle A's commitment tx on B' chain
4937 let header = BlockHeader { version: 0x2000_0000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
4938 connect_block(&nodes[1], &Block { header, txdata: vec![commitment_tx[0].clone()] }, 0);
4939 check_added_monitors!(nodes[1], 1);
4940 let events = nodes[1].node.get_and_clear_pending_msg_events();
4942 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4943 _ => panic!("Unexpected event"),
4946 // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
4947 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4948 assert_eq!(node_txn.len(), 3); // ChannelManager : 2 (local commitent tx + HTLC-timeout), ChannelMonitor: timeout tx
4949 check_spends!(node_txn[0], commitment_tx[0].clone());
4950 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4951 check_spends!(node_txn[1], chan_1.3.clone());
4952 check_spends!(node_txn[2], node_txn[1]);
4954 let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4955 connect_block(&nodes[1], &Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4956 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.block_hash());
4957 expect_payment_failed!(nodes[1], our_payment_hash, true);
4959 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4960 assert_eq!(spend_txn.len(), 2); // SpendableOutput: remote_commitment_tx.to_remote, timeout_tx.output
4961 check_spends!(spend_txn[1], node_txn[0]);
4965 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
4966 let chanmon_cfgs = create_chanmon_cfgs(2);
4967 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4968 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4969 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4971 // Create some initial channels
4972 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4974 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4975 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4976 assert_eq!(revoked_local_txn[0].input.len(), 1);
4977 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4979 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4981 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4982 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 0);
4983 check_closed_broadcast!(nodes[1], false);
4984 check_added_monitors!(nodes[1], 1);
4986 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4987 assert_eq!(node_txn.len(), 2);
4988 assert_eq!(node_txn[0].input.len(), 2);
4989 check_spends!(node_txn[0], revoked_local_txn[0]);
4991 let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4992 connect_block(&nodes[1], &Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4993 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.block_hash());
4995 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4996 assert_eq!(spend_txn.len(), 1);
4997 check_spends!(spend_txn[0], node_txn[0]);
5001 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
5002 let mut chanmon_cfgs = create_chanmon_cfgs(2);
5003 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
5004 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5005 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5006 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5008 // Create some initial channels
5009 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5011 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5012 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5013 assert_eq!(revoked_local_txn[0].input.len(), 1);
5014 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5016 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
5018 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5019 // A will generate HTLC-Timeout from revoked commitment tx
5020 connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5021 check_closed_broadcast!(nodes[0], false);
5022 check_added_monitors!(nodes[0], 1);
5024 let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5025 assert_eq!(revoked_htlc_txn.len(), 2);
5026 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
5027 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5028 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
5029 check_spends!(revoked_htlc_txn[1], chan_1.3);
5031 // B will generate justice tx from A's revoked commitment/HTLC tx
5032 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 0);
5033 check_closed_broadcast!(nodes[1], false);
5034 check_added_monitors!(nodes[1], 1);
5036 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5037 assert_eq!(node_txn.len(), 3); // ChannelMonitor: bogus justice tx, justice tx on revoked outputs, ChannelManager: local commitment tx
5038 // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5039 // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
5040 // transactions next...
5041 assert_eq!(node_txn[0].input.len(), 3);
5042 check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
5044 assert_eq!(node_txn[1].input.len(), 2);
5045 check_spends!(node_txn[1], revoked_local_txn[0], revoked_htlc_txn[0]);
5046 if node_txn[1].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
5047 assert_ne!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5049 assert_eq!(node_txn[1].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
5050 assert_ne!(node_txn[1].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5053 assert_eq!(node_txn[2].input.len(), 1);
5054 check_spends!(node_txn[2], chan_1.3);
5056 let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5057 connect_block(&nodes[1], &Block { header: header_1, txdata: vec![node_txn[1].clone()] }, 1);
5058 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.block_hash());
5060 // Check B's ChannelMonitor was able to generate the right spendable output descriptor
5061 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5062 assert_eq!(spend_txn.len(), 1);
5063 assert_eq!(spend_txn[0].input.len(), 1);
5064 check_spends!(spend_txn[0], node_txn[1]);
5068 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
5069 let mut chanmon_cfgs = create_chanmon_cfgs(2);
5070 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
5071 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5072 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5073 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5075 // Create some initial channels
5076 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5078 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5079 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5080 assert_eq!(revoked_local_txn[0].input.len(), 1);
5081 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5083 // The to-be-revoked commitment tx should have one HTLC and one to_remote output
5084 assert_eq!(revoked_local_txn[0].output.len(), 2);
5086 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
5088 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5089 // B will generate HTLC-Success from revoked commitment tx
5090 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5091 check_closed_broadcast!(nodes[1], false);
5092 check_added_monitors!(nodes[1], 1);
5093 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5095 assert_eq!(revoked_htlc_txn.len(), 2);
5096 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
5097 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5098 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
5100 // Check that the unspent (of two) outputs on revoked_local_txn[0] is a P2WPKH:
5101 let unspent_local_txn_output = revoked_htlc_txn[0].input[0].previous_output.vout as usize ^ 1;
5102 assert_eq!(revoked_local_txn[0].output[unspent_local_txn_output].script_pubkey.len(), 2 + 20); // P2WPKH
5104 // A will generate justice tx from B's revoked commitment/HTLC tx
5105 connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
5106 check_closed_broadcast!(nodes[0], false);
5107 check_added_monitors!(nodes[0], 1);
5109 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5110 assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
5112 // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5113 // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
5114 // transactions next...
5115 assert_eq!(node_txn[0].input.len(), 2);
5116 check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
5117 if node_txn[0].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
5118 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5120 assert_eq!(node_txn[0].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
5121 assert_eq!(node_txn[0].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5124 assert_eq!(node_txn[1].input.len(), 1);
5125 check_spends!(node_txn[1], revoked_htlc_txn[0]);
5127 check_spends!(node_txn[2], chan_1.3);
5129 let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5130 connect_block(&nodes[0], &Block { header: header_1, txdata: vec![node_txn[1].clone()] }, 1);
5131 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 1, true, header.block_hash());
5133 // Note that nodes[0]'s tx_broadcaster is still locked, so if we get here the channelmonitor
5134 // didn't try to generate any new transactions.
5136 // Check A's ChannelMonitor was able to generate the right spendable output descriptor
5137 let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
5138 assert_eq!(spend_txn.len(), 2);
5139 assert_eq!(spend_txn[0].input.len(), 1);
5140 check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
5141 assert_ne!(spend_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5142 check_spends!(spend_txn[1], node_txn[1]); // spending justice tx output on the htlc success tx
5146 fn test_onchain_to_onchain_claim() {
5147 // Test that in case of channel closure, we detect the state of output and claim HTLC
5148 // on downstream peer's remote commitment tx.
5149 // First, have C claim an HTLC against its own latest commitment transaction.
5150 // Then, broadcast these to B, which should update the monitor downstream on the A<->B
5152 // Finally, check that B will claim the HTLC output if A's latest commitment transaction
5155 let chanmon_cfgs = create_chanmon_cfgs(3);
5156 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5157 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5158 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5160 // Create some initial channels
5161 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5162 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5164 // Rebalance the network a bit by relaying one payment through all the channels ...
5165 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
5166 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
5168 let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
5169 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
5170 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
5171 check_spends!(commitment_tx[0], chan_2.3);
5172 nodes[2].node.claim_funds(payment_preimage, &None, 3_000_000);
5173 check_added_monitors!(nodes[2], 1);
5174 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5175 assert!(updates.update_add_htlcs.is_empty());
5176 assert!(updates.update_fail_htlcs.is_empty());
5177 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5178 assert!(updates.update_fail_malformed_htlcs.is_empty());
5180 connect_block(&nodes[2], &Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
5181 check_closed_broadcast!(nodes[2], false);
5182 check_added_monitors!(nodes[2], 1);
5184 let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
5185 assert_eq!(c_txn.len(), 3);
5186 assert_eq!(c_txn[0], c_txn[2]);
5187 assert_eq!(commitment_tx[0], c_txn[1]);
5188 check_spends!(c_txn[1], chan_2.3);
5189 check_spends!(c_txn[2], c_txn[1]);
5190 assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
5191 assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5192 assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5193 assert_eq!(c_txn[0].lock_time, 0); // Success tx
5195 // 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
5196 connect_block(&nodes[1], &Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]}, 1);
5198 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5199 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-timeout tx
5200 assert_eq!(b_txn.len(), 3);
5201 check_spends!(b_txn[1], chan_2.3); // B local commitment tx, issued by ChannelManager
5202 check_spends!(b_txn[2], b_txn[1]); // HTLC-Timeout on B local commitment tx, issued by ChannelManager
5203 assert_eq!(b_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5204 assert!(b_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5205 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
5206 check_spends!(b_txn[0], c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor
5207 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5208 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5209 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
5212 check_added_monitors!(nodes[1], 1);
5213 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5214 check_added_monitors!(nodes[1], 1);
5215 match msg_events[0] {
5216 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5217 _ => panic!("Unexpected event"),
5219 match msg_events[1] {
5220 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, .. } } => {
5221 assert!(update_add_htlcs.is_empty());
5222 assert!(update_fail_htlcs.is_empty());
5223 assert_eq!(update_fulfill_htlcs.len(), 1);
5224 assert!(update_fail_malformed_htlcs.is_empty());
5225 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
5227 _ => panic!("Unexpected event"),
5229 // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
5230 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5231 connect_block(&nodes[1], &Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
5232 let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5233 // ChannelMonitor: HTLC-Success tx, ChannelManager: local commitment tx + HTLC-Success tx
5234 assert_eq!(b_txn.len(), 3);
5235 check_spends!(b_txn[1], chan_1.3);
5236 check_spends!(b_txn[2], b_txn[1]);
5237 check_spends!(b_txn[0], commitment_tx[0]);
5238 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5239 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5240 assert_eq!(b_txn[0].lock_time, 0); // Success tx
5242 check_closed_broadcast!(nodes[1], false);
5243 check_added_monitors!(nodes[1], 1);
5247 fn test_duplicate_payment_hash_one_failure_one_success() {
5248 // Topology : A --> B --> C
5249 // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
5250 let chanmon_cfgs = create_chanmon_cfgs(3);
5251 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5252 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5253 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5255 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5256 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5258 let (our_payment_preimage, duplicate_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
5259 *nodes[0].network_payment_count.borrow_mut() -= 1;
5260 assert_eq!(route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000).1, duplicate_payment_hash);
5262 let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
5263 assert_eq!(commitment_txn[0].input.len(), 1);
5264 check_spends!(commitment_txn[0], chan_2.3);
5266 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5267 connect_block(&nodes[1], &Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
5268 check_closed_broadcast!(nodes[1], false);
5269 check_added_monitors!(nodes[1], 1);
5271 let htlc_timeout_tx;
5272 { // Extract one of the two HTLC-Timeout transaction
5273 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5274 // ChannelMonitor: timeout tx * 2, ChannelManager: local commitment tx + HTLC-timeout * 2
5275 assert_eq!(node_txn.len(), 5);
5276 check_spends!(node_txn[0], commitment_txn[0]);
5277 assert_eq!(node_txn[0].input.len(), 1);
5278 check_spends!(node_txn[1], commitment_txn[0]);
5279 assert_eq!(node_txn[1].input.len(), 1);
5280 assert_ne!(node_txn[0].input[0], node_txn[1].input[0]);
5281 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5282 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5283 check_spends!(node_txn[2], chan_2.3);
5284 check_spends!(node_txn[3], node_txn[2]);
5285 check_spends!(node_txn[4], node_txn[2]);
5286 htlc_timeout_tx = node_txn[1].clone();
5289 nodes[2].node.claim_funds(our_payment_preimage, &None, 900_000);
5290 connect_block(&nodes[2], &Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
5291 check_added_monitors!(nodes[2], 3);
5292 let events = nodes[2].node.get_and_clear_pending_msg_events();
5294 MessageSendEvent::UpdateHTLCs { .. } => {},
5295 _ => panic!("Unexpected event"),
5298 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5299 _ => panic!("Unexepected event"),
5301 let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5302 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)
5303 check_spends!(htlc_success_txn[2], chan_2.3);
5304 check_spends!(htlc_success_txn[3], htlc_success_txn[2]);
5305 check_spends!(htlc_success_txn[4], htlc_success_txn[2]);
5306 assert_eq!(htlc_success_txn[0], htlc_success_txn[3]);
5307 assert_eq!(htlc_success_txn[0].input.len(), 1);
5308 assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5309 assert_eq!(htlc_success_txn[1], htlc_success_txn[4]);
5310 assert_eq!(htlc_success_txn[1].input.len(), 1);
5311 assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5312 assert_ne!(htlc_success_txn[0].input[0], htlc_success_txn[1].input[0]);
5313 check_spends!(htlc_success_txn[0], commitment_txn[0]);
5314 check_spends!(htlc_success_txn[1], commitment_txn[0]);
5316 connect_block(&nodes[1], &Block { header, txdata: vec![htlc_timeout_tx] }, 200);
5317 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 200, true, header.block_hash());
5318 expect_pending_htlcs_forwardable!(nodes[1]);
5319 let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5320 assert!(htlc_updates.update_add_htlcs.is_empty());
5321 assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5322 assert_eq!(htlc_updates.update_fail_htlcs[0].htlc_id, 1);
5323 assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5324 assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5325 check_added_monitors!(nodes[1], 1);
5327 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
5328 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5330 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5331 let events = nodes[0].node.get_and_clear_pending_msg_events();
5332 assert_eq!(events.len(), 1);
5334 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. } } => {
5336 _ => { panic!("Unexpected event"); }
5339 expect_payment_failed!(nodes[0], duplicate_payment_hash, false);
5341 // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5342 connect_block(&nodes[1], &Block { header, txdata: vec![htlc_success_txn[0].clone()] }, 200);
5343 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5344 assert!(updates.update_add_htlcs.is_empty());
5345 assert!(updates.update_fail_htlcs.is_empty());
5346 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5347 assert_eq!(updates.update_fulfill_htlcs[0].htlc_id, 0);
5348 assert!(updates.update_fail_malformed_htlcs.is_empty());
5349 check_added_monitors!(nodes[1], 1);
5351 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
5352 commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5354 let events = nodes[0].node.get_and_clear_pending_events();
5356 Event::PaymentSent { ref payment_preimage } => {
5357 assert_eq!(*payment_preimage, our_payment_preimage);
5359 _ => panic!("Unexpected event"),
5364 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
5365 let chanmon_cfgs = create_chanmon_cfgs(2);
5366 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5367 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5368 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5370 // Create some initial channels
5371 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5373 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5374 let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5375 assert_eq!(local_txn.len(), 1);
5376 assert_eq!(local_txn[0].input.len(), 1);
5377 check_spends!(local_txn[0], chan_1.3);
5379 // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5380 nodes[1].node.claim_funds(payment_preimage, &None, 9_000_000);
5381 check_added_monitors!(nodes[1], 1);
5382 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5383 connect_block(&nodes[1], &Block { header, txdata: vec![local_txn[0].clone()] }, 1);
5384 check_added_monitors!(nodes[1], 1);
5385 let events = nodes[1].node.get_and_clear_pending_msg_events();
5387 MessageSendEvent::UpdateHTLCs { .. } => {},
5388 _ => panic!("Unexpected event"),
5391 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5392 _ => panic!("Unexepected event"),
5395 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5396 assert_eq!(node_txn.len(), 3);
5397 assert_eq!(node_txn[0], node_txn[2]);
5398 assert_eq!(node_txn[1], local_txn[0]);
5399 assert_eq!(node_txn[0].input.len(), 1);
5400 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5401 check_spends!(node_txn[0], local_txn[0]);
5402 vec![node_txn[0].clone()]
5405 let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5406 connect_block(&nodes[1], &Block { header: header_201, txdata: node_txn.clone() }, 201);
5407 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 201, true, header_201.block_hash());
5409 // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5410 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5411 assert_eq!(spend_txn.len(), 1);
5412 check_spends!(spend_txn[0], node_txn[0]);
5415 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
5416 // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
5417 // unrevoked commitment transaction.
5418 // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
5419 // a remote RAA before they could be failed backwards (and combinations thereof).
5420 // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
5421 // use the same payment hashes.
5422 // Thus, we use a six-node network:
5427 // And test where C fails back to A/B when D announces its latest commitment transaction
5428 let chanmon_cfgs = create_chanmon_cfgs(6);
5429 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
5430 let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
5431 let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
5432 let logger = test_utils::TestLogger::new();
5434 create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5435 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5436 let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5437 create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
5438 create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
5440 // Rebalance and check output sanity...
5441 send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000, 500_000);
5442 send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000, 500_000);
5443 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
5445 let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
5447 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
5449 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
5450 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
5451 let our_node_id = &nodes[1].node.get_our_node_id();
5452 let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), None, &Vec::new(), ds_dust_limit*1000, TEST_FINAL_CLTV, &logger).unwrap();
5454 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
5456 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
5458 let (_, payment_hash_3) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5460 let (_, payment_hash_4) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5461 let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
5463 send_along_route_with_hash(&nodes[1], route.clone(), &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_3);
5465 send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_4);
5468 let (_, payment_hash_5) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5470 let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), None, &Vec::new(), ds_dust_limit*1000, TEST_FINAL_CLTV, &logger).unwrap();
5471 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
5474 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
5476 let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
5477 send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_6);
5479 // Double-check that six of the new HTLC were added
5480 // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
5481 // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
5482 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
5483 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
5485 // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
5486 // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
5487 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1, &None));
5488 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3, &None));
5489 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5, &None));
5490 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6, &None));
5491 check_added_monitors!(nodes[4], 0);
5492 expect_pending_htlcs_forwardable!(nodes[4]);
5493 check_added_monitors!(nodes[4], 1);
5495 let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
5496 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
5497 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
5498 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
5499 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
5500 commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
5502 // Fail 3rd below-dust and 7th above-dust HTLCs
5503 assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2, &None));
5504 assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4, &None));
5505 check_added_monitors!(nodes[5], 0);
5506 expect_pending_htlcs_forwardable!(nodes[5]);
5507 check_added_monitors!(nodes[5], 1);
5509 let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5510 nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5511 nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5512 commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5514 let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5516 expect_pending_htlcs_forwardable!(nodes[3]);
5517 check_added_monitors!(nodes[3], 1);
5518 let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5519 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5520 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5521 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5522 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5523 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5524 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5525 if deliver_last_raa {
5526 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5528 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5531 // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5532 // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5533 // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5534 // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5536 // We now broadcast the latest commitment transaction, which *should* result in failures for
5537 // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5538 // the non-broadcast above-dust HTLCs.
5540 // Alternatively, we may broadcast the previous commitment transaction, which should only
5541 // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5542 let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5544 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5545 if announce_latest {
5546 connect_block(&nodes[2], &Block { header, txdata: vec![ds_last_commitment_tx[0].clone()]}, 1);
5548 connect_block(&nodes[2], &Block { header, txdata: vec![ds_prev_commitment_tx[0].clone()]}, 1);
5550 connect_blocks(&nodes[2], ANTI_REORG_DELAY - 1, 1, true, header.block_hash());
5551 check_closed_broadcast!(nodes[2], false);
5552 expect_pending_htlcs_forwardable!(nodes[2]);
5553 check_added_monitors!(nodes[2], 3);
5555 let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5556 assert_eq!(cs_msgs.len(), 2);
5557 let mut a_done = false;
5558 for msg in cs_msgs {
5560 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5561 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5562 // should be failed-backwards here.
5563 let target = if *node_id == nodes[0].node.get_our_node_id() {
5564 // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5565 for htlc in &updates.update_fail_htlcs {
5566 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 });
5568 assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5573 // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5574 for htlc in &updates.update_fail_htlcs {
5575 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5577 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5578 assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5581 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5582 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5583 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5584 if announce_latest {
5585 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5586 if *node_id == nodes[0].node.get_our_node_id() {
5587 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5590 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5592 _ => panic!("Unexpected event"),
5596 let as_events = nodes[0].node.get_and_clear_pending_events();
5597 assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
5598 let mut as_failds = HashSet::new();
5599 for event in as_events.iter() {
5600 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5601 assert!(as_failds.insert(*payment_hash));
5602 if *payment_hash != payment_hash_2 {
5603 assert_eq!(*rejected_by_dest, deliver_last_raa);
5605 assert!(!rejected_by_dest);
5607 } else { panic!("Unexpected event"); }
5609 assert!(as_failds.contains(&payment_hash_1));
5610 assert!(as_failds.contains(&payment_hash_2));
5611 if announce_latest {
5612 assert!(as_failds.contains(&payment_hash_3));
5613 assert!(as_failds.contains(&payment_hash_5));
5615 assert!(as_failds.contains(&payment_hash_6));
5617 let bs_events = nodes[1].node.get_and_clear_pending_events();
5618 assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
5619 let mut bs_failds = HashSet::new();
5620 for event in bs_events.iter() {
5621 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5622 assert!(bs_failds.insert(*payment_hash));
5623 if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5624 assert_eq!(*rejected_by_dest, deliver_last_raa);
5626 assert!(!rejected_by_dest);
5628 } else { panic!("Unexpected event"); }
5630 assert!(bs_failds.contains(&payment_hash_1));
5631 assert!(bs_failds.contains(&payment_hash_2));
5632 if announce_latest {
5633 assert!(bs_failds.contains(&payment_hash_4));
5635 assert!(bs_failds.contains(&payment_hash_5));
5637 // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5638 // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
5639 // to unknown-preimage-etc, B should have gotten 2. Thus, in the
5640 // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
5641 // PaymentFailureNetworkUpdates.
5642 let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
5643 assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5644 let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5645 assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5646 for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
5648 &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
5649 _ => panic!("Unexpected event"),
5655 fn test_fail_backwards_latest_remote_announce_a() {
5656 do_test_fail_backwards_unrevoked_remote_announce(false, true);
5660 fn test_fail_backwards_latest_remote_announce_b() {
5661 do_test_fail_backwards_unrevoked_remote_announce(true, true);
5665 fn test_fail_backwards_previous_remote_announce() {
5666 do_test_fail_backwards_unrevoked_remote_announce(false, false);
5667 // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5668 // tested for in test_commitment_revoked_fail_backward_exhaustive()
5672 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5673 let chanmon_cfgs = create_chanmon_cfgs(2);
5674 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5675 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5676 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5678 // Create some initial channels
5679 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5681 let (_, our_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5682 let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5683 assert_eq!(local_txn[0].input.len(), 1);
5684 check_spends!(local_txn[0], chan_1.3);
5686 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5687 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5688 connect_block(&nodes[0], &Block { header, txdata: vec![local_txn[0].clone()] }, 200);
5689 check_closed_broadcast!(nodes[0], false);
5690 check_added_monitors!(nodes[0], 1);
5692 let htlc_timeout = {
5693 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5694 assert_eq!(node_txn[0].input.len(), 1);
5695 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5696 check_spends!(node_txn[0], local_txn[0]);
5700 let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5701 connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] }, 201);
5702 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 201, true, header_201.block_hash());
5703 expect_payment_failed!(nodes[0], our_payment_hash, true);
5705 // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5706 let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
5707 assert_eq!(spend_txn.len(), 2);
5708 check_spends!(spend_txn[0], local_txn[0]);
5709 check_spends!(spend_txn[1], htlc_timeout);
5713 fn test_key_derivation_params() {
5714 // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with
5715 // a key manager rotation to test that key_derivation_params returned in DynamicOutputP2WSH
5716 // let us re-derive the channel key set to then derive a delayed_payment_key.
5718 let chanmon_cfgs = create_chanmon_cfgs(3);
5720 // We manually create the node configuration to backup the seed.
5721 let seed = [42; 32];
5722 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5723 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);
5724 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 };
5725 let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5726 node_cfgs.remove(0);
5727 node_cfgs.insert(0, node);
5729 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5730 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5732 // Create some initial channels
5733 // Create a dummy channel to advance index by one and thus test re-derivation correctness
5735 let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5736 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5737 assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5739 let (_, our_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5740 let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5741 let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5742 assert_eq!(local_txn_1[0].input.len(), 1);
5743 check_spends!(local_txn_1[0], chan_1.3);
5745 // We check funding pubkey are unique
5746 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]));
5747 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]));
5748 if from_0_funding_key_0 == from_1_funding_key_0
5749 || from_0_funding_key_0 == from_1_funding_key_1
5750 || from_0_funding_key_1 == from_1_funding_key_0
5751 || from_0_funding_key_1 == from_1_funding_key_1 {
5752 panic!("Funding pubkeys aren't unique");
5755 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5756 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5757 connect_block(&nodes[0], &Block { header, txdata: vec![local_txn_1[0].clone()] }, 200);
5758 check_closed_broadcast!(nodes[0], false);
5759 check_added_monitors!(nodes[0], 1);
5761 let htlc_timeout = {
5762 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5763 assert_eq!(node_txn[0].input.len(), 1);
5764 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5765 check_spends!(node_txn[0], local_txn_1[0]);
5769 let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5770 connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] }, 201);
5771 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 201, true, header_201.block_hash());
5772 expect_payment_failed!(nodes[0], our_payment_hash, true);
5774 // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5775 let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5776 let spend_txn = check_spendable_outputs!(nodes[0], 1, new_keys_manager, 100000);
5777 assert_eq!(spend_txn.len(), 2);
5778 check_spends!(spend_txn[0], local_txn_1[0]);
5779 check_spends!(spend_txn[1], htlc_timeout);
5783 fn test_static_output_closing_tx() {
5784 let chanmon_cfgs = create_chanmon_cfgs(2);
5785 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5786 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5787 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5789 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5791 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
5792 let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5794 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5795 connect_block(&nodes[0], &Block { header, txdata: vec![closing_tx.clone()] }, 0);
5796 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 0, true, header.block_hash());
5798 let spend_txn = check_spendable_outputs!(nodes[0], 2, node_cfgs[0].keys_manager, 100000);
5799 assert_eq!(spend_txn.len(), 1);
5800 check_spends!(spend_txn[0], closing_tx);
5802 connect_block(&nodes[1], &Block { header, txdata: vec![closing_tx.clone()] }, 0);
5803 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 0, true, header.block_hash());
5805 let spend_txn = check_spendable_outputs!(nodes[1], 2, node_cfgs[1].keys_manager, 100000);
5806 assert_eq!(spend_txn.len(), 1);
5807 check_spends!(spend_txn[0], closing_tx);
5810 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5811 let chanmon_cfgs = create_chanmon_cfgs(2);
5812 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5813 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5814 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5815 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5817 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5819 // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5820 // present in B's local commitment transaction, but none of A's commitment transactions.
5821 assert!(nodes[1].node.claim_funds(our_payment_preimage, &None, if use_dust { 50_000 } else { 3_000_000 }));
5822 check_added_monitors!(nodes[1], 1);
5824 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5825 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5826 let events = nodes[0].node.get_and_clear_pending_events();
5827 assert_eq!(events.len(), 1);
5829 Event::PaymentSent { payment_preimage } => {
5830 assert_eq!(payment_preimage, our_payment_preimage);
5832 _ => panic!("Unexpected event"),
5835 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5836 check_added_monitors!(nodes[0], 1);
5837 let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5838 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5839 check_added_monitors!(nodes[1], 1);
5841 let mut block = Block {
5842 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5845 for i in 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + CHAN_CONFIRM_DEPTH + 1 {
5846 connect_block(&nodes[1], &block, i);
5847 block.header.prev_blockhash = block.block_hash();
5849 test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5850 check_closed_broadcast!(nodes[1], false);
5851 check_added_monitors!(nodes[1], 1);
5854 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5855 let chanmon_cfgs = create_chanmon_cfgs(2);
5856 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5857 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5858 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5859 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5860 let logger = test_utils::TestLogger::new();
5862 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
5863 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5864 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, &Vec::new(), if use_dust { 50000 } else { 3000000 }, TEST_FINAL_CLTV, &logger).unwrap();
5865 nodes[0].node.send_payment(&route, payment_hash, &None).unwrap();
5866 check_added_monitors!(nodes[0], 1);
5868 let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5870 // As far as A is concerned, the HTLC is now present only in the latest remote commitment
5871 // transaction, however it is not in A's latest local commitment, so we can just broadcast that
5872 // to "time out" the HTLC.
5874 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5876 for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
5877 connect_block(&nodes[0], &Block { header, txdata: Vec::new()}, i);
5878 header.prev_blockhash = header.block_hash();
5880 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5881 check_closed_broadcast!(nodes[0], false);
5882 check_added_monitors!(nodes[0], 1);
5885 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
5886 let chanmon_cfgs = create_chanmon_cfgs(3);
5887 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5888 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5889 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5890 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5892 // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
5893 // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
5894 // Also optionally test that we *don't* fail the channel in case the commitment transaction was
5895 // actually revoked.
5896 let htlc_value = if use_dust { 50000 } else { 3000000 };
5897 let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
5898 assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash, &None));
5899 expect_pending_htlcs_forwardable!(nodes[1]);
5900 check_added_monitors!(nodes[1], 1);
5902 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5903 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
5904 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5905 check_added_monitors!(nodes[0], 1);
5906 let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5907 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5908 check_added_monitors!(nodes[1], 1);
5909 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
5910 check_added_monitors!(nodes[1], 1);
5911 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
5913 if check_revoke_no_close {
5914 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
5915 check_added_monitors!(nodes[0], 1);
5918 let mut block = Block {
5919 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5922 for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
5923 connect_block(&nodes[0], &block, i);
5924 block.header.prev_blockhash = block.block_hash();
5926 if !check_revoke_no_close {
5927 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5928 check_closed_broadcast!(nodes[0], false);
5929 check_added_monitors!(nodes[0], 1);
5931 expect_payment_failed!(nodes[0], our_payment_hash, true);
5935 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
5936 // There are only a few cases to test here:
5937 // * its not really normative behavior, but we test that below-dust HTLCs "included" in
5938 // broadcastable commitment transactions result in channel closure,
5939 // * its included in an unrevoked-but-previous remote commitment transaction,
5940 // * its included in the latest remote or local commitment transactions.
5941 // We test each of the three possible commitment transactions individually and use both dust and
5943 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
5944 // assume they are handled the same across all six cases, as both outbound and inbound failures are
5945 // tested for at least one of the cases in other tests.
5947 fn htlc_claim_single_commitment_only_a() {
5948 do_htlc_claim_local_commitment_only(true);
5949 do_htlc_claim_local_commitment_only(false);
5951 do_htlc_claim_current_remote_commitment_only(true);
5952 do_htlc_claim_current_remote_commitment_only(false);
5956 fn htlc_claim_single_commitment_only_b() {
5957 do_htlc_claim_previous_remote_commitment_only(true, false);
5958 do_htlc_claim_previous_remote_commitment_only(false, false);
5959 do_htlc_claim_previous_remote_commitment_only(true, true);
5960 do_htlc_claim_previous_remote_commitment_only(false, true);
5965 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
5966 let chanmon_cfgs = create_chanmon_cfgs(2);
5967 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5968 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5969 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5970 //Force duplicate channel ids
5971 for node in nodes.iter() {
5972 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
5975 // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
5976 let channel_value_satoshis=10000;
5977 let push_msat=10001;
5978 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
5979 let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5980 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
5982 //Create a second channel with a channel_id collision
5983 assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5987 fn bolt2_open_channel_sending_node_checks_part2() {
5988 let chanmon_cfgs = create_chanmon_cfgs(2);
5989 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5990 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5991 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5993 // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
5994 let channel_value_satoshis=2^24;
5995 let push_msat=10001;
5996 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5998 // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
5999 let channel_value_satoshis=10000;
6000 // Test when push_msat is equal to 1000 * funding_satoshis.
6001 let push_msat=1000*channel_value_satoshis+1;
6002 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6004 // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
6005 let channel_value_satoshis=10000;
6006 let push_msat=10001;
6007 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
6008 let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6009 assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
6011 // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
6012 // 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
6013 assert!(node0_to_1_send_open_channel.channel_flags<=1);
6015 // 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.
6016 assert!(BREAKDOWN_TIMEOUT>0);
6017 assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
6019 // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
6020 let chain_hash=genesis_block(Network::Testnet).header.block_hash();
6021 assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
6023 // 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.
6024 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
6025 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
6026 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
6027 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
6028 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
6031 // Test that if we fail to send an HTLC that is being freed from the holding cell, and the HTLC
6032 // originated from our node, its failure is surfaced to the user. We trigger this failure to
6033 // free the HTLC by increasing our fee while the HTLC is in the holding cell such that the HTLC
6034 // is no longer affordable once it's freed.
6036 fn test_fail_holding_cell_htlc_upon_free() {
6037 let chanmon_cfgs = create_chanmon_cfgs(2);
6038 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6039 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6040 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6041 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6042 let logger = test_utils::TestLogger::new();
6044 // First nodes[0] generates an update_fee, setting the channel's
6045 // pending_update_fee.
6046 nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 20).unwrap();
6047 check_added_monitors!(nodes[0], 1);
6049 let events = nodes[0].node.get_and_clear_pending_msg_events();
6050 assert_eq!(events.len(), 1);
6051 let (update_msg, commitment_signed) = match events[0] {
6052 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6053 (update_fee.as_ref(), commitment_signed)
6055 _ => panic!("Unexpected event"),
6058 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6060 let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6061 let channel_reserve = chan_stat.channel_reserve_msat;
6062 let feerate = get_feerate!(nodes[0], chan.2);
6064 // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6065 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6066 let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1);
6067 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6068 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, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6070 // Send a payment which passes reserve checks but gets stuck in the holding cell.
6071 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6072 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6073 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6075 // Flush the pending fee update.
6076 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6077 let (as_revoke_and_ack, _) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6078 check_added_monitors!(nodes[1], 1);
6079 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
6080 check_added_monitors!(nodes[0], 1);
6082 // Upon receipt of the RAA, there will be an attempt to resend the holding cell
6083 // HTLC, but now that the fee has been raised the payment will now fail, causing
6084 // us to surface its failure to the user.
6085 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6086 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6087 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), "Freeing holding cell with 1 HTLC updates".to_string(), 1);
6088 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);
6089 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6091 // Check that the payment failed to be sent out.
6092 let events = nodes[0].node.get_and_clear_pending_events();
6093 assert_eq!(events.len(), 1);
6095 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6096 assert_eq!(our_payment_hash.clone(), *payment_hash);
6097 assert_eq!(*rejected_by_dest, false);
6098 assert_eq!(*error_code, None);
6099 assert_eq!(*error_data, None);
6101 _ => panic!("Unexpected event"),
6105 // Test that if multiple HTLCs are released from the holding cell and one is
6106 // valid but the other is no longer valid upon release, the valid HTLC can be
6107 // successfully completed while the other one fails as expected.
6109 fn test_free_and_fail_holding_cell_htlcs() {
6110 let chanmon_cfgs = create_chanmon_cfgs(2);
6111 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6112 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6113 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6114 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6115 let logger = test_utils::TestLogger::new();
6117 // First nodes[0] generates an update_fee, setting the channel's
6118 // pending_update_fee.
6119 nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 200).unwrap();
6120 check_added_monitors!(nodes[0], 1);
6122 let events = nodes[0].node.get_and_clear_pending_msg_events();
6123 assert_eq!(events.len(), 1);
6124 let (update_msg, commitment_signed) = match events[0] {
6125 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6126 (update_fee.as_ref(), commitment_signed)
6128 _ => panic!("Unexpected event"),
6131 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6133 let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6134 let channel_reserve = chan_stat.channel_reserve_msat;
6135 let feerate = get_feerate!(nodes[0], chan.2);
6137 // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6138 let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
6140 let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
6141 let amt_2 = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 2 + 1) - amt_1;
6142 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6143 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, &[], amt_1, TEST_FINAL_CLTV, &logger).unwrap();
6144 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, &[], amt_2, TEST_FINAL_CLTV, &logger).unwrap();
6146 // Send 2 payments which pass reserve checks but get stuck in the holding cell.
6147 nodes[0].node.send_payment(&route_1, payment_hash_1, &None).unwrap();
6148 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6149 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1);
6150 nodes[0].node.send_payment(&route_2, payment_hash_2, &None).unwrap();
6151 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6152 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1 + amt_2);
6154 // Flush the pending fee update.
6155 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6156 let (revoke_and_ack, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6157 check_added_monitors!(nodes[1], 1);
6158 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_and_ack);
6159 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6160 check_added_monitors!(nodes[0], 2);
6162 // Upon receipt of the RAA, there will be an attempt to resend the holding cell HTLCs,
6163 // but now that the fee has been raised the second payment will now fail, causing us
6164 // to surface its failure to the user. The first payment should succeed.
6165 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6166 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6167 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), "Freeing holding cell with 2 HTLC updates".to_string(), 1);
6168 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);
6169 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6171 // Check that the second payment failed to be sent out.
6172 let events = nodes[0].node.get_and_clear_pending_events();
6173 assert_eq!(events.len(), 1);
6175 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6176 assert_eq!(payment_hash_2.clone(), *payment_hash);
6177 assert_eq!(*rejected_by_dest, false);
6178 assert_eq!(*error_code, None);
6179 assert_eq!(*error_data, None);
6181 _ => panic!("Unexpected event"),
6184 // Complete the first payment and the RAA from the fee update.
6185 let (payment_event, send_raa_event) = {
6186 let mut msgs = nodes[0].node.get_and_clear_pending_msg_events();
6187 assert_eq!(msgs.len(), 2);
6188 (SendEvent::from_event(msgs.remove(0)), msgs.remove(0))
6190 let raa = match send_raa_event {
6191 MessageSendEvent::SendRevokeAndACK { msg, .. } => msg,
6192 _ => panic!("Unexpected event"),
6194 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6195 check_added_monitors!(nodes[1], 1);
6196 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6197 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6198 let events = nodes[1].node.get_and_clear_pending_events();
6199 assert_eq!(events.len(), 1);
6201 Event::PendingHTLCsForwardable { .. } => {},
6202 _ => panic!("Unexpected event"),
6204 nodes[1].node.process_pending_htlc_forwards();
6205 let events = nodes[1].node.get_and_clear_pending_events();
6206 assert_eq!(events.len(), 1);
6208 Event::PaymentReceived { .. } => {},
6209 _ => panic!("Unexpected event"),
6211 nodes[1].node.claim_funds(payment_preimage_1, &None, amt_1);
6212 check_added_monitors!(nodes[1], 1);
6213 let update_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6214 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msgs.update_fulfill_htlcs[0]);
6215 commitment_signed_dance!(nodes[0], nodes[1], update_msgs.commitment_signed, false, true);
6216 let events = nodes[0].node.get_and_clear_pending_events();
6217 assert_eq!(events.len(), 1);
6219 Event::PaymentSent { ref payment_preimage } => {
6220 assert_eq!(*payment_preimage, payment_preimage_1);
6222 _ => panic!("Unexpected event"),
6226 // Test that if we fail to forward an HTLC that is being freed from the holding cell that the
6227 // HTLC is failed backwards. We trigger this failure to forward the freed HTLC by increasing
6228 // our fee while the HTLC is in the holding cell such that the HTLC is no longer affordable
6231 fn test_fail_holding_cell_htlc_upon_free_multihop() {
6232 let chanmon_cfgs = create_chanmon_cfgs(3);
6233 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6234 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6235 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6236 let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6237 let chan_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6238 let logger = test_utils::TestLogger::new();
6240 // First nodes[1] generates an update_fee, setting the channel's
6241 // pending_update_fee.
6242 nodes[1].node.update_fee(chan_1_2.2, get_feerate!(nodes[1], chan_1_2.2) + 20).unwrap();
6243 check_added_monitors!(nodes[1], 1);
6245 let events = nodes[1].node.get_and_clear_pending_msg_events();
6246 assert_eq!(events.len(), 1);
6247 let (update_msg, commitment_signed) = match events[0] {
6248 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6249 (update_fee.as_ref(), commitment_signed)
6251 _ => panic!("Unexpected event"),
6254 nodes[2].node.handle_update_fee(&nodes[1].node.get_our_node_id(), update_msg.unwrap());
6256 let mut chan_stat = get_channel_value_stat!(nodes[0], chan_0_1.2);
6257 let channel_reserve = chan_stat.channel_reserve_msat;
6258 let feerate = get_feerate!(nodes[0], chan_0_1.2);
6260 // Send a payment which passes reserve checks but gets stuck in the holding cell.
6262 let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
6263 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6264 let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1) - total_routing_fee_msat;
6265 let payment_event = {
6266 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6267 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, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6268 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6269 check_added_monitors!(nodes[0], 1);
6271 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6272 assert_eq!(events.len(), 1);
6274 SendEvent::from_event(events.remove(0))
6276 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6277 check_added_monitors!(nodes[1], 0);
6278 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6279 expect_pending_htlcs_forwardable!(nodes[1]);
6281 chan_stat = get_channel_value_stat!(nodes[1], chan_1_2.2);
6282 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6284 // Flush the pending fee update.
6285 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
6286 let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6287 check_added_monitors!(nodes[2], 1);
6288 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &raa);
6289 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &commitment_signed);
6290 check_added_monitors!(nodes[1], 2);
6292 // A final RAA message is generated to finalize the fee update.
6293 let events = nodes[1].node.get_and_clear_pending_msg_events();
6294 assert_eq!(events.len(), 1);
6296 let raa_msg = match &events[0] {
6297 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => {
6300 _ => panic!("Unexpected event"),
6303 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_msg);
6304 check_added_monitors!(nodes[2], 1);
6305 assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
6307 // nodes[1]'s ChannelManager will now signal that we have HTLC forwards to process.
6308 let process_htlc_forwards_event = nodes[1].node.get_and_clear_pending_events();
6309 assert_eq!(process_htlc_forwards_event.len(), 1);
6310 match &process_htlc_forwards_event[0] {
6311 &Event::PendingHTLCsForwardable { .. } => {},
6312 _ => panic!("Unexpected event"),
6315 // In response, we call ChannelManager's process_pending_htlc_forwards
6316 nodes[1].node.process_pending_htlc_forwards();
6317 check_added_monitors!(nodes[1], 1);
6319 // This causes the HTLC to be failed backwards.
6320 let fail_event = nodes[1].node.get_and_clear_pending_msg_events();
6321 assert_eq!(fail_event.len(), 1);
6322 let (fail_msg, commitment_signed) = match &fail_event[0] {
6323 &MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6324 assert_eq!(updates.update_add_htlcs.len(), 0);
6325 assert_eq!(updates.update_fulfill_htlcs.len(), 0);
6326 assert_eq!(updates.update_fail_malformed_htlcs.len(), 0);
6327 assert_eq!(updates.update_fail_htlcs.len(), 1);
6328 (updates.update_fail_htlcs[0].clone(), updates.commitment_signed.clone())
6330 _ => panic!("Unexpected event"),
6333 // Pass the failure messages back to nodes[0].
6334 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
6335 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6337 // Complete the HTLC failure+removal process.
6338 let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6339 check_added_monitors!(nodes[0], 1);
6340 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6341 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
6342 check_added_monitors!(nodes[1], 2);
6343 let final_raa_event = nodes[1].node.get_and_clear_pending_msg_events();
6344 assert_eq!(final_raa_event.len(), 1);
6345 let raa = match &final_raa_event[0] {
6346 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => msg.clone(),
6347 _ => panic!("Unexpected event"),
6349 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
6350 let fail_msg_event = nodes[0].node.get_and_clear_pending_msg_events();
6351 assert_eq!(fail_msg_event.len(), 1);
6352 match &fail_msg_event[0] {
6353 &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
6354 _ => panic!("Unexpected event"),
6356 let failure_event = nodes[0].node.get_and_clear_pending_events();
6357 assert_eq!(failure_event.len(), 1);
6358 match &failure_event[0] {
6359 &Event::PaymentFailed { rejected_by_dest, .. } => {
6360 assert!(!rejected_by_dest);
6362 _ => panic!("Unexpected event"),
6364 check_added_monitors!(nodes[0], 1);
6367 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
6368 // 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.
6369 //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.
6372 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
6373 //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
6374 let chanmon_cfgs = create_chanmon_cfgs(2);
6375 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6376 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6377 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6378 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6380 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6381 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6382 let logger = test_utils::TestLogger::new();
6383 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, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6384 route.paths[0][0].fee_msat = 100;
6386 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6387 assert!(regex::Regex::new(r"Cannot send less than their minimum HTLC value \(\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 less than their minimum HTLC value".to_string(), 1);
6393 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
6394 //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6395 let chanmon_cfgs = create_chanmon_cfgs(2);
6396 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6397 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6398 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6399 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6400 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6402 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6403 let logger = test_utils::TestLogger::new();
6404 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, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6405 route.paths[0][0].fee_msat = 0;
6406 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6407 assert_eq!(err, "Cannot send 0-msat HTLC"));
6409 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6410 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
6414 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
6415 //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6416 let chanmon_cfgs = create_chanmon_cfgs(2);
6417 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6418 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6419 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6420 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6422 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6423 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6424 let logger = test_utils::TestLogger::new();
6425 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, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6426 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6427 check_added_monitors!(nodes[0], 1);
6428 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6429 updates.update_add_htlcs[0].amount_msat = 0;
6431 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6432 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
6433 check_closed_broadcast!(nodes[1], true).unwrap();
6434 check_added_monitors!(nodes[1], 1);
6438 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6439 //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6440 //It is enforced when constructing a route.
6441 let chanmon_cfgs = create_chanmon_cfgs(2);
6442 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6443 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6444 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6445 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 0, InitFeatures::known(), InitFeatures::known());
6446 let logger = test_utils::TestLogger::new();
6448 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6450 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6451 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, &[], 100000000, 500000001, &logger).unwrap();
6452 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::RouteError { ref err },
6453 assert_eq!(err, &"Channel CLTV overflowed?"));
6457 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6458 //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.
6459 //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6460 //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
6461 let chanmon_cfgs = create_chanmon_cfgs(2);
6462 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6463 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6464 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6465 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6466 let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().counterparty_max_accepted_htlcs as u64;
6468 let logger = test_utils::TestLogger::new();
6469 for i in 0..max_accepted_htlcs {
6470 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6471 let payment_event = {
6472 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6473 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, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6474 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6475 check_added_monitors!(nodes[0], 1);
6477 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6478 assert_eq!(events.len(), 1);
6479 if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6480 assert_eq!(htlcs[0].htlc_id, i);
6484 SendEvent::from_event(events.remove(0))
6486 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6487 check_added_monitors!(nodes[1], 0);
6488 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6490 expect_pending_htlcs_forwardable!(nodes[1]);
6491 expect_payment_received!(nodes[1], our_payment_hash, 100000);
6493 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6494 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6495 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, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6496 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6497 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
6499 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6500 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
6504 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6505 //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.
6506 let chanmon_cfgs = create_chanmon_cfgs(2);
6507 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6508 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6509 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6510 let channel_value = 100000;
6511 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::known(), InitFeatures::known());
6512 let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).counterparty_max_htlc_value_in_flight_msat;
6514 send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight, max_in_flight);
6516 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6517 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6518 let logger = test_utils::TestLogger::new();
6519 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, &[], max_in_flight+1, TEST_FINAL_CLTV, &logger).unwrap();
6520 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6521 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)));
6523 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6524 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);
6526 send_payment(&nodes[0], &[&nodes[1]], max_in_flight, max_in_flight);
6529 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6531 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6532 //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> 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 chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6538 let htlc_minimum_msat: u64;
6540 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
6541 let channel = chan_lock.by_id.get(&chan.2).unwrap();
6542 htlc_minimum_msat = channel.get_holder_htlc_minimum_msat();
6545 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6546 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6547 let logger = test_utils::TestLogger::new();
6548 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, &[], htlc_minimum_msat, TEST_FINAL_CLTV, &logger).unwrap();
6549 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6550 check_added_monitors!(nodes[0], 1);
6551 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6552 updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6553 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6554 assert!(nodes[1].node.list_channels().is_empty());
6555 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6556 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()));
6557 check_added_monitors!(nodes[1], 1);
6561 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6562 //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
6563 let chanmon_cfgs = create_chanmon_cfgs(2);
6564 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6565 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6566 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6567 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6568 let logger = test_utils::TestLogger::new();
6570 let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6571 let channel_reserve = chan_stat.channel_reserve_msat;
6572 let feerate = get_feerate!(nodes[0], chan.2);
6573 // The 2* and +1 are for the fee spike reserve.
6574 let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1);
6576 let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6577 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6578 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6579 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, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6580 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6581 check_added_monitors!(nodes[0], 1);
6582 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6584 // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6585 // at this time channel-initiatee receivers are not required to enforce that senders
6586 // respect the fee_spike_reserve.
6587 updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
6588 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6590 assert!(nodes[1].node.list_channels().is_empty());
6591 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6592 assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
6593 check_added_monitors!(nodes[1], 1);
6597 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
6598 //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
6599 //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
6600 let chanmon_cfgs = create_chanmon_cfgs(2);
6601 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6602 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6603 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6604 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6605 let logger = test_utils::TestLogger::new();
6607 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6608 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
6610 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6611 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, &[], 3999999, TEST_FINAL_CLTV, &logger).unwrap();
6613 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
6614 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
6615 let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &None, cur_height).unwrap();
6616 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
6618 let mut msg = msgs::UpdateAddHTLC {
6622 payment_hash: our_payment_hash,
6623 cltv_expiry: htlc_cltv,
6624 onion_routing_packet: onion_packet.clone(),
6627 for i in 0..super::channel::OUR_MAX_HTLCS {
6628 msg.htlc_id = i as u64;
6629 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6631 msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
6632 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6634 assert!(nodes[1].node.list_channels().is_empty());
6635 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6636 assert!(regex::Regex::new(r"Remote tried to push more than our max accepted HTLCs \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6637 check_added_monitors!(nodes[1], 1);
6641 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
6642 //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
6643 let chanmon_cfgs = create_chanmon_cfgs(2);
6644 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6645 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6646 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6647 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6648 let logger = test_utils::TestLogger::new();
6650 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6651 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6652 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, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6653 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6654 check_added_monitors!(nodes[0], 1);
6655 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6656 updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).counterparty_max_htlc_value_in_flight_msat + 1;
6657 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6659 assert!(nodes[1].node.list_channels().is_empty());
6660 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6661 assert!(regex::Regex::new("Remote HTLC add would put them over our max HTLC value").unwrap().is_match(err_msg.data.as_str()));
6662 check_added_monitors!(nodes[1], 1);
6666 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6667 //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6668 let chanmon_cfgs = create_chanmon_cfgs(2);
6669 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6670 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6671 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6672 let logger = test_utils::TestLogger::new();
6674 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6675 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6676 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6677 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, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6678 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6679 check_added_monitors!(nodes[0], 1);
6680 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6681 updates.update_add_htlcs[0].cltv_expiry = 500000000;
6682 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6684 assert!(nodes[1].node.list_channels().is_empty());
6685 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6686 assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6687 check_added_monitors!(nodes[1], 1);
6691 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6692 //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6693 // We test this by first testing that that repeated HTLCs pass commitment signature checks
6694 // after disconnect and that non-sequential htlc_ids result in a channel failure.
6695 let chanmon_cfgs = create_chanmon_cfgs(2);
6696 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6697 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6698 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6699 let logger = test_utils::TestLogger::new();
6701 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6702 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6703 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6704 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, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6705 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6706 check_added_monitors!(nodes[0], 1);
6707 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6708 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6710 //Disconnect and Reconnect
6711 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6712 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6713 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6714 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6715 assert_eq!(reestablish_1.len(), 1);
6716 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6717 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6718 assert_eq!(reestablish_2.len(), 1);
6719 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6720 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6721 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6722 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6725 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6726 assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6727 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6728 check_added_monitors!(nodes[1], 1);
6729 let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6731 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6733 assert!(nodes[1].node.list_channels().is_empty());
6734 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6735 assert!(regex::Regex::new(r"Remote skipped HTLC ID \(skipped ID: \d+\)").unwrap().is_match(err_msg.data.as_str()));
6736 check_added_monitors!(nodes[1], 1);
6740 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6741 //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.
6743 let chanmon_cfgs = create_chanmon_cfgs(2);
6744 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6745 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6746 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6747 let logger = test_utils::TestLogger::new();
6748 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6749 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6750 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6751 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, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6752 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6754 check_added_monitors!(nodes[0], 1);
6755 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6756 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6758 let update_msg = msgs::UpdateFulfillHTLC{
6761 payment_preimage: our_payment_preimage,
6764 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6766 assert!(nodes[0].node.list_channels().is_empty());
6767 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6768 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()));
6769 check_added_monitors!(nodes[0], 1);
6773 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6774 //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.
6776 let chanmon_cfgs = create_chanmon_cfgs(2);
6777 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6778 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6779 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6780 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6781 let logger = test_utils::TestLogger::new();
6783 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6784 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6785 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, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6786 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6787 check_added_monitors!(nodes[0], 1);
6788 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6789 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6791 let update_msg = msgs::UpdateFailHTLC{
6794 reason: msgs::OnionErrorPacket { data: Vec::new()},
6797 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6799 assert!(nodes[0].node.list_channels().is_empty());
6800 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6801 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()));
6802 check_added_monitors!(nodes[0], 1);
6806 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6807 //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.
6809 let chanmon_cfgs = create_chanmon_cfgs(2);
6810 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6811 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6812 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6813 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6814 let logger = test_utils::TestLogger::new();
6816 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6817 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6818 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, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6819 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6820 check_added_monitors!(nodes[0], 1);
6821 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6822 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6824 let update_msg = msgs::UpdateFailMalformedHTLC{
6827 sha256_of_onion: [1; 32],
6828 failure_code: 0x8000,
6831 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6833 assert!(nodes[0].node.list_channels().is_empty());
6834 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6835 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()));
6836 check_added_monitors!(nodes[0], 1);
6840 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
6841 //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
6843 let chanmon_cfgs = create_chanmon_cfgs(2);
6844 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6845 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6846 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6847 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6849 let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6851 nodes[1].node.claim_funds(our_payment_preimage, &None, 100_000);
6852 check_added_monitors!(nodes[1], 1);
6854 let events = nodes[1].node.get_and_clear_pending_msg_events();
6855 assert_eq!(events.len(), 1);
6856 let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6858 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, .. } } => {
6859 assert!(update_add_htlcs.is_empty());
6860 assert_eq!(update_fulfill_htlcs.len(), 1);
6861 assert!(update_fail_htlcs.is_empty());
6862 assert!(update_fail_malformed_htlcs.is_empty());
6863 assert!(update_fee.is_none());
6864 update_fulfill_htlcs[0].clone()
6866 _ => panic!("Unexpected event"),
6870 update_fulfill_msg.htlc_id = 1;
6872 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6874 assert!(nodes[0].node.list_channels().is_empty());
6875 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6876 assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
6877 check_added_monitors!(nodes[0], 1);
6881 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
6882 //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.
6884 let chanmon_cfgs = create_chanmon_cfgs(2);
6885 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6886 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6887 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6888 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6890 let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6892 nodes[1].node.claim_funds(our_payment_preimage, &None, 100_000);
6893 check_added_monitors!(nodes[1], 1);
6895 let events = nodes[1].node.get_and_clear_pending_msg_events();
6896 assert_eq!(events.len(), 1);
6897 let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6899 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, .. } } => {
6900 assert!(update_add_htlcs.is_empty());
6901 assert_eq!(update_fulfill_htlcs.len(), 1);
6902 assert!(update_fail_htlcs.is_empty());
6903 assert!(update_fail_malformed_htlcs.is_empty());
6904 assert!(update_fee.is_none());
6905 update_fulfill_htlcs[0].clone()
6907 _ => panic!("Unexpected event"),
6911 update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
6913 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6915 assert!(nodes[0].node.list_channels().is_empty());
6916 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6917 assert!(regex::Regex::new(r"Remote tried to fulfill HTLC \(\d+\) with an incorrect preimage").unwrap().is_match(err_msg.data.as_str()));
6918 check_added_monitors!(nodes[0], 1);
6922 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
6923 //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.
6925 let chanmon_cfgs = create_chanmon_cfgs(2);
6926 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6927 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6928 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6929 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6930 let logger = test_utils::TestLogger::new();
6932 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6933 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6934 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, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6935 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6936 check_added_monitors!(nodes[0], 1);
6938 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6939 updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6941 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6942 check_added_monitors!(nodes[1], 0);
6943 commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
6945 let events = nodes[1].node.get_and_clear_pending_msg_events();
6947 let mut update_msg: msgs::UpdateFailMalformedHTLC = {
6949 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, .. } } => {
6950 assert!(update_add_htlcs.is_empty());
6951 assert!(update_fulfill_htlcs.is_empty());
6952 assert!(update_fail_htlcs.is_empty());
6953 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6954 assert!(update_fee.is_none());
6955 update_fail_malformed_htlcs[0].clone()
6957 _ => panic!("Unexpected event"),
6960 update_msg.failure_code &= !0x8000;
6961 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6963 assert!(nodes[0].node.list_channels().is_empty());
6964 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6965 assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
6966 check_added_monitors!(nodes[0], 1);
6970 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
6971 //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
6972 // * 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.
6974 let chanmon_cfgs = create_chanmon_cfgs(3);
6975 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6976 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6977 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6978 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6979 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6980 let logger = test_utils::TestLogger::new();
6982 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6985 let mut payment_event = {
6986 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6987 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, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
6988 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6989 check_added_monitors!(nodes[0], 1);
6990 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6991 assert_eq!(events.len(), 1);
6992 SendEvent::from_event(events.remove(0))
6994 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6995 check_added_monitors!(nodes[1], 0);
6996 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6997 expect_pending_htlcs_forwardable!(nodes[1]);
6998 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
6999 assert_eq!(events_2.len(), 1);
7000 check_added_monitors!(nodes[1], 1);
7001 payment_event = SendEvent::from_event(events_2.remove(0));
7002 assert_eq!(payment_event.msgs.len(), 1);
7005 payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7006 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
7007 check_added_monitors!(nodes[2], 0);
7008 commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
7010 let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
7011 assert_eq!(events_3.len(), 1);
7012 let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
7014 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 } } => {
7015 assert!(update_add_htlcs.is_empty());
7016 assert!(update_fulfill_htlcs.is_empty());
7017 assert!(update_fail_htlcs.is_empty());
7018 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7019 assert!(update_fee.is_none());
7020 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
7022 _ => panic!("Unexpected event"),
7026 nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
7028 check_added_monitors!(nodes[1], 0);
7029 commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
7030 expect_pending_htlcs_forwardable!(nodes[1]);
7031 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
7032 assert_eq!(events_4.len(), 1);
7034 //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
7036 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, .. } } => {
7037 assert!(update_add_htlcs.is_empty());
7038 assert!(update_fulfill_htlcs.is_empty());
7039 assert_eq!(update_fail_htlcs.len(), 1);
7040 assert!(update_fail_malformed_htlcs.is_empty());
7041 assert!(update_fee.is_none());
7043 _ => panic!("Unexpected event"),
7046 check_added_monitors!(nodes[1], 1);
7049 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
7050 // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
7051 // 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
7052 // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
7054 let mut chanmon_cfgs = create_chanmon_cfgs(2);
7055 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7056 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7057 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7058 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7059 let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7061 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7063 // We route 2 dust-HTLCs between A and B
7064 let (_, payment_hash_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7065 let (_, payment_hash_2) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7066 route_payment(&nodes[0], &[&nodes[1]], 1000000);
7068 // Cache one local commitment tx as previous
7069 let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7071 // Fail one HTLC to prune it in the will-be-latest-local commitment tx
7072 assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2, &None));
7073 check_added_monitors!(nodes[1], 0);
7074 expect_pending_htlcs_forwardable!(nodes[1]);
7075 check_added_monitors!(nodes[1], 1);
7077 let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7078 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
7079 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
7080 check_added_monitors!(nodes[0], 1);
7082 // Cache one local commitment tx as lastest
7083 let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7085 let events = nodes[0].node.get_and_clear_pending_msg_events();
7087 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
7088 assert_eq!(node_id, nodes[1].node.get_our_node_id());
7090 _ => panic!("Unexpected event"),
7093 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
7094 assert_eq!(node_id, nodes[1].node.get_our_node_id());
7096 _ => panic!("Unexpected event"),
7099 assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
7100 // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
7101 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7103 if announce_latest {
7104 connect_block(&nodes[0], &Block { header, txdata: vec![as_last_commitment_tx[0].clone()]}, 1);
7106 connect_block(&nodes[0], &Block { header, txdata: vec![as_prev_commitment_tx[0].clone()]}, 1);
7109 check_closed_broadcast!(nodes[0], false);
7110 check_added_monitors!(nodes[0], 1);
7112 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7113 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 1, true, header.block_hash());
7114 let events = nodes[0].node.get_and_clear_pending_events();
7115 // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
7116 assert_eq!(events.len(), 2);
7117 let mut first_failed = false;
7118 for event in events {
7120 Event::PaymentFailed { payment_hash, .. } => {
7121 if payment_hash == payment_hash_1 {
7122 assert!(!first_failed);
7123 first_failed = true;
7125 assert_eq!(payment_hash, payment_hash_2);
7128 _ => panic!("Unexpected event"),
7134 fn test_failure_delay_dust_htlc_local_commitment() {
7135 do_test_failure_delay_dust_htlc_local_commitment(true);
7136 do_test_failure_delay_dust_htlc_local_commitment(false);
7139 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
7140 // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
7141 // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
7142 // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
7143 // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
7144 // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
7145 // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
7147 let chanmon_cfgs = create_chanmon_cfgs(3);
7148 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7149 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7150 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7151 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7153 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7155 let (_payment_preimage_1, dust_hash) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7156 let (_payment_preimage_2, non_dust_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7158 let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7159 let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
7161 // We revoked bs_commitment_tx
7163 let (payment_preimage_3, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7164 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 1_000_000);
7167 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7168 let mut timeout_tx = Vec::new();
7170 // We fail dust-HTLC 1 by broadcast of local commitment tx
7171 connect_block(&nodes[0], &Block { header, txdata: vec![as_commitment_tx[0].clone()]}, 1);
7172 check_closed_broadcast!(nodes[0], false);
7173 check_added_monitors!(nodes[0], 1);
7174 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7175 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
7176 let parent_hash = connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 2, true, header.block_hash());
7177 expect_payment_failed!(nodes[0], dust_hash, true);
7178 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7179 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
7180 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7181 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7182 connect_block(&nodes[0], &Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
7183 let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7184 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 8, true, header_3.block_hash());
7185 expect_payment_failed!(nodes[0], non_dust_hash, true);
7187 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
7188 connect_block(&nodes[0], &Block { header, txdata: vec![bs_commitment_tx[0].clone()]}, 1);
7189 check_closed_broadcast!(nodes[0], false);
7190 check_added_monitors!(nodes[0], 1);
7191 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7192 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
7193 let parent_hash = connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 2, true, header.block_hash());
7194 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7196 expect_payment_failed!(nodes[0], dust_hash, true);
7197 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7198 // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
7199 connect_block(&nodes[0], &Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
7200 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7201 let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7202 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 8, true, header_3.block_hash());
7203 expect_payment_failed!(nodes[0], non_dust_hash, true);
7205 // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
7207 let events = nodes[0].node.get_and_clear_pending_events();
7208 assert_eq!(events.len(), 2);
7211 Event::PaymentFailed { payment_hash, .. } => {
7212 if payment_hash == dust_hash { first = true; }
7213 else { first = false; }
7215 _ => panic!("Unexpected event"),
7218 Event::PaymentFailed { payment_hash, .. } => {
7219 if first { assert_eq!(payment_hash, non_dust_hash); }
7220 else { assert_eq!(payment_hash, dust_hash); }
7222 _ => panic!("Unexpected event"),
7229 fn test_sweep_outbound_htlc_failure_update() {
7230 do_test_sweep_outbound_htlc_failure_update(false, true);
7231 do_test_sweep_outbound_htlc_failure_update(false, false);
7232 do_test_sweep_outbound_htlc_failure_update(true, false);
7236 fn test_upfront_shutdown_script() {
7237 // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
7238 // enforce it at shutdown message
7240 let mut config = UserConfig::default();
7241 config.channel_options.announced_channel = true;
7242 config.peer_channel_config_limits.force_announced_channel_preference = false;
7243 config.channel_options.commit_upfront_shutdown_pubkey = false;
7244 let user_cfgs = [None, Some(config), None];
7245 let chanmon_cfgs = create_chanmon_cfgs(3);
7246 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7247 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7248 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7250 // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
7251 let flags = InitFeatures::known();
7252 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7253 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7254 let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7255 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7256 // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that we disconnect peer
7257 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
7258 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()));
7259 check_added_monitors!(nodes[2], 1);
7261 // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
7262 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7263 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7264 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7265 // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
7266 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
7267 let events = nodes[2].node.get_and_clear_pending_msg_events();
7268 assert_eq!(events.len(), 1);
7270 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7271 _ => panic!("Unexpected event"),
7274 // We test that if case of peer non-signaling we don't enforce committed script at channel opening
7275 let flags_no = InitFeatures::known().clear_upfront_shutdown_script();
7276 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
7277 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7278 let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
7279 node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7280 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_1_shutdown);
7281 let events = nodes[1].node.get_and_clear_pending_msg_events();
7282 assert_eq!(events.len(), 1);
7284 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7285 _ => panic!("Unexpected event"),
7288 // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7289 // channel smoothly, opt-out is from channel initiator here
7290 let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
7291 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7292 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7293 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7294 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
7295 let events = nodes[0].node.get_and_clear_pending_msg_events();
7296 assert_eq!(events.len(), 1);
7298 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7299 _ => panic!("Unexpected event"),
7302 //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7303 //// channel smoothly
7304 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
7305 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7306 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7307 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7308 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
7309 let events = nodes[0].node.get_and_clear_pending_msg_events();
7310 assert_eq!(events.len(), 2);
7312 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7313 _ => panic!("Unexpected event"),
7316 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7317 _ => panic!("Unexpected event"),
7322 fn test_user_configurable_csv_delay() {
7323 // We test our channel constructors yield errors when we pass them absurd csv delay
7325 let mut low_our_to_self_config = UserConfig::default();
7326 low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
7327 let mut high_their_to_self_config = UserConfig::default();
7328 high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
7329 let user_cfgs = [Some(high_their_to_self_config.clone()), None];
7330 let chanmon_cfgs = create_chanmon_cfgs(2);
7331 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7332 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
7333 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7335 // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
7336 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) {
7338 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())); },
7339 _ => panic!("Unexpected event"),
7341 } else { assert!(false) }
7343 // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
7344 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7345 let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7346 open_channel.to_self_delay = 200;
7347 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) {
7349 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())); },
7350 _ => panic!("Unexpected event"),
7352 } else { assert!(false); }
7354 // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
7355 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7356 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()));
7357 let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7358 accept_channel.to_self_delay = 200;
7359 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7360 if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
7362 &ErrorAction::SendErrorMessage { ref msg } => {
7363 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()));
7365 _ => { assert!(false); }
7367 } else { assert!(false); }
7369 // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
7370 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7371 let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7372 open_channel.to_self_delay = 200;
7373 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) {
7375 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())); },
7376 _ => panic!("Unexpected event"),
7378 } else { assert!(false); }
7382 fn test_data_loss_protect() {
7383 // We want to be sure that :
7384 // * we don't broadcast our Local Commitment Tx in case of fallen behind
7385 // (but this is not quite true - we broadcast during Drop because chanmon is out of sync with chanmgr)
7386 // * we close channel in case of detecting other being fallen behind
7387 // * we are able to claim our own outputs thanks to to_remote being static
7388 // TODO: this test is incomplete and the data_loss_protect implementation is incomplete - see issue #775
7394 let mut chanmon_cfgs = create_chanmon_cfgs(2);
7395 // We broadcast during Drop because chanmon is out of sync with chanmgr, which would cause a panic
7396 // during signing due to revoked tx
7397 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7398 let keys_manager = &chanmon_cfgs[0].keys_manager;
7401 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7402 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7403 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7405 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7407 // Cache node A state before any channel update
7408 let previous_node_state = nodes[0].node.encode();
7409 let mut previous_chain_monitor_state = test_utils::TestVecWriter(Vec::new());
7410 nodes[0].chain_monitor.chain_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write(&mut previous_chain_monitor_state).unwrap();
7412 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
7413 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
7415 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7416 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7418 // Restore node A from previous state
7419 logger = test_utils::TestLogger::with_id(format!("node {}", 0));
7420 let mut chain_monitor = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut ::std::io::Cursor::new(previous_chain_monitor_state.0), keys_manager).unwrap().1;
7421 chain_source = test_utils::TestChainSource::new(Network::Testnet);
7422 tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())};
7423 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
7424 persister = test_utils::TestPersister::new();
7425 monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &fee_estimator, &persister, keys_manager);
7427 let mut channel_monitors = HashMap::new();
7428 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chain_monitor);
7429 <(BlockHash, ChannelManager<EnforcingChannelKeys, &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 {
7430 keys_manager: keys_manager,
7431 fee_estimator: &fee_estimator,
7432 chain_monitor: &monitor,
7434 tx_broadcaster: &tx_broadcaster,
7435 default_config: UserConfig::default(),
7439 nodes[0].node = &node_state_0;
7440 assert!(monitor.watch_channel(OutPoint { txid: chan.3.txid(), index: 0 }, chain_monitor).is_ok());
7441 nodes[0].chain_monitor = &monitor;
7442 nodes[0].chain_source = &chain_source;
7444 check_added_monitors!(nodes[0], 1);
7446 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7447 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7449 let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7451 // Check we don't broadcast any transactions following learning of per_commitment_point from B
7452 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
7453 check_added_monitors!(nodes[0], 1);
7456 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7457 assert_eq!(node_txn.len(), 0);
7460 let mut reestablish_1 = Vec::with_capacity(1);
7461 for msg in nodes[0].node.get_and_clear_pending_msg_events() {
7462 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
7463 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7464 reestablish_1.push(msg.clone());
7465 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
7466 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
7468 &ErrorAction::SendErrorMessage { ref msg } => {
7469 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");
7471 _ => panic!("Unexpected event!"),
7474 panic!("Unexpected event")
7478 // Check we close channel detecting A is fallen-behind
7479 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7480 assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
7481 check_added_monitors!(nodes[1], 1);
7484 // Check A is able to claim to_remote output
7485 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7486 assert_eq!(node_txn.len(), 1);
7487 check_spends!(node_txn[0], chan.3);
7488 assert_eq!(node_txn[0].output.len(), 2);
7489 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
7490 connect_block(&nodes[0], &Block { header, txdata: vec![node_txn[0].clone()]}, 0);
7491 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 0, true, header.block_hash());
7492 let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 1000000);
7493 assert_eq!(spend_txn.len(), 1);
7494 check_spends!(spend_txn[0], node_txn[0]);
7498 fn test_check_htlc_underpaying() {
7499 // Send payment through A -> B but A is maliciously
7500 // sending a probe payment (i.e less than expected value0
7501 // to B, B should refuse payment.
7503 let chanmon_cfgs = create_chanmon_cfgs(2);
7504 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7505 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7506 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7508 // Create some initial channels
7509 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7511 let (payment_preimage, payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 10_000);
7513 // Node 3 is expecting payment of 100_000 but receive 10_000,
7514 // fail htlc like we didn't know the preimage.
7515 nodes[1].node.claim_funds(payment_preimage, &None, 100_000);
7516 nodes[1].node.process_pending_htlc_forwards();
7518 let events = nodes[1].node.get_and_clear_pending_msg_events();
7519 assert_eq!(events.len(), 1);
7520 let (update_fail_htlc, commitment_signed) = match events[0] {
7521 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 } } => {
7522 assert!(update_add_htlcs.is_empty());
7523 assert!(update_fulfill_htlcs.is_empty());
7524 assert_eq!(update_fail_htlcs.len(), 1);
7525 assert!(update_fail_malformed_htlcs.is_empty());
7526 assert!(update_fee.is_none());
7527 (update_fail_htlcs[0].clone(), commitment_signed)
7529 _ => panic!("Unexpected event"),
7531 check_added_monitors!(nodes[1], 1);
7533 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
7534 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
7536 // 10_000 msat as u64, followed by a height of 99 as u32
7537 let mut expected_failure_data = byte_utils::be64_to_array(10_000).to_vec();
7538 expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(99));
7539 expect_payment_failed!(nodes[0], payment_hash, true, 0x4000|15, &expected_failure_data[..]);
7540 nodes[1].node.get_and_clear_pending_events();
7544 fn test_announce_disable_channels() {
7545 // Create 2 channels between A and B. Disconnect B. Call timer_chan_freshness_every_min and check for generated
7546 // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
7548 let chanmon_cfgs = create_chanmon_cfgs(2);
7549 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7550 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7551 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7553 let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7554 let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7555 let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7558 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7559 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7561 nodes[0].node.timer_chan_freshness_every_min(); // dirty -> stagged
7562 nodes[0].node.timer_chan_freshness_every_min(); // staged -> fresh
7563 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7564 assert_eq!(msg_events.len(), 3);
7565 for e in msg_events {
7567 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7568 let short_id = msg.contents.short_channel_id;
7569 // Check generated channel_update match list in PendingChannelUpdate
7570 if short_id != short_id_1 && short_id != short_id_2 && short_id != short_id_3 {
7571 panic!("Generated ChannelUpdate for wrong chan!");
7574 _ => panic!("Unexpected event"),
7578 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7579 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7580 assert_eq!(reestablish_1.len(), 3);
7581 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7582 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7583 assert_eq!(reestablish_2.len(), 3);
7585 // Reestablish chan_1
7586 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7587 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7588 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7589 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7590 // Reestablish chan_2
7591 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
7592 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7593 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
7594 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7595 // Reestablish chan_3
7596 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
7597 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7598 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
7599 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7601 nodes[0].node.timer_chan_freshness_every_min();
7602 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7606 fn test_bump_penalty_txn_on_revoked_commitment() {
7607 // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
7608 // we're able to claim outputs on revoked commitment transaction before timelocks expiration
7610 let chanmon_cfgs = create_chanmon_cfgs(2);
7611 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7612 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7613 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7615 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7616 let logger = test_utils::TestLogger::new();
7619 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7620 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
7621 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, &Vec::new(), 3000000, 30, &logger).unwrap();
7622 send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
7624 let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
7625 // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7626 assert_eq!(revoked_txn[0].output.len(), 4);
7627 assert_eq!(revoked_txn[0].input.len(), 1);
7628 assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
7629 let revoked_txid = revoked_txn[0].txid();
7631 let mut penalty_sum = 0;
7632 for outp in revoked_txn[0].output.iter() {
7633 if outp.script_pubkey.is_v0_p2wsh() {
7634 penalty_sum += outp.value;
7638 // Connect blocks to change height_timer range to see if we use right soonest_timelock
7639 let header_114 = connect_blocks(&nodes[1], 114, 0, false, Default::default());
7641 // Actually revoke tx by claiming a HTLC
7642 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
7643 let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7644 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_txn[0].clone()] }, 115);
7645 check_added_monitors!(nodes[1], 1);
7647 // One or more justice tx should have been broadcast, check it
7651 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7652 assert_eq!(node_txn.len(), 3); // justice tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout (broadcasted from ChannelManager)
7653 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7654 assert_eq!(node_txn[0].output.len(), 1);
7655 check_spends!(node_txn[0], revoked_txn[0]);
7656 let fee_1 = penalty_sum - node_txn[0].output[0].value;
7657 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
7658 penalty_1 = node_txn[0].txid();
7662 // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
7663 let header = connect_blocks(&nodes[1], 3, 115, true, header.block_hash());
7664 let mut penalty_2 = penalty_1;
7665 let mut feerate_2 = 0;
7667 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7668 assert_eq!(node_txn.len(), 1);
7669 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7670 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7671 assert_eq!(node_txn[0].output.len(), 1);
7672 check_spends!(node_txn[0], revoked_txn[0]);
7673 penalty_2 = node_txn[0].txid();
7674 // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7675 assert_ne!(penalty_2, penalty_1);
7676 let fee_2 = penalty_sum - node_txn[0].output[0].value;
7677 feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7678 // Verify 25% bump heuristic
7679 assert!(feerate_2 * 100 >= feerate_1 * 125);
7683 assert_ne!(feerate_2, 0);
7685 // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
7686 connect_blocks(&nodes[1], 3, 118, true, header);
7688 let mut feerate_3 = 0;
7690 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7691 assert_eq!(node_txn.len(), 1);
7692 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7693 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7694 assert_eq!(node_txn[0].output.len(), 1);
7695 check_spends!(node_txn[0], revoked_txn[0]);
7696 penalty_3 = node_txn[0].txid();
7697 // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7698 assert_ne!(penalty_3, penalty_2);
7699 let fee_3 = penalty_sum - node_txn[0].output[0].value;
7700 feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
7701 // Verify 25% bump heuristic
7702 assert!(feerate_3 * 100 >= feerate_2 * 125);
7706 assert_ne!(feerate_3, 0);
7708 nodes[1].node.get_and_clear_pending_events();
7709 nodes[1].node.get_and_clear_pending_msg_events();
7713 fn test_bump_penalty_txn_on_revoked_htlcs() {
7714 // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
7715 // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
7717 let mut chanmon_cfgs = create_chanmon_cfgs(2);
7718 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
7719 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7720 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7721 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7723 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7724 // Lock HTLC in both directions
7725 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3_000_000).0;
7726 route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7728 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7729 assert_eq!(revoked_local_txn[0].input.len(), 1);
7730 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7732 // Revoke local commitment tx
7733 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
7735 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7736 // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
7737 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
7738 check_closed_broadcast!(nodes[1], false);
7739 check_added_monitors!(nodes[1], 1);
7741 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7742 assert_eq!(revoked_htlc_txn.len(), 4);
7743 if revoked_htlc_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7744 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7745 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7746 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7747 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7748 assert_eq!(revoked_htlc_txn[1].output.len(), 1);
7749 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7750 } else if revoked_htlc_txn[1].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7751 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7752 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7753 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7754 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7755 assert_eq!(revoked_htlc_txn[0].output.len(), 1);
7756 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7759 // Broadcast set of revoked txn on A
7760 let header_128 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7761 connect_block(&nodes[0], &Block { header: header_128, txdata: vec![revoked_local_txn[0].clone()] }, 128);
7762 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
7763 let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7764 connect_block(&nodes[0], &Block { header: header_129, txdata: vec![revoked_htlc_txn[0].clone(), revoked_htlc_txn[1].clone()] }, 129);
7769 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7770 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
7771 // Verify claim tx are spending revoked HTLC txn
7773 // node_txn 0-2 each spend a separate revoked output from revoked_local_txn[0]
7774 // Note that node_txn[0] and node_txn[1] are bogus - they double spend the revoked_htlc_txn
7775 // which are included in the same block (they are broadcasted because we scan the
7776 // transactions linearly and generate claims as we go, they likely should be removed in the
7778 assert_eq!(node_txn[0].input.len(), 1);
7779 check_spends!(node_txn[0], revoked_local_txn[0]);
7780 assert_eq!(node_txn[1].input.len(), 1);
7781 check_spends!(node_txn[1], revoked_local_txn[0]);
7782 assert_eq!(node_txn[2].input.len(), 1);
7783 check_spends!(node_txn[2], revoked_local_txn[0]);
7785 // Each of the three justice transactions claim a separate (single) output of the three
7786 // available, which we check here:
7787 assert_ne!(node_txn[0].input[0].previous_output, node_txn[1].input[0].previous_output);
7788 assert_ne!(node_txn[0].input[0].previous_output, node_txn[2].input[0].previous_output);
7789 assert_ne!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
7791 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
7792 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
7794 // node_txn[3] is the local commitment tx broadcast just because (and somewhat in case of
7795 // reorgs, though its not clear its ever worth broadcasting conflicting txn like this when
7796 // a remote commitment tx has already been confirmed).
7797 check_spends!(node_txn[3], chan.3);
7799 // node_txn[4] spends the revoked outputs from the revoked_htlc_txn (which only have one
7800 // output, checked above).
7801 assert_eq!(node_txn[4].input.len(), 2);
7802 assert_eq!(node_txn[4].output.len(), 1);
7803 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7805 first = node_txn[4].txid();
7806 // Store both feerates for later comparison
7807 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[4].output[0].value;
7808 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
7809 penalty_txn = vec![node_txn[2].clone()];
7813 // Connect one more block to see if bumped penalty are issued for HTLC txn
7814 let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7815 connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn }, 130);
7816 let header_131 = BlockHeader { version: 0x20000000, prev_blockhash: header_130.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7817 connect_block(&nodes[0], &Block { header: header_131, txdata: Vec::new() }, 131);
7819 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7820 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
7822 check_spends!(node_txn[0], revoked_local_txn[0]);
7823 check_spends!(node_txn[1], revoked_local_txn[0]);
7824 // Note that these are both bogus - they spend outputs already claimed in block 129:
7825 if node_txn[0].input[0].previous_output == revoked_htlc_txn[0].input[0].previous_output {
7826 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
7828 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
7829 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
7835 // Few more blocks to confirm penalty txn
7836 let header_135 = connect_blocks(&nodes[0], 4, 131, true, header_131.block_hash());
7837 assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
7838 let header_144 = connect_blocks(&nodes[0], 9, 135, true, header_135);
7840 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7841 assert_eq!(node_txn.len(), 1);
7843 assert_eq!(node_txn[0].input.len(), 2);
7844 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7845 // Verify bumped tx is different and 25% bump heuristic
7846 assert_ne!(first, node_txn[0].txid());
7847 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[0].output[0].value;
7848 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7849 assert!(feerate_2 * 100 > feerate_1 * 125);
7850 let txn = vec![node_txn[0].clone()];
7854 // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
7855 let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7856 connect_block(&nodes[0], &Block { header: header_145, txdata: node_txn }, 145);
7857 connect_blocks(&nodes[0], 20, 145, true, header_145.block_hash());
7859 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7860 // We verify than no new transaction has been broadcast because previously
7861 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
7862 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
7863 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
7864 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
7865 // up bumped justice generation.
7866 assert_eq!(node_txn.len(), 0);
7869 check_closed_broadcast!(nodes[0], false);
7870 check_added_monitors!(nodes[0], 1);
7874 fn test_bump_penalty_txn_on_remote_commitment() {
7875 // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
7876 // we're able to claim outputs on remote commitment transaction before timelocks expiration
7879 // Provide preimage for one
7880 // Check aggregation
7882 let chanmon_cfgs = create_chanmon_cfgs(2);
7883 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7884 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7885 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7887 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7888 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7889 route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
7891 // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7892 let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
7893 assert_eq!(remote_txn[0].output.len(), 4);
7894 assert_eq!(remote_txn[0].input.len(), 1);
7895 assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
7897 // Claim a HTLC without revocation (provide B monitor with preimage)
7898 nodes[1].node.claim_funds(payment_preimage, &None, 3_000_000);
7899 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7900 connect_block(&nodes[1], &Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
7901 check_added_monitors!(nodes[1], 2);
7903 // One or more claim tx should have been broadcast, check it
7906 let feerate_timeout;
7907 let feerate_preimage;
7909 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7910 assert_eq!(node_txn.len(), 5); // 2 * claim tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout + local HTLC-success (broadcasted from ChannelManager)
7911 assert_eq!(node_txn[0].input.len(), 1);
7912 assert_eq!(node_txn[1].input.len(), 1);
7913 check_spends!(node_txn[0], remote_txn[0]);
7914 check_spends!(node_txn[1], remote_txn[0]);
7915 check_spends!(node_txn[2], chan.3);
7916 check_spends!(node_txn[3], node_txn[2]);
7917 check_spends!(node_txn[4], node_txn[2]);
7918 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7919 timeout = node_txn[0].txid();
7920 let index = node_txn[0].input[0].previous_output.vout;
7921 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7922 feerate_timeout = fee * 1000 / node_txn[0].get_weight() as u64;
7924 preimage = node_txn[1].txid();
7925 let index = node_txn[1].input[0].previous_output.vout;
7926 let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7927 feerate_preimage = fee * 1000 / node_txn[1].get_weight() as u64;
7929 timeout = node_txn[1].txid();
7930 let index = node_txn[1].input[0].previous_output.vout;
7931 let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7932 feerate_timeout = fee * 1000 / node_txn[1].get_weight() as u64;
7934 preimage = node_txn[0].txid();
7935 let index = node_txn[0].input[0].previous_output.vout;
7936 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7937 feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
7941 assert_ne!(feerate_timeout, 0);
7942 assert_ne!(feerate_preimage, 0);
7944 // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
7945 connect_blocks(&nodes[1], 15, 1, true, header.block_hash());
7947 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7948 assert_eq!(node_txn.len(), 2);
7949 assert_eq!(node_txn[0].input.len(), 1);
7950 assert_eq!(node_txn[1].input.len(), 1);
7951 check_spends!(node_txn[0], remote_txn[0]);
7952 check_spends!(node_txn[1], remote_txn[0]);
7953 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7954 let index = node_txn[0].input[0].previous_output.vout;
7955 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7956 let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
7957 assert!(new_feerate * 100 > feerate_timeout * 125);
7958 assert_ne!(timeout, node_txn[0].txid());
7960 let index = node_txn[1].input[0].previous_output.vout;
7961 let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7962 let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
7963 assert!(new_feerate * 100 > feerate_preimage * 125);
7964 assert_ne!(preimage, node_txn[1].txid());
7966 let index = node_txn[1].input[0].previous_output.vout;
7967 let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7968 let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
7969 assert!(new_feerate * 100 > feerate_timeout * 125);
7970 assert_ne!(timeout, node_txn[1].txid());
7972 let index = node_txn[0].input[0].previous_output.vout;
7973 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7974 let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
7975 assert!(new_feerate * 100 > feerate_preimage * 125);
7976 assert_ne!(preimage, node_txn[0].txid());
7981 nodes[1].node.get_and_clear_pending_events();
7982 nodes[1].node.get_and_clear_pending_msg_events();
7986 fn test_set_outpoints_partial_claiming() {
7987 // - remote party claim tx, new bump tx
7988 // - disconnect remote claiming tx, new bump
7989 // - disconnect tx, see no tx anymore
7990 let chanmon_cfgs = create_chanmon_cfgs(2);
7991 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7992 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7993 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7995 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7996 let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7997 let payment_preimage_2 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7999 // Remote commitment txn with 4 outputs: to_local, to_remote, 2 outgoing HTLC
8000 let remote_txn = get_local_commitment_txn!(nodes[1], chan.2);
8001 assert_eq!(remote_txn.len(), 3);
8002 assert_eq!(remote_txn[0].output.len(), 4);
8003 assert_eq!(remote_txn[0].input.len(), 1);
8004 assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
8005 check_spends!(remote_txn[1], remote_txn[0]);
8006 check_spends!(remote_txn[2], remote_txn[0]);
8008 // Connect blocks on node A to advance height towards TEST_FINAL_CLTV
8009 let prev_header_100 = connect_blocks(&nodes[1], 100, 0, false, Default::default());
8010 // Provide node A with both preimage
8011 nodes[0].node.claim_funds(payment_preimage_1, &None, 3_000_000);
8012 nodes[0].node.claim_funds(payment_preimage_2, &None, 3_000_000);
8013 check_added_monitors!(nodes[0], 2);
8014 nodes[0].node.get_and_clear_pending_events();
8015 nodes[0].node.get_and_clear_pending_msg_events();
8017 // Connect blocks on node A commitment transaction
8018 let header = BlockHeader { version: 0x20000000, prev_blockhash: prev_header_100, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8019 connect_block(&nodes[0], &Block { header, txdata: vec![remote_txn[0].clone()] }, 101);
8020 check_closed_broadcast!(nodes[0], false);
8021 check_added_monitors!(nodes[0], 1);
8022 // Verify node A broadcast tx claiming both HTLCs
8024 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8025 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-Success*2
8026 assert_eq!(node_txn.len(), 4);
8027 check_spends!(node_txn[0], remote_txn[0]);
8028 check_spends!(node_txn[1], chan.3);
8029 check_spends!(node_txn[2], node_txn[1]);
8030 check_spends!(node_txn[3], node_txn[1]);
8031 assert_eq!(node_txn[0].input.len(), 2);
8035 // Connect blocks on node B
8036 connect_blocks(&nodes[1], 135, 0, false, Default::default());
8037 check_closed_broadcast!(nodes[1], false);
8038 check_added_monitors!(nodes[1], 1);
8039 // Verify node B broadcast 2 HTLC-timeout txn
8040 let partial_claim_tx = {
8041 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8042 assert_eq!(node_txn.len(), 3);
8043 check_spends!(node_txn[1], node_txn[0]);
8044 check_spends!(node_txn[2], node_txn[0]);
8045 assert_eq!(node_txn[1].input.len(), 1);
8046 assert_eq!(node_txn[2].input.len(), 1);
8050 // Broadcast partial claim on node A, should regenerate a claiming tx with HTLC dropped
8051 let header = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8052 connect_block(&nodes[0], &Block { header, txdata: vec![partial_claim_tx.clone()] }, 102);
8054 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8055 assert_eq!(node_txn.len(), 1);
8056 check_spends!(node_txn[0], remote_txn[0]);
8057 assert_eq!(node_txn[0].input.len(), 1); //dropped HTLC
8060 nodes[0].node.get_and_clear_pending_msg_events();
8062 // Disconnect last block on node A, should regenerate a claiming tx with HTLC dropped
8063 disconnect_block(&nodes[0], &header, 102);
8065 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8066 assert_eq!(node_txn.len(), 1);
8067 check_spends!(node_txn[0], remote_txn[0]);
8068 assert_eq!(node_txn[0].input.len(), 2); //resurrected HTLC
8072 //// Disconnect one more block and then reconnect multiple no transaction should be generated
8073 disconnect_block(&nodes[0], &header, 101);
8074 connect_blocks(&nodes[1], 15, 101, false, prev_header_100);
8076 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8077 assert_eq!(node_txn.len(), 0);
8083 fn test_counterparty_raa_skip_no_crash() {
8084 // Previously, if our counterparty sent two RAAs in a row without us having provided a
8085 // commitment transaction, we would have happily carried on and provided them the next
8086 // commitment transaction based on one RAA forward. This would probably eventually have led to
8087 // channel closure, but it would not have resulted in funds loss. Still, our
8088 // EnforcingChannelKeys would have paniced as it doesn't like jumps into the future. Here, we
8089 // check simply that the channel is closed in response to such an RAA, but don't check whether
8090 // we decide to punish our counterparty for revoking their funds (as we don't currently
8092 let chanmon_cfgs = create_chanmon_cfgs(2);
8093 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8094 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8095 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8096 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
8098 let mut guard = nodes[0].node.channel_state.lock().unwrap();
8099 let keys = &guard.by_id.get_mut(&channel_id).unwrap().holder_keys;
8100 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
8101 let per_commitment_secret = keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER);
8102 // Must revoke without gaps
8103 keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 1);
8104 let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
8105 &SecretKey::from_slice(&keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
8107 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
8108 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
8109 assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
8110 check_added_monitors!(nodes[1], 1);
8114 fn test_bump_txn_sanitize_tracking_maps() {
8115 // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
8116 // verify we clean then right after expiration of ANTI_REORG_DELAY.
8118 let chanmon_cfgs = create_chanmon_cfgs(2);
8119 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8120 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8121 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8123 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8124 // Lock HTLC in both directions
8125 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8126 route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
8128 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8129 assert_eq!(revoked_local_txn[0].input.len(), 1);
8130 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8132 // Revoke local commitment tx
8133 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 9_000_000);
8135 // Broadcast set of revoked txn on A
8136 let header_128 = connect_blocks(&nodes[0], 128, 0, false, Default::default());
8137 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8139 let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8140 connect_block(&nodes[0], &Block { header: header_129, txdata: vec![revoked_local_txn[0].clone()] }, 129);
8141 check_closed_broadcast!(nodes[0], false);
8142 check_added_monitors!(nodes[0], 1);
8144 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8145 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
8146 check_spends!(node_txn[0], revoked_local_txn[0]);
8147 check_spends!(node_txn[1], revoked_local_txn[0]);
8148 check_spends!(node_txn[2], revoked_local_txn[0]);
8149 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
8153 let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8154 connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn }, 130);
8155 connect_blocks(&nodes[0], 5, 130, false, header_130.block_hash());
8157 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.lock().unwrap();
8158 if let Some(monitor) = monitors.get(&OutPoint { txid: chan.3.txid(), index: 0 }) {
8159 assert!(monitor.onchain_tx_handler.pending_claim_requests.is_empty());
8160 assert!(monitor.onchain_tx_handler.claimable_outpoints.is_empty());
8166 fn test_override_channel_config() {
8167 let chanmon_cfgs = create_chanmon_cfgs(2);
8168 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8169 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8170 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8172 // Node0 initiates a channel to node1 using the override config.
8173 let mut override_config = UserConfig::default();
8174 override_config.own_channel_config.our_to_self_delay = 200;
8176 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
8178 // Assert the channel created by node0 is using the override config.
8179 let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8180 assert_eq!(res.channel_flags, 0);
8181 assert_eq!(res.to_self_delay, 200);
8185 fn test_override_0msat_htlc_minimum() {
8186 let mut zero_config = UserConfig::default();
8187 zero_config.own_channel_config.our_htlc_minimum_msat = 0;
8188 let chanmon_cfgs = create_chanmon_cfgs(2);
8189 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8190 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
8191 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8193 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
8194 let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8195 assert_eq!(res.htlc_minimum_msat, 1);
8197 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &res);
8198 let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8199 assert_eq!(res.htlc_minimum_msat, 1);
8203 fn test_simple_payment_secret() {
8204 // Simple test of sending a payment with a payment_secret present. This does not use any AMP
8205 // features, however.
8206 let chanmon_cfgs = create_chanmon_cfgs(3);
8207 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8208 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8209 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8211 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8212 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
8213 let logger = test_utils::TestLogger::new();
8215 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(&nodes[0]);
8216 let payment_secret = PaymentSecret([0xdb; 32]);
8217 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8218 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, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
8219 send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2]]], 100000, payment_hash, Some(payment_secret.clone()));
8220 // Claiming with all the correct values but the wrong secret should result in nothing...
8221 assert_eq!(nodes[2].node.claim_funds(payment_preimage, &None, 100_000), false);
8222 assert_eq!(nodes[2].node.claim_funds(payment_preimage, &Some(PaymentSecret([42; 32])), 100_000), false);
8223 // ...but with the right secret we should be able to claim all the way back
8224 claim_payment_along_route_with_secret(&nodes[0], &[&[&nodes[1], &nodes[2]]], false, payment_preimage, Some(payment_secret.clone()), 100_000);
8228 fn test_simple_mpp() {
8229 // Simple test of sending a multi-path payment.
8230 let chanmon_cfgs = create_chanmon_cfgs(4);
8231 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8232 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8233 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8235 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8236 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8237 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8238 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8239 let logger = test_utils::TestLogger::new();
8241 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(&nodes[0]);
8242 let payment_secret = PaymentSecret([0xdb; 32]);
8243 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8244 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, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
8245 let path = route.paths[0].clone();
8246 route.paths.push(path);
8247 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8248 route.paths[0][0].short_channel_id = chan_1_id;
8249 route.paths[0][1].short_channel_id = chan_3_id;
8250 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8251 route.paths[1][0].short_channel_id = chan_2_id;
8252 route.paths[1][1].short_channel_id = chan_4_id;
8253 send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, Some(payment_secret.clone()));
8254 // Claiming with all the correct values but the wrong secret should result in nothing...
8255 assert_eq!(nodes[3].node.claim_funds(payment_preimage, &None, 200_000), false);
8256 assert_eq!(nodes[3].node.claim_funds(payment_preimage, &Some(PaymentSecret([42; 32])), 200_000), false);
8257 // ...but with the right secret we should be able to claim all the way back
8258 claim_payment_along_route_with_secret(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage, Some(payment_secret), 200_000);
8262 fn test_update_err_monitor_lockdown() {
8263 // Our monitor will lock update of local commitment transaction if a broadcastion condition
8264 // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
8265 // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateErr.
8267 // This scenario may happen in a watchtower setup, where watchtower process a block height
8268 // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
8269 // commitment at same time.
8271 let chanmon_cfgs = create_chanmon_cfgs(2);
8272 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8273 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8274 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8276 // Create some initial channel
8277 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8278 let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8280 // Rebalance the network to generate htlc in the two directions
8281 send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000, 10_000_000);
8283 // Route a HTLC from node 0 to node 1 (but don't settle)
8284 let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8286 // Copy ChainMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
8287 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8288 let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
8289 let persister = test_utils::TestPersister::new();
8291 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.lock().unwrap();
8292 let monitor = monitors.get(&outpoint).unwrap();
8293 let mut w = test_utils::TestVecWriter(Vec::new());
8294 monitor.write(&mut w).unwrap();
8295 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingChannelKeys>)>::read(
8296 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8297 assert!(new_monitor == *monitor);
8298 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);
8299 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8302 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8303 watchtower.chain_monitor.block_connected(&header, &[], 200);
8305 // Try to update ChannelMonitor
8306 assert!(nodes[1].node.claim_funds(preimage, &None, 9_000_000));
8307 check_added_monitors!(nodes[1], 1);
8308 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8309 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8310 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8311 if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8312 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8313 if let Err(_) = watchtower.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8314 if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8315 } else { assert!(false); }
8316 } else { assert!(false); };
8317 // Our local monitor is in-sync and hasn't processed yet timeout
8318 check_added_monitors!(nodes[0], 1);
8319 let events = nodes[0].node.get_and_clear_pending_events();
8320 assert_eq!(events.len(), 1);
8324 fn test_concurrent_monitor_claim() {
8325 // Watchtower A receives block, broadcasts state N, then channel receives new state N+1,
8326 // sending it to both watchtowers, Bob accepts N+1, then receives block and broadcasts
8327 // the latest state N+1, Alice rejects state N+1, but Bob has already broadcast it,
8328 // state N+1 confirms. Alice claims output from state N+1.
8330 let chanmon_cfgs = create_chanmon_cfgs(2);
8331 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8332 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8333 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8335 // Create some initial channel
8336 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8337 let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8339 // Rebalance the network to generate htlc in the two directions
8340 send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000, 10_000_000);
8342 // Route a HTLC from node 0 to node 1 (but don't settle)
8343 route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8345 // Copy ChainMonitor to simulate watchtower Alice and update block height her ChannelMonitor timeout HTLC onchain
8346 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8347 let logger = test_utils::TestLogger::with_id(format!("node {}", "Alice"));
8348 let persister = test_utils::TestPersister::new();
8349 let watchtower_alice = {
8350 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.lock().unwrap();
8351 let monitor = monitors.get(&outpoint).unwrap();
8352 let mut w = test_utils::TestVecWriter(Vec::new());
8353 monitor.write(&mut w).unwrap();
8354 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingChannelKeys>)>::read(
8355 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8356 assert!(new_monitor == *monitor);
8357 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);
8358 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8361 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8362 watchtower_alice.chain_monitor.block_connected(&header, &vec![], 135);
8364 // Watchtower Alice should have broadcast a commitment/HTLC-timeout
8366 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8367 assert_eq!(txn.len(), 2);
8371 // Copy ChainMonitor to simulate watchtower Bob and make it receive a commitment update first.
8372 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8373 let logger = test_utils::TestLogger::with_id(format!("node {}", "Bob"));
8374 let persister = test_utils::TestPersister::new();
8375 let watchtower_bob = {
8376 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.lock().unwrap();
8377 let monitor = monitors.get(&outpoint).unwrap();
8378 let mut w = test_utils::TestVecWriter(Vec::new());
8379 monitor.write(&mut w).unwrap();
8380 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingChannelKeys>)>::read(
8381 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8382 assert!(new_monitor == *monitor);
8383 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);
8384 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8387 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8388 watchtower_bob.chain_monitor.block_connected(&header, &vec![], 134);
8390 // Route another payment to generate another update with still previous HTLC pending
8391 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
8393 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
8394 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, &Vec::new(), 3000000 , TEST_FINAL_CLTV, &logger).unwrap();
8395 nodes[1].node.send_payment(&route, payment_hash, &None).unwrap();
8397 check_added_monitors!(nodes[1], 1);
8399 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8400 assert_eq!(updates.update_add_htlcs.len(), 1);
8401 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &updates.update_add_htlcs[0]);
8402 if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8403 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8404 // Watchtower Alice should already have seen the block and reject the update
8405 if let Err(_) = watchtower_alice.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8406 if let Ok(_) = watchtower_bob.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8407 if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8408 } else { assert!(false); }
8409 } else { assert!(false); };
8410 // Our local monitor is in-sync and hasn't processed yet timeout
8411 check_added_monitors!(nodes[0], 1);
8413 //// Provide one more block to watchtower Bob, expect broadcast of commitment and HTLC-Timeout
8414 watchtower_bob.chain_monitor.block_connected(&header, &vec![], 135);
8416 // Watchtower Bob should have broadcast a commitment/HTLC-timeout
8419 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8420 assert_eq!(txn.len(), 2);
8421 bob_state_y = txn[0].clone();
8425 // We confirm Bob's state Y on Alice, she should broadcast a HTLC-timeout
8426 watchtower_alice.chain_monitor.block_connected(&header, &vec![(0, &bob_state_y)], 136);
8428 let htlc_txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8429 // We broadcast twice the transaction, once due to the HTLC-timeout, once due
8430 // the onchain detection of the HTLC output
8431 assert_eq!(htlc_txn.len(), 2);
8432 check_spends!(htlc_txn[0], bob_state_y);
8433 check_spends!(htlc_txn[1], bob_state_y);
8438 fn test_pre_lockin_no_chan_closed_update() {
8439 // Test that if a peer closes a channel in response to a funding_created message we don't
8440 // generate a channel update (as the channel cannot appear on chain without a funding_signed
8443 // Doing so would imply a channel monitor update before the initial channel monitor
8444 // registration, violating our API guarantees.
8446 // Previously, full_stack_target managed to hit this case by opening then closing a channel,
8447 // then opening a second channel with the same funding output as the first (which is not
8448 // rejected because the first channel does not exist in the ChannelManager) and closing it
8449 // before receiving funding_signed.
8450 let chanmon_cfgs = create_chanmon_cfgs(2);
8451 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8452 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8453 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8455 // Create an initial channel
8456 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8457 let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8458 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8459 let accept_chan_msg = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8460 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_chan_msg);
8462 // Move the first channel through the funding flow...
8463 let (temporary_channel_id, _tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
8465 nodes[0].node.funding_transaction_generated(&temporary_channel_id, funding_output);
8466 check_added_monitors!(nodes[0], 0);
8468 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8469 let channel_id = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
8470 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id, data: "Hi".to_owned() });
8471 assert!(nodes[0].chain_monitor.added_monitors.lock().unwrap().is_empty());
8475 fn test_htlc_no_detection() {
8476 // This test is a mutation to underscore the detection logic bug we had
8477 // before #653. HTLC value routed is above the remaining balance, thus
8478 // inverting HTLC and `to_remote` output. HTLC will come second and
8479 // it wouldn't be seen by pre-#653 detection as we were enumerate()'ing
8480 // on a watched outputs vector (Vec<TxOut>) thus implicitly relying on
8481 // outputs order detection for correct spending children filtring.
8483 let chanmon_cfgs = create_chanmon_cfgs(2);
8484 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8485 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8486 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8488 // Create some initial channels
8489 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8491 send_payment(&nodes[0], &vec!(&nodes[1])[..], 1_000_000, 1_000_000);
8492 let (_, our_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 2_000_000);
8493 let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
8494 assert_eq!(local_txn[0].input.len(), 1);
8495 assert_eq!(local_txn[0].output.len(), 3);
8496 check_spends!(local_txn[0], chan_1.3);
8498 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
8499 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8500 connect_block(&nodes[0], &Block { header, txdata: vec![local_txn[0].clone()] }, 200);
8501 // We deliberately connect the local tx twice as this should provoke a failure calling
8502 // this test before #653 fix.
8503 connect_block(&nodes[0], &Block { header, txdata: vec![local_txn[0].clone()] }, 200);
8504 check_closed_broadcast!(nodes[0], false);
8505 check_added_monitors!(nodes[0], 1);
8507 let htlc_timeout = {
8508 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8509 assert_eq!(node_txn[0].input.len(), 1);
8510 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8511 check_spends!(node_txn[0], local_txn[0]);
8515 let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8516 connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] }, 201);
8517 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 201, true, header_201.block_hash());
8518 expect_payment_failed!(nodes[0], our_payment_hash, true);
8521 fn do_test_onchain_htlc_settlement_after_close(broadcast_alice: bool, go_onchain_before_fulfill: bool) {
8522 // If we route an HTLC, then learn the HTLC's preimage after the upstream channel has been
8523 // force-closed, we must claim that HTLC on-chain. (Given an HTLC forwarded from Alice --> Bob -->
8524 // Carol, Alice would be the upstream node, and Carol the downstream.)
8526 // Steps of the test:
8527 // 1) Alice sends a HTLC to Carol through Bob.
8528 // 2) Carol doesn't settle the HTLC.
8529 // 3) If broadcast_alice is true, Alice force-closes her channel with Bob. Else Bob force closes.
8530 // Steps 4 and 5 may be reordered depending on go_onchain_before_fulfill.
8531 // 4) Bob sees the Alice's commitment on his chain or vice versa. An offered output is present
8532 // but can't be claimed as Bob doesn't have yet knowledge of the preimage.
8533 // 5) Carol release the preimage to Bob off-chain.
8534 // 6) Bob claims the offered output on the broadcasted commitment.
8535 let chanmon_cfgs = create_chanmon_cfgs(3);
8536 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8537 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8538 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8540 // Create some initial channels
8541 let chan_ab = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8542 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8544 // Steps (1) and (2):
8545 // Send an HTLC Alice --> Bob --> Carol, but Carol doesn't settle the HTLC back.
8546 let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3_000_000);
8548 // Check that Alice's commitment transaction now contains an output for this HTLC.
8549 let alice_txn = get_local_commitment_txn!(nodes[0], chan_ab.2);
8550 check_spends!(alice_txn[0], chan_ab.3);
8551 assert_eq!(alice_txn[0].output.len(), 2);
8552 check_spends!(alice_txn[1], alice_txn[0]); // 2nd transaction is a non-final HTLC-timeout
8553 assert_eq!(alice_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8554 assert_eq!(alice_txn.len(), 2);
8556 // Steps (3) and (4):
8557 // If `go_onchain_before_fufill`, broadcast the relevant commitment transaction and check that Bob
8558 // responds by (1) broadcasting a channel update and (2) adding a new ChannelMonitor.
8559 let mut force_closing_node = 0; // Alice force-closes
8560 if !broadcast_alice { force_closing_node = 1; } // Bob force-closes
8561 nodes[force_closing_node].node.force_close_channel(&chan_ab.2).unwrap();
8562 check_closed_broadcast!(nodes[force_closing_node], false);
8563 check_added_monitors!(nodes[force_closing_node], 1);
8564 if go_onchain_before_fulfill {
8565 let txn_to_broadcast = match broadcast_alice {
8566 true => alice_txn.clone(),
8567 false => get_local_commitment_txn!(nodes[1], chan_ab.2)
8569 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8570 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]}, 1);
8571 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8572 if broadcast_alice {
8573 check_closed_broadcast!(nodes[1], false);
8574 check_added_monitors!(nodes[1], 1);
8576 assert_eq!(bob_txn.len(), 1);
8577 check_spends!(bob_txn[0], chan_ab.3);
8581 // Carol then claims the funds and sends an update_fulfill message to Bob, and they go through the
8582 // process of removing the HTLC from their commitment transactions.
8583 assert!(nodes[2].node.claim_funds(payment_preimage, &None, 3_000_000));
8584 check_added_monitors!(nodes[2], 1);
8585 let carol_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
8586 assert!(carol_updates.update_add_htlcs.is_empty());
8587 assert!(carol_updates.update_fail_htlcs.is_empty());
8588 assert!(carol_updates.update_fail_malformed_htlcs.is_empty());
8589 assert!(carol_updates.update_fee.is_none());
8590 assert_eq!(carol_updates.update_fulfill_htlcs.len(), 1);
8592 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &carol_updates.update_fulfill_htlcs[0]);
8593 // If Alice broadcasted but Bob doesn't know yet, here he prepares to tell her about the preimage.
8594 if !go_onchain_before_fulfill && broadcast_alice {
8595 let events = nodes[1].node.get_and_clear_pending_msg_events();
8596 assert_eq!(events.len(), 1);
8598 MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
8599 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
8601 _ => panic!("Unexpected event"),
8604 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &carol_updates.commitment_signed);
8605 // One monitor update for the preimage to update the Bob<->Alice channel, one monitor update
8606 // Carol<->Bob's updated commitment transaction info.
8607 check_added_monitors!(nodes[1], 2);
8609 let events = nodes[1].node.get_and_clear_pending_msg_events();
8610 assert_eq!(events.len(), 2);
8611 let bob_revocation = match events[0] {
8612 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8613 assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8616 _ => panic!("Unexpected event"),
8618 let bob_updates = match events[1] {
8619 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
8620 assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8623 _ => panic!("Unexpected event"),
8626 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bob_revocation);
8627 check_added_monitors!(nodes[2], 1);
8628 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bob_updates.commitment_signed);
8629 check_added_monitors!(nodes[2], 1);
8631 let events = nodes[2].node.get_and_clear_pending_msg_events();
8632 assert_eq!(events.len(), 1);
8633 let carol_revocation = match events[0] {
8634 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8635 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
8638 _ => panic!("Unexpected event"),
8640 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &carol_revocation);
8641 check_added_monitors!(nodes[1], 1);
8643 // If this test requires the force-closed channel to not be on-chain until after the fulfill,
8644 // here's where we put said channel's commitment tx on-chain.
8645 let mut txn_to_broadcast = alice_txn.clone();
8646 if !broadcast_alice { txn_to_broadcast = get_local_commitment_txn!(nodes[1], chan_ab.2); }
8647 if !go_onchain_before_fulfill {
8648 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8649 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]}, 1);
8650 // If Bob was the one to force-close, he will have already passed these checks earlier.
8651 if broadcast_alice {
8652 check_closed_broadcast!(nodes[1], false);
8653 check_added_monitors!(nodes[1], 1);
8655 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8656 if broadcast_alice {
8657 // In `connect_block()`, the ChainMonitor and ChannelManager are separately notified about a
8658 // new block being connected. The ChannelManager being notified triggers a monitor update,
8659 // which triggers broadcasting our commitment tx and an HTLC-claiming tx. The ChainMonitor
8660 // being notified triggers the HTLC-claiming tx redundantly, resulting in 3 total txs being
8662 assert_eq!(bob_txn.len(), 3);
8663 check_spends!(bob_txn[1], chan_ab.3);
8665 assert_eq!(bob_txn.len(), 2);
8666 check_spends!(bob_txn[0], chan_ab.3);
8671 // Finally, check that Bob broadcasted a preimage-claiming transaction for the HTLC output on the
8672 // broadcasted commitment transaction.
8674 let bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
8675 if go_onchain_before_fulfill {
8676 // Bob should now have an extra broadcasted tx, for the preimage-claiming transaction.
8677 assert_eq!(bob_txn.len(), 2);
8679 let script_weight = match broadcast_alice {
8680 true => OFFERED_HTLC_SCRIPT_WEIGHT,
8681 false => ACCEPTED_HTLC_SCRIPT_WEIGHT
8683 // If Alice force-closed and Bob didn't receive her commitment transaction until after he
8684 // received Carol's fulfill, he broadcasts the HTLC-output-claiming transaction first. Else if
8685 // Bob force closed or if he found out about Alice's commitment tx before receiving Carol's
8686 // fulfill, then he broadcasts the HTLC-output-claiming transaction second.
8687 if broadcast_alice && !go_onchain_before_fulfill {
8688 check_spends!(bob_txn[0], txn_to_broadcast[0]);
8689 assert_eq!(bob_txn[0].input[0].witness.last().unwrap().len(), script_weight);
8691 check_spends!(bob_txn[1], txn_to_broadcast[0]);
8692 assert_eq!(bob_txn[1].input[0].witness.last().unwrap().len(), script_weight);
8698 fn test_onchain_htlc_settlement_after_close() {
8699 do_test_onchain_htlc_settlement_after_close(true, true);
8700 do_test_onchain_htlc_settlement_after_close(false, true); // Technically redundant, but may as well
8701 do_test_onchain_htlc_settlement_after_close(true, false);
8702 do_test_onchain_htlc_settlement_after_close(false, false);
8706 fn test_duplicate_chan_id() {
8707 // Test that if a given peer tries to open a channel with the same channel_id as one that is
8708 // already open we reject it and keep the old channel.
8710 // Previously, full_stack_target managed to figure out that if you tried to open two channels
8711 // with the same funding output (ie post-funding channel_id), we'd create a monitor update for
8712 // the existing channel when we detect the duplicate new channel, screwing up our monitor
8713 // updating logic for the existing channel.
8714 let chanmon_cfgs = create_chanmon_cfgs(2);
8715 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8716 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8717 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8719 // Create an initial channel
8720 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8721 let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8722 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8723 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()));
8725 // Try to create a second channel with the same temporary_channel_id as the first and check
8726 // that it is rejected.
8727 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8729 let events = nodes[1].node.get_and_clear_pending_msg_events();
8730 assert_eq!(events.len(), 1);
8732 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8733 // Technically, at this point, nodes[1] would be justified in thinking both the
8734 // first (valid) and second (invalid) channels are closed, given they both have
8735 // the same non-temporary channel_id. However, currently we do not, so we just
8736 // move forward with it.
8737 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
8738 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8740 _ => panic!("Unexpected event"),
8744 // Move the first channel through the funding flow...
8745 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
8747 nodes[0].node.funding_transaction_generated(&temporary_channel_id, funding_output);
8748 check_added_monitors!(nodes[0], 0);
8750 let mut funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8751 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
8753 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
8754 assert_eq!(added_monitors.len(), 1);
8755 assert_eq!(added_monitors[0].0, funding_output);
8756 added_monitors.clear();
8758 let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
8760 let funding_outpoint = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index };
8761 let channel_id = funding_outpoint.to_channel_id();
8763 // Now we have the first channel past funding_created (ie it has a txid-based channel_id, not a
8766 // First try to open a second channel with a temporary channel id equal to the txid-based one.
8767 // Technically this is allowed by the spec, but we don't support it and there's little reason
8768 // to. Still, it shouldn't cause any other issues.
8769 open_chan_msg.temporary_channel_id = channel_id;
8770 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8772 let events = nodes[1].node.get_and_clear_pending_msg_events();
8773 assert_eq!(events.len(), 1);
8775 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8776 // Technically, at this point, nodes[1] would be justified in thinking both
8777 // channels are closed, but currently we do not, so we just move forward with it.
8778 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
8779 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8781 _ => panic!("Unexpected event"),
8785 // Now try to create a second channel which has a duplicate funding output.
8786 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8787 let open_chan_2_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8788 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_2_msg);
8789 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()));
8790 create_funding_transaction(&nodes[0], 100000, 42); // Get and check the FundingGenerationReady event
8792 let funding_created = {
8793 let mut a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
8794 let mut as_chan = a_channel_lock.by_id.get_mut(&open_chan_2_msg.temporary_channel_id).unwrap();
8795 let logger = test_utils::TestLogger::new();
8796 as_chan.get_outbound_funding_created(funding_outpoint, &&logger).unwrap()
8798 check_added_monitors!(nodes[0], 0);
8799 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
8800 // At this point we'll try to add a duplicate channel monitor, which will be rejected, but
8801 // still needs to be cleared here.
8802 check_added_monitors!(nodes[1], 1);
8804 // ...still, nodes[1] will reject the duplicate channel.
8806 let events = nodes[1].node.get_and_clear_pending_msg_events();
8807 assert_eq!(events.len(), 1);
8809 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8810 // Technically, at this point, nodes[1] would be justified in thinking both
8811 // channels are closed, but currently we do not, so we just move forward with it.
8812 assert_eq!(msg.channel_id, channel_id);
8813 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8815 _ => panic!("Unexpected event"),
8819 // finally, finish creating the original channel and send a payment over it to make sure
8820 // everything is functional.
8821 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
8823 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
8824 assert_eq!(added_monitors.len(), 1);
8825 assert_eq!(added_monitors[0].0, funding_output);
8826 added_monitors.clear();
8829 let events_4 = nodes[0].node.get_and_clear_pending_events();
8830 assert_eq!(events_4.len(), 1);
8832 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
8833 assert_eq!(user_channel_id, 42);
8834 assert_eq!(*funding_txo, funding_output);
8836 _ => panic!("Unexpected event"),
8839 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
8840 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
8841 update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
8842 send_payment(&nodes[0], &[&nodes[1]], 8000000, 8_000_000);
8846 fn test_error_chans_closed() {
8847 // Test that we properly handle error messages, closing appropriate channels.
8849 // Prior to #787 we'd allow a peer to make us force-close a channel we had with a different
8850 // peer. The "real" fix for that is to index channels with peers_ids, however in the mean time
8851 // we can test various edge cases around it to ensure we don't regress.
8852 let chanmon_cfgs = create_chanmon_cfgs(3);
8853 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8854 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8855 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8857 // Create some initial channels
8858 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8859 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8860 let chan_3 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8862 assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
8863 assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
8864 assert_eq!(nodes[2].node.list_usable_channels().len(), 1);
8866 // Closing a channel from a different peer has no effect
8867 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_3.2, data: "ERR".to_owned() });
8868 assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
8870 // Closing one channel doesn't impact others
8871 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_2.2, data: "ERR".to_owned() });
8872 check_added_monitors!(nodes[0], 1);
8873 check_closed_broadcast!(nodes[0], false);
8874 assert_eq!(nodes[0].node.list_usable_channels().len(), 2);
8875 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);
8876 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);
8878 // A null channel ID should close all channels
8879 let _chan_4 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8880 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: [0; 32], data: "ERR".to_owned() });
8881 check_added_monitors!(nodes[0], 2);
8882 let events = nodes[0].node.get_and_clear_pending_msg_events();
8883 assert_eq!(events.len(), 2);
8885 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
8886 assert_eq!(msg.contents.flags & 2, 2);
8888 _ => panic!("Unexpected event"),
8891 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
8892 assert_eq!(msg.contents.flags & 2, 2);
8894 _ => panic!("Unexpected event"),
8896 // Note that at this point users of a standard PeerHandler will end up calling
8897 // peer_disconnected with no_connection_possible set to false, duplicating the
8898 // close-all-channels logic. That's OK, we don't want to end up not force-closing channels for
8899 // users with their own peer handling logic. We duplicate the call here, however.
8900 assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
8901 assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
8903 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), true);
8904 assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
8905 assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);