1 //! Tests that test standing up a network of ChannelManagers, creating channels, sending
2 //! payments/messages between them, and often checking the resulting ChannelMonitors are able to
3 //! claim outputs on-chain.
6 use chain::transaction::OutPoint;
7 use chain::keysinterface::{ChannelKeys, KeysInterface, SpendableOutputDescriptor};
8 use ln::channel::{COMMITMENT_TX_BASE_WEIGHT, COMMITMENT_TX_WEIGHT_PER_HTLC};
9 use ln::channelmanager::{ChannelManager,ChannelManagerReadArgs,HTLCForwardInfo,RAACommitmentOrder, PaymentPreimage, PaymentHash, PaymentSecret, PaymentSendFailure, BREAKDOWN_TIMEOUT};
10 use ln::channelmonitor::{ChannelMonitor, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY};
11 use ln::channelmonitor;
12 use ln::channel::{Channel, ChannelError};
13 use ln::{chan_utils, onion_utils};
14 use routing::router::{Route, RouteHop, get_route};
15 use ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
17 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler,HTLCFailChannelUpdate, ErrorAction, OptionalField};
18 use util::enforcing_trait_impls::EnforcingChannelKeys;
19 use util::{byte_utils, test_utils};
20 use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
21 use util::errors::APIError;
22 use util::ser::{Writeable, Writer, ReadableArgs, Readable};
23 use util::config::UserConfig;
25 use bitcoin::util::hash::BitcoinHash;
26 use bitcoin::hashes::sha256d::Hash as Sha256dHash;
27 use bitcoin::hashes::HashEngine;
28 use bitcoin::hash_types::{Txid, BlockHash, WPubkeyHash};
29 use bitcoin::util::bip143;
30 use bitcoin::util::address::Address;
31 use bitcoin::util::bip32::{ChildNumber, ExtendedPubKey, ExtendedPrivKey};
32 use bitcoin::blockdata::block::{Block, BlockHeader};
33 use bitcoin::blockdata::transaction::{Transaction, TxOut, TxIn, SigHashType, OutPoint as BitcoinOutPoint};
34 use bitcoin::blockdata::script::{Builder, Script};
35 use bitcoin::blockdata::opcodes;
36 use bitcoin::blockdata::constants::genesis_block;
37 use bitcoin::network::constants::Network;
39 use bitcoin::hashes::sha256::Hash as Sha256;
40 use bitcoin::hashes::Hash;
42 use bitcoin::secp256k1::{Secp256k1, Message};
43 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
47 use std::collections::{BTreeSet, HashMap, HashSet};
48 use std::default::Default;
49 use std::sync::{Arc, Mutex};
50 use std::sync::atomic::Ordering;
53 use ln::functional_test_utils::*;
56 fn test_insane_channel_opens() {
57 // Stand up a network of 2 nodes
58 let chanmon_cfgs = create_chanmon_cfgs(2);
59 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
60 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
61 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
63 // Instantiate channel parameters where we push the maximum msats given our
65 let channel_value_sat = 31337; // same as funding satoshis
66 let channel_reserve_satoshis = Channel::<EnforcingChannelKeys>::get_remote_channel_reserve_satoshis(channel_value_sat);
67 let push_msat = (channel_value_sat - channel_reserve_satoshis) * 1000;
69 // Have node0 initiate a channel to node1 with aforementioned parameters
70 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_sat, push_msat, 42, None).unwrap();
72 // Extract the channel open message from node0 to node1
73 let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
75 // Test helper that asserts we get the correct error string given a mutator
76 // that supposedly makes the channel open message insane
77 let insane_open_helper = |expected_error_str: &str, message_mutator: fn(msgs::OpenChannel) -> msgs::OpenChannel| {
78 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &message_mutator(open_channel_message.clone()));
79 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
80 assert_eq!(msg_events.len(), 1);
81 let expected_regex = regex::Regex::new(expected_error_str).unwrap();
82 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
84 &ErrorAction::SendErrorMessage { .. } => {
85 nodes[1].logger.assert_log_regex("lightning::ln::channelmanager".to_string(), expected_regex, 1);
87 _ => panic!("unexpected event!"),
89 } else { assert!(false); }
92 use ln::channel::MAX_FUNDING_SATOSHIS;
93 use ln::channelmanager::MAX_LOCAL_BREAKDOWN_TIMEOUT;
95 // Test all mutations that would make the channel open message insane
96 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 });
98 insane_open_helper("Bogus channel_reserve_satoshis", |mut msg| { msg.channel_reserve_satoshis = msg.funding_satoshis + 1; msg });
100 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 });
102 insane_open_helper("Peer never wants payout outputs?", |mut msg| { msg.dust_limit_satoshis = msg.funding_satoshis + 1 ; msg });
104 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 });
106 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 });
108 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 });
110 insane_open_helper("0 max_accepted_htlcs makes for a useless channel", |mut msg| { msg.max_accepted_htlcs = 0; msg });
112 insane_open_helper("max_accepted_htlcs was 484. It must not be larger than 483", |mut msg| { msg.max_accepted_htlcs = 484; msg });
116 fn test_async_inbound_update_fee() {
117 let chanmon_cfgs = create_chanmon_cfgs(2);
118 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
119 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
120 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
121 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
122 let logger = test_utils::TestLogger::new();
123 let channel_id = chan.2;
126 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
130 // send (1) commitment_signed -.
131 // <- update_add_htlc/commitment_signed
132 // send (2) RAA (awaiting remote revoke) -.
133 // (1) commitment_signed is delivered ->
134 // .- send (3) RAA (awaiting remote revoke)
135 // (2) RAA is delivered ->
136 // .- send (4) commitment_signed
137 // <- (3) RAA is delivered
138 // send (5) commitment_signed -.
139 // <- (4) commitment_signed is delivered
141 // (5) commitment_signed is delivered ->
143 // (6) RAA is delivered ->
145 // First nodes[0] generates an update_fee
146 nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
147 check_added_monitors!(nodes[0], 1);
149 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
150 assert_eq!(events_0.len(), 1);
151 let (update_msg, commitment_signed) = match events_0[0] { // (1)
152 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
153 (update_fee.as_ref(), commitment_signed)
155 _ => panic!("Unexpected event"),
158 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
160 // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
161 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
162 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
163 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();
164 check_added_monitors!(nodes[1], 1);
166 let payment_event = {
167 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
168 assert_eq!(events_1.len(), 1);
169 SendEvent::from_event(events_1.remove(0))
171 assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
172 assert_eq!(payment_event.msgs.len(), 1);
174 // ...now when the messages get delivered everyone should be happy
175 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
176 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
177 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
178 // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
179 check_added_monitors!(nodes[0], 1);
181 // deliver(1), generate (3):
182 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
183 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
184 // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
185 check_added_monitors!(nodes[1], 1);
187 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack); // deliver (2)
188 let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
189 assert!(bs_update.update_add_htlcs.is_empty()); // (4)
190 assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
191 assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
192 assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
193 assert!(bs_update.update_fee.is_none()); // (4)
194 check_added_monitors!(nodes[1], 1);
196 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack); // deliver (3)
197 let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
198 assert!(as_update.update_add_htlcs.is_empty()); // (5)
199 assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
200 assert!(as_update.update_fail_htlcs.is_empty()); // (5)
201 assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
202 assert!(as_update.update_fee.is_none()); // (5)
203 check_added_monitors!(nodes[0], 1);
205 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed); // deliver (4)
206 let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
207 // only (6) so get_event_msg's assert(len == 1) passes
208 check_added_monitors!(nodes[0], 1);
210 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed); // deliver (5)
211 let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
212 check_added_monitors!(nodes[1], 1);
214 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
215 check_added_monitors!(nodes[0], 1);
217 let events_2 = nodes[0].node.get_and_clear_pending_events();
218 assert_eq!(events_2.len(), 1);
220 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
221 _ => panic!("Unexpected event"),
224 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke); // deliver (6)
225 check_added_monitors!(nodes[1], 1);
229 fn test_update_fee_unordered_raa() {
230 // Just the intro to the previous test followed by an out-of-order RAA (which caused a
231 // crash in an earlier version of the update_fee patch)
232 let chanmon_cfgs = create_chanmon_cfgs(2);
233 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
234 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
235 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
236 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
237 let channel_id = chan.2;
238 let logger = test_utils::TestLogger::new();
241 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
243 // First nodes[0] generates an update_fee
244 nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
245 check_added_monitors!(nodes[0], 1);
247 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
248 assert_eq!(events_0.len(), 1);
249 let update_msg = match events_0[0] { // (1)
250 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
253 _ => panic!("Unexpected event"),
256 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
258 // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
259 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
260 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
261 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();
262 check_added_monitors!(nodes[1], 1);
264 let payment_event = {
265 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
266 assert_eq!(events_1.len(), 1);
267 SendEvent::from_event(events_1.remove(0))
269 assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
270 assert_eq!(payment_event.msgs.len(), 1);
272 // ...now when the messages get delivered everyone should be happy
273 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
274 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
275 let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
276 // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
277 check_added_monitors!(nodes[0], 1);
279 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg); // deliver (2)
280 check_added_monitors!(nodes[1], 1);
282 // We can't continue, sadly, because our (1) now has a bogus signature
286 fn test_multi_flight_update_fee() {
287 let chanmon_cfgs = create_chanmon_cfgs(2);
288 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
289 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
290 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
291 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
292 let channel_id = chan.2;
295 // update_fee/commitment_signed ->
296 // .- send (1) RAA and (2) commitment_signed
297 // update_fee (never committed) ->
299 // We have to manually generate the above update_fee, it is allowed by the protocol but we
300 // don't track which updates correspond to which revoke_and_ack responses so we're in
301 // AwaitingRAA mode and will not generate the update_fee yet.
302 // <- (1) RAA delivered
303 // (3) is generated and send (4) CS -.
304 // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
305 // know the per_commitment_point to use for it.
306 // <- (2) commitment_signed delivered
308 // B should send no response here
309 // (4) commitment_signed delivered ->
310 // <- RAA/commitment_signed delivered
313 // First nodes[0] generates an update_fee
314 let initial_feerate = get_feerate!(nodes[0], channel_id);
315 nodes[0].node.update_fee(channel_id, initial_feerate + 20).unwrap();
316 check_added_monitors!(nodes[0], 1);
318 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
319 assert_eq!(events_0.len(), 1);
320 let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
321 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
322 (update_fee.as_ref().unwrap(), commitment_signed)
324 _ => panic!("Unexpected event"),
327 // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
328 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1);
329 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1);
330 let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
331 check_added_monitors!(nodes[1], 1);
333 // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
335 nodes[0].node.update_fee(channel_id, initial_feerate + 40).unwrap();
336 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
337 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
339 // Create the (3) update_fee message that nodes[0] will generate before it does...
340 let mut update_msg_2 = msgs::UpdateFee {
341 channel_id: update_msg_1.channel_id.clone(),
342 feerate_per_kw: (initial_feerate + 30) as u32,
345 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
347 update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
349 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
351 // Deliver (1), generating (3) and (4)
352 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg);
353 let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
354 check_added_monitors!(nodes[0], 1);
355 assert!(as_second_update.update_add_htlcs.is_empty());
356 assert!(as_second_update.update_fulfill_htlcs.is_empty());
357 assert!(as_second_update.update_fail_htlcs.is_empty());
358 assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
359 // Check that the update_fee newly generated matches what we delivered:
360 assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
361 assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
363 // Deliver (2) commitment_signed
364 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
365 let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
366 check_added_monitors!(nodes[0], 1);
367 // No commitment_signed so get_event_msg's assert(len == 1) passes
369 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg);
370 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
371 check_added_monitors!(nodes[1], 1);
374 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
375 let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
376 check_added_monitors!(nodes[1], 1);
378 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
379 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
380 check_added_monitors!(nodes[0], 1);
382 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment);
383 let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
384 // No commitment_signed so get_event_msg's assert(len == 1) passes
385 check_added_monitors!(nodes[0], 1);
387 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke);
388 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
389 check_added_monitors!(nodes[1], 1);
393 fn test_1_conf_open() {
394 // Previously, if the minium_depth config was set to 1, we'd never send a funding_locked. This
395 // tests that we properly send one in that case.
396 let mut alice_config = UserConfig::default();
397 alice_config.own_channel_config.minimum_depth = 1;
398 alice_config.channel_options.announced_channel = true;
399 alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
400 let mut bob_config = UserConfig::default();
401 bob_config.own_channel_config.minimum_depth = 1;
402 bob_config.channel_options.announced_channel = true;
403 bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
404 let chanmon_cfgs = create_chanmon_cfgs(2);
405 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
406 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(alice_config), Some(bob_config)]);
407 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
409 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
411 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
414 connect_block(&nodes[1], &block, 1);
415 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()));
417 connect_block(&nodes[0], &block, 1);
418 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
419 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
422 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
423 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
424 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
428 fn do_test_sanity_on_in_flight_opens(steps: u8) {
429 // Previously, we had issues deserializing channels when we hadn't connected the first block
430 // after creation. To catch that and similar issues, we lean on the Node::drop impl to test
431 // serialization round-trips and simply do steps towards opening a channel and then drop the
434 let chanmon_cfgs = create_chanmon_cfgs(2);
435 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
436 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
437 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
439 if steps & 0b1000_0000 != 0{
441 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
444 connect_block(&nodes[0], &block, 1);
445 connect_block(&nodes[1], &block, 1);
448 if steps & 0x0f == 0 { return; }
449 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
450 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
452 if steps & 0x0f == 1 { return; }
453 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
454 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
456 if steps & 0x0f == 2 { return; }
457 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
459 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
461 if steps & 0x0f == 3 { return; }
462 nodes[0].node.funding_transaction_generated(&temporary_channel_id, funding_output);
463 check_added_monitors!(nodes[0], 0);
464 let funding_created = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
466 if steps & 0x0f == 4 { return; }
467 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
469 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
470 assert_eq!(added_monitors.len(), 1);
471 assert_eq!(added_monitors[0].0, funding_output);
472 added_monitors.clear();
474 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
476 if steps & 0x0f == 5 { return; }
477 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
479 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
480 assert_eq!(added_monitors.len(), 1);
481 assert_eq!(added_monitors[0].0, funding_output);
482 added_monitors.clear();
485 let events_4 = nodes[0].node.get_and_clear_pending_events();
486 assert_eq!(events_4.len(), 1);
488 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
489 assert_eq!(user_channel_id, 42);
490 assert_eq!(*funding_txo, funding_output);
492 _ => panic!("Unexpected event"),
495 if steps & 0x0f == 6 { return; }
496 create_chan_between_nodes_with_value_confirm_first(&nodes[0], &nodes[1], &tx);
498 if steps & 0x0f == 7 { return; }
499 confirm_transaction(&nodes[0], &tx);
500 create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
504 fn test_sanity_on_in_flight_opens() {
505 do_test_sanity_on_in_flight_opens(0);
506 do_test_sanity_on_in_flight_opens(0 | 0b1000_0000);
507 do_test_sanity_on_in_flight_opens(1);
508 do_test_sanity_on_in_flight_opens(1 | 0b1000_0000);
509 do_test_sanity_on_in_flight_opens(2);
510 do_test_sanity_on_in_flight_opens(2 | 0b1000_0000);
511 do_test_sanity_on_in_flight_opens(3);
512 do_test_sanity_on_in_flight_opens(3 | 0b1000_0000);
513 do_test_sanity_on_in_flight_opens(4);
514 do_test_sanity_on_in_flight_opens(4 | 0b1000_0000);
515 do_test_sanity_on_in_flight_opens(5);
516 do_test_sanity_on_in_flight_opens(5 | 0b1000_0000);
517 do_test_sanity_on_in_flight_opens(6);
518 do_test_sanity_on_in_flight_opens(6 | 0b1000_0000);
519 do_test_sanity_on_in_flight_opens(7);
520 do_test_sanity_on_in_flight_opens(7 | 0b1000_0000);
521 do_test_sanity_on_in_flight_opens(8);
522 do_test_sanity_on_in_flight_opens(8 | 0b1000_0000);
526 fn test_update_fee_vanilla() {
527 let chanmon_cfgs = create_chanmon_cfgs(2);
528 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
529 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
530 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
531 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
532 let channel_id = chan.2;
534 let feerate = get_feerate!(nodes[0], channel_id);
535 nodes[0].node.update_fee(channel_id, feerate+25).unwrap();
536 check_added_monitors!(nodes[0], 1);
538 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
539 assert_eq!(events_0.len(), 1);
540 let (update_msg, commitment_signed) = match events_0[0] {
541 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 } } => {
542 (update_fee.as_ref(), commitment_signed)
544 _ => panic!("Unexpected event"),
546 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
548 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
549 let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
550 check_added_monitors!(nodes[1], 1);
552 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
553 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
554 check_added_monitors!(nodes[0], 1);
556 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
557 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
558 // No commitment_signed so get_event_msg's assert(len == 1) passes
559 check_added_monitors!(nodes[0], 1);
561 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
562 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
563 check_added_monitors!(nodes[1], 1);
567 fn test_update_fee_that_funder_cannot_afford() {
568 let chanmon_cfgs = create_chanmon_cfgs(2);
569 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
570 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
571 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
572 let channel_value = 1888;
573 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000, InitFeatures::known(), InitFeatures::known());
574 let channel_id = chan.2;
577 nodes[0].node.update_fee(channel_id, feerate).unwrap();
578 check_added_monitors!(nodes[0], 1);
579 let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
581 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap());
583 commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
585 //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
586 //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
588 let commitment_tx = get_local_commitment_txn!(nodes[1], channel_id)[0].clone();
590 //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
591 let num_htlcs = commitment_tx.output.len() - 2;
592 let total_fee: u64 = feerate as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
593 let mut actual_fee = commitment_tx.output.iter().fold(0, |acc, output| acc + output.value);
594 actual_fee = channel_value - actual_fee;
595 assert_eq!(total_fee, actual_fee);
598 //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
599 //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
600 nodes[0].node.update_fee(channel_id, feerate+2).unwrap();
601 check_added_monitors!(nodes[0], 1);
603 let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
605 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap());
607 //While producing the commitment_signed response after handling a received update_fee request the
608 //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
609 //Should produce and error.
610 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed);
611 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Funding remote cannot afford proposed new fee".to_string(), 1);
612 check_added_monitors!(nodes[1], 1);
613 check_closed_broadcast!(nodes[1], true);
617 fn test_update_fee_with_fundee_update_add_htlc() {
618 let chanmon_cfgs = create_chanmon_cfgs(2);
619 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
620 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
621 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
622 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
623 let channel_id = chan.2;
624 let logger = test_utils::TestLogger::new();
627 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
629 let feerate = get_feerate!(nodes[0], channel_id);
630 nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
631 check_added_monitors!(nodes[0], 1);
633 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
634 assert_eq!(events_0.len(), 1);
635 let (update_msg, commitment_signed) = match events_0[0] {
636 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 } } => {
637 (update_fee.as_ref(), commitment_signed)
639 _ => panic!("Unexpected event"),
641 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
642 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
643 let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
644 check_added_monitors!(nodes[1], 1);
646 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[1]);
647 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
648 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();
650 // nothing happens since node[1] is in AwaitingRemoteRevoke
651 nodes[1].node.send_payment(&route, our_payment_hash, &None).unwrap();
653 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
654 assert_eq!(added_monitors.len(), 0);
655 added_monitors.clear();
657 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
658 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
659 // node[1] has nothing to do
661 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
662 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
663 check_added_monitors!(nodes[0], 1);
665 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
666 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
667 // No commitment_signed so get_event_msg's assert(len == 1) passes
668 check_added_monitors!(nodes[0], 1);
669 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
670 check_added_monitors!(nodes[1], 1);
671 // AwaitingRemoteRevoke ends here
673 let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
674 assert_eq!(commitment_update.update_add_htlcs.len(), 1);
675 assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
676 assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
677 assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
678 assert_eq!(commitment_update.update_fee.is_none(), true);
680 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]);
681 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
682 check_added_monitors!(nodes[0], 1);
683 let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
685 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke);
686 check_added_monitors!(nodes[1], 1);
687 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
689 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
690 check_added_monitors!(nodes[1], 1);
691 let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
692 // No commitment_signed so get_event_msg's assert(len == 1) passes
694 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke);
695 check_added_monitors!(nodes[0], 1);
696 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
698 expect_pending_htlcs_forwardable!(nodes[0]);
700 let events = nodes[0].node.get_and_clear_pending_events();
701 assert_eq!(events.len(), 1);
703 Event::PaymentReceived { .. } => { },
704 _ => panic!("Unexpected event"),
707 claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage, 800_000);
709 send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000, 800_000);
710 send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000, 800_000);
711 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
715 fn test_update_fee() {
716 let chanmon_cfgs = create_chanmon_cfgs(2);
717 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
718 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
719 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
720 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
721 let channel_id = chan.2;
724 // (1) update_fee/commitment_signed ->
725 // <- (2) revoke_and_ack
726 // .- send (3) commitment_signed
727 // (4) update_fee/commitment_signed ->
728 // .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
729 // <- (3) commitment_signed delivered
730 // send (6) revoke_and_ack -.
731 // <- (5) deliver revoke_and_ack
732 // (6) deliver revoke_and_ack ->
733 // .- send (7) commitment_signed in response to (4)
734 // <- (7) deliver commitment_signed
737 // Create and deliver (1)...
738 let feerate = get_feerate!(nodes[0], channel_id);
739 nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
740 check_added_monitors!(nodes[0], 1);
742 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
743 assert_eq!(events_0.len(), 1);
744 let (update_msg, commitment_signed) = match events_0[0] {
745 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 } } => {
746 (update_fee.as_ref(), commitment_signed)
748 _ => panic!("Unexpected event"),
750 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
752 // Generate (2) and (3):
753 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
754 let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
755 check_added_monitors!(nodes[1], 1);
758 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
759 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
760 check_added_monitors!(nodes[0], 1);
762 // Create and deliver (4)...
763 nodes[0].node.update_fee(channel_id, feerate+30).unwrap();
764 check_added_monitors!(nodes[0], 1);
765 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
766 assert_eq!(events_0.len(), 1);
767 let (update_msg, commitment_signed) = match events_0[0] {
768 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 } } => {
769 (update_fee.as_ref(), commitment_signed)
771 _ => panic!("Unexpected event"),
774 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
775 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
776 check_added_monitors!(nodes[1], 1);
778 let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
779 // No commitment_signed so get_event_msg's assert(len == 1) passes
781 // Handle (3), creating (6):
782 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0);
783 check_added_monitors!(nodes[0], 1);
784 let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
785 // No commitment_signed so get_event_msg's assert(len == 1) passes
788 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
789 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
790 check_added_monitors!(nodes[0], 1);
792 // Deliver (6), creating (7):
793 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0);
794 let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
795 assert!(commitment_update.update_add_htlcs.is_empty());
796 assert!(commitment_update.update_fulfill_htlcs.is_empty());
797 assert!(commitment_update.update_fail_htlcs.is_empty());
798 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
799 assert!(commitment_update.update_fee.is_none());
800 check_added_monitors!(nodes[1], 1);
803 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
804 check_added_monitors!(nodes[0], 1);
805 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
806 // No commitment_signed so get_event_msg's assert(len == 1) passes
808 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
809 check_added_monitors!(nodes[1], 1);
810 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
812 assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
813 assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
814 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
818 fn pre_funding_lock_shutdown_test() {
819 // Test sending a shutdown prior to funding_locked after funding generation
820 let chanmon_cfgs = create_chanmon_cfgs(2);
821 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
822 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
823 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
824 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0, InitFeatures::known(), InitFeatures::known());
825 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
826 connect_block(&nodes[0], &Block { header, txdata: vec![tx.clone()]}, 1);
827 connect_block(&nodes[1], &Block { header, txdata: vec![tx.clone()]}, 1);
829 nodes[0].node.close_channel(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id()).unwrap();
830 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
831 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
832 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
833 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
835 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
836 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
837 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
838 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
839 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
840 assert!(node_0_none.is_none());
842 assert!(nodes[0].node.list_channels().is_empty());
843 assert!(nodes[1].node.list_channels().is_empty());
847 fn updates_shutdown_wait() {
848 // Test sending a shutdown with outstanding updates pending
849 let chanmon_cfgs = create_chanmon_cfgs(3);
850 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
851 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
852 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
853 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
854 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
855 let logger = test_utils::TestLogger::new();
857 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
859 nodes[0].node.close_channel(&chan_1.2).unwrap();
860 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
861 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
862 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
863 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
865 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
866 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
868 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
870 let net_graph_msg_handler0 = &nodes[0].net_graph_msg_handler;
871 let net_graph_msg_handler1 = &nodes[1].net_graph_msg_handler;
872 let route_1 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler0.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
873 let route_2 = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler1.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
874 unwrap_send_err!(nodes[0].node.send_payment(&route_1, payment_hash, &None), true, APIError::ChannelUnavailable {..}, {});
875 unwrap_send_err!(nodes[1].node.send_payment(&route_2, payment_hash, &None), true, APIError::ChannelUnavailable {..}, {});
877 assert!(nodes[2].node.claim_funds(our_payment_preimage, &None, 100_000));
878 check_added_monitors!(nodes[2], 1);
879 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
880 assert!(updates.update_add_htlcs.is_empty());
881 assert!(updates.update_fail_htlcs.is_empty());
882 assert!(updates.update_fail_malformed_htlcs.is_empty());
883 assert!(updates.update_fee.is_none());
884 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
885 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
886 check_added_monitors!(nodes[1], 1);
887 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
888 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
890 assert!(updates_2.update_add_htlcs.is_empty());
891 assert!(updates_2.update_fail_htlcs.is_empty());
892 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
893 assert!(updates_2.update_fee.is_none());
894 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
895 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
896 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
898 let events = nodes[0].node.get_and_clear_pending_events();
899 assert_eq!(events.len(), 1);
901 Event::PaymentSent { ref payment_preimage } => {
902 assert_eq!(our_payment_preimage, *payment_preimage);
904 _ => panic!("Unexpected event"),
907 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
908 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
909 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
910 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
911 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
912 assert!(node_0_none.is_none());
914 assert!(nodes[0].node.list_channels().is_empty());
916 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
917 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
918 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
919 assert!(nodes[1].node.list_channels().is_empty());
920 assert!(nodes[2].node.list_channels().is_empty());
924 fn htlc_fail_async_shutdown() {
925 // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
926 let chanmon_cfgs = create_chanmon_cfgs(3);
927 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
928 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
929 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
930 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
931 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
932 let logger = test_utils::TestLogger::new();
934 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
935 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
936 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
937 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
938 check_added_monitors!(nodes[0], 1);
939 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
940 assert_eq!(updates.update_add_htlcs.len(), 1);
941 assert!(updates.update_fulfill_htlcs.is_empty());
942 assert!(updates.update_fail_htlcs.is_empty());
943 assert!(updates.update_fail_malformed_htlcs.is_empty());
944 assert!(updates.update_fee.is_none());
946 nodes[1].node.close_channel(&chan_1.2).unwrap();
947 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
948 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
949 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
951 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
952 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
953 check_added_monitors!(nodes[1], 1);
954 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
955 commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
957 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
958 assert!(updates_2.update_add_htlcs.is_empty());
959 assert!(updates_2.update_fulfill_htlcs.is_empty());
960 assert_eq!(updates_2.update_fail_htlcs.len(), 1);
961 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
962 assert!(updates_2.update_fee.is_none());
964 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
965 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
967 expect_payment_failed!(nodes[0], our_payment_hash, false);
969 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
970 assert_eq!(msg_events.len(), 2);
971 let node_0_closing_signed = match msg_events[0] {
972 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
973 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
976 _ => panic!("Unexpected event"),
978 match msg_events[1] {
979 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
980 assert_eq!(msg.contents.short_channel_id, chan_1.0.contents.short_channel_id);
982 _ => panic!("Unexpected event"),
985 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
986 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
987 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
988 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
989 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
990 assert!(node_0_none.is_none());
992 assert!(nodes[0].node.list_channels().is_empty());
994 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
995 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
996 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
997 assert!(nodes[1].node.list_channels().is_empty());
998 assert!(nodes[2].node.list_channels().is_empty());
1001 fn do_test_shutdown_rebroadcast(recv_count: u8) {
1002 // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
1003 // messages delivered prior to disconnect
1004 let chanmon_cfgs = create_chanmon_cfgs(3);
1005 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1006 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1007 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1008 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1009 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1011 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
1013 nodes[1].node.close_channel(&chan_1.2).unwrap();
1014 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1016 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
1017 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1019 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
1023 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1024 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1026 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1027 let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1028 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1029 let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1031 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
1032 let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1033 assert!(node_1_shutdown == node_1_2nd_shutdown);
1035 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
1036 let node_0_2nd_shutdown = if recv_count > 0 {
1037 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1038 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
1041 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1042 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
1043 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
1045 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_2nd_shutdown);
1047 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1048 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1050 assert!(nodes[2].node.claim_funds(our_payment_preimage, &None, 100_000));
1051 check_added_monitors!(nodes[2], 1);
1052 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1053 assert!(updates.update_add_htlcs.is_empty());
1054 assert!(updates.update_fail_htlcs.is_empty());
1055 assert!(updates.update_fail_malformed_htlcs.is_empty());
1056 assert!(updates.update_fee.is_none());
1057 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1058 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1059 check_added_monitors!(nodes[1], 1);
1060 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1061 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1063 assert!(updates_2.update_add_htlcs.is_empty());
1064 assert!(updates_2.update_fail_htlcs.is_empty());
1065 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
1066 assert!(updates_2.update_fee.is_none());
1067 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
1068 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
1069 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
1071 let events = nodes[0].node.get_and_clear_pending_events();
1072 assert_eq!(events.len(), 1);
1074 Event::PaymentSent { ref payment_preimage } => {
1075 assert_eq!(our_payment_preimage, *payment_preimage);
1077 _ => panic!("Unexpected event"),
1080 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1082 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1083 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1084 assert!(node_1_closing_signed.is_some());
1087 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1088 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1090 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1091 let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1092 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1093 if recv_count == 0 {
1094 // If all closing_signeds weren't delivered we can just resume where we left off...
1095 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1097 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
1098 let node_0_3rd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1099 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
1101 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1102 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1103 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
1105 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_3rd_shutdown);
1106 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1108 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_3rd_shutdown);
1109 let node_0_2nd_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1110 assert!(node_0_closing_signed == node_0_2nd_closing_signed);
1112 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
1113 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1114 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
1115 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1116 assert!(node_0_none.is_none());
1118 // If one node, however, received + responded with an identical closing_signed we end
1119 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
1120 // There isn't really anything better we can do simply, but in the future we might
1121 // explore storing a set of recently-closed channels that got disconnected during
1122 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
1123 // give our counterparty enough time to (potentially) broadcast a cooperative closing
1125 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1127 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1128 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
1129 assert_eq!(msg_events.len(), 1);
1130 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
1132 &ErrorAction::SendErrorMessage { ref msg } => {
1133 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msg);
1134 assert_eq!(msg.channel_id, chan_1.2);
1136 _ => panic!("Unexpected event!"),
1138 } else { panic!("Needed SendErrorMessage close"); }
1140 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
1141 // checks it, but in this case nodes[0] didn't ever get a chance to receive a
1142 // closing_signed so we do it ourselves
1143 check_closed_broadcast!(nodes[0], false);
1144 check_added_monitors!(nodes[0], 1);
1147 assert!(nodes[0].node.list_channels().is_empty());
1149 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1150 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1151 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1152 assert!(nodes[1].node.list_channels().is_empty());
1153 assert!(nodes[2].node.list_channels().is_empty());
1157 fn test_shutdown_rebroadcast() {
1158 do_test_shutdown_rebroadcast(0);
1159 do_test_shutdown_rebroadcast(1);
1160 do_test_shutdown_rebroadcast(2);
1164 fn fake_network_test() {
1165 // Simple test which builds a network of ChannelManagers, connects them to each other, and
1166 // tests that payments get routed and transactions broadcast in semi-reasonable ways.
1167 let chanmon_cfgs = create_chanmon_cfgs(4);
1168 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1169 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1170 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1172 // Create some initial channels
1173 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1174 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1175 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1177 // Rebalance the network a bit by relaying one payment through all the channels...
1178 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1179 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1180 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1181 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1183 // Send some more payments
1184 send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000, 1_000_000);
1185 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000, 1_000_000);
1186 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000, 1_000_000);
1188 // Test failure packets
1189 let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
1190 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
1192 // Add a new channel that skips 3
1193 let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1195 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000, 1_000_000);
1196 send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000, 1_000_000);
1197 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1198 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1199 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1200 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1201 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1203 // Do some rebalance loop payments, simultaneously
1204 let mut hops = Vec::with_capacity(3);
1205 hops.push(RouteHop {
1206 pubkey: nodes[2].node.get_our_node_id(),
1207 node_features: NodeFeatures::empty(),
1208 short_channel_id: chan_2.0.contents.short_channel_id,
1209 channel_features: ChannelFeatures::empty(),
1211 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
1213 hops.push(RouteHop {
1214 pubkey: nodes[3].node.get_our_node_id(),
1215 node_features: NodeFeatures::empty(),
1216 short_channel_id: chan_3.0.contents.short_channel_id,
1217 channel_features: ChannelFeatures::empty(),
1219 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
1221 hops.push(RouteHop {
1222 pubkey: nodes[1].node.get_our_node_id(),
1223 node_features: NodeFeatures::empty(),
1224 short_channel_id: chan_4.0.contents.short_channel_id,
1225 channel_features: ChannelFeatures::empty(),
1227 cltv_expiry_delta: TEST_FINAL_CLTV,
1229 hops[1].fee_msat = chan_4.1.contents.fee_base_msat as u64 + chan_4.1.contents.fee_proportional_millionths as u64 * hops[2].fee_msat as u64 / 1000000;
1230 hops[0].fee_msat = chan_3.0.contents.fee_base_msat as u64 + chan_3.0.contents.fee_proportional_millionths as u64 * hops[1].fee_msat as u64 / 1000000;
1231 let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
1233 let mut hops = Vec::with_capacity(3);
1234 hops.push(RouteHop {
1235 pubkey: nodes[3].node.get_our_node_id(),
1236 node_features: NodeFeatures::empty(),
1237 short_channel_id: chan_4.0.contents.short_channel_id,
1238 channel_features: ChannelFeatures::empty(),
1240 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
1242 hops.push(RouteHop {
1243 pubkey: nodes[2].node.get_our_node_id(),
1244 node_features: NodeFeatures::empty(),
1245 short_channel_id: chan_3.0.contents.short_channel_id,
1246 channel_features: ChannelFeatures::empty(),
1248 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
1250 hops.push(RouteHop {
1251 pubkey: nodes[1].node.get_our_node_id(),
1252 node_features: NodeFeatures::empty(),
1253 short_channel_id: chan_2.0.contents.short_channel_id,
1254 channel_features: ChannelFeatures::empty(),
1256 cltv_expiry_delta: TEST_FINAL_CLTV,
1258 hops[1].fee_msat = chan_2.1.contents.fee_base_msat as u64 + chan_2.1.contents.fee_proportional_millionths as u64 * hops[2].fee_msat as u64 / 1000000;
1259 hops[0].fee_msat = chan_3.1.contents.fee_base_msat as u64 + chan_3.1.contents.fee_proportional_millionths as u64 * hops[1].fee_msat as u64 / 1000000;
1260 let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1262 // Claim the rebalances...
1263 fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1264 claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1, 1_000_000);
1266 // Add a duplicate new channel from 2 to 4
1267 let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1269 // Send some payments across both channels
1270 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1271 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1272 let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1275 route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
1276 let events = nodes[0].node.get_and_clear_pending_msg_events();
1277 assert_eq!(events.len(), 0);
1278 nodes[0].logger.assert_log_regex("lightning::ln::channelmanager".to_string(), regex::Regex::new(r"Cannot send value that would put us over the max HTLC value in flight our peer will accept \(\d+\)").unwrap(), 1);
1280 //TODO: Test that routes work again here as we've been notified that the channel is full
1282 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3, 3_000_000);
1283 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4, 3_000_000);
1284 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5, 3_000_000);
1286 // Close down the channels...
1287 close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1288 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1289 close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1290 close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1291 close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
1295 fn holding_cell_htlc_counting() {
1296 // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1297 // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1298 // commitment dance rounds.
1299 let chanmon_cfgs = create_chanmon_cfgs(3);
1300 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1301 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1302 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1303 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1304 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1305 let logger = test_utils::TestLogger::new();
1307 let mut payments = Vec::new();
1308 for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1309 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1310 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1311 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1312 nodes[1].node.send_payment(&route, payment_hash, &None).unwrap();
1313 payments.push((payment_preimage, payment_hash));
1315 check_added_monitors!(nodes[1], 1);
1317 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1318 assert_eq!(events.len(), 1);
1319 let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1320 assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1322 // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1323 // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1325 let (_, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
1327 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1328 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1329 unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash_1, &None), true, APIError::ChannelUnavailable { ref err },
1330 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
1331 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1332 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1335 // This should also be true if we try to forward a payment.
1336 let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
1338 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1339 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1340 nodes[0].node.send_payment(&route, payment_hash_2, &None).unwrap();
1341 check_added_monitors!(nodes[0], 1);
1344 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1345 assert_eq!(events.len(), 1);
1346 let payment_event = SendEvent::from_event(events.pop().unwrap());
1347 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1349 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1350 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1351 // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1352 // fails), the second will process the resulting failure and fail the HTLC backward.
1353 expect_pending_htlcs_forwardable!(nodes[1]);
1354 expect_pending_htlcs_forwardable!(nodes[1]);
1355 check_added_monitors!(nodes[1], 1);
1357 let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1358 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1359 commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1361 let events = nodes[0].node.get_and_clear_pending_msg_events();
1362 assert_eq!(events.len(), 1);
1364 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
1365 assert_eq!(msg.contents.short_channel_id, chan_2.0.contents.short_channel_id);
1367 _ => panic!("Unexpected event"),
1370 expect_payment_failed!(nodes[0], payment_hash_2, false);
1372 // Now forward all the pending HTLCs and claim them back
1373 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1374 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1375 check_added_monitors!(nodes[2], 1);
1377 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1378 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1379 check_added_monitors!(nodes[1], 1);
1380 let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1382 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1383 check_added_monitors!(nodes[1], 1);
1384 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1386 for ref update in as_updates.update_add_htlcs.iter() {
1387 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1389 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1390 check_added_monitors!(nodes[2], 1);
1391 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1392 check_added_monitors!(nodes[2], 1);
1393 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1395 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1396 check_added_monitors!(nodes[1], 1);
1397 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1398 check_added_monitors!(nodes[1], 1);
1399 let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1401 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1402 check_added_monitors!(nodes[2], 1);
1404 expect_pending_htlcs_forwardable!(nodes[2]);
1406 let events = nodes[2].node.get_and_clear_pending_events();
1407 assert_eq!(events.len(), payments.len());
1408 for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1410 &Event::PaymentReceived { ref payment_hash, .. } => {
1411 assert_eq!(*payment_hash, *hash);
1413 _ => panic!("Unexpected event"),
1417 for (preimage, _) in payments.drain(..) {
1418 claim_payment(&nodes[1], &[&nodes[2]], preimage, 100_000);
1421 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000, 1_000_000);
1425 fn duplicate_htlc_test() {
1426 // Test that we accept duplicate payment_hash HTLCs across the network and that
1427 // claiming/failing them are all separate and don't affect each other
1428 let chanmon_cfgs = create_chanmon_cfgs(6);
1429 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1430 let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1431 let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1433 // Create some initial channels to route via 3 to 4/5 from 0/1/2
1434 create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
1435 create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1436 create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1437 create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
1438 create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
1440 let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1442 *nodes[0].network_payment_count.borrow_mut() -= 1;
1443 assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1445 *nodes[0].network_payment_count.borrow_mut() -= 1;
1446 assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1448 claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage, 1_000_000);
1449 fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1450 claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage, 1_000_000);
1454 fn test_duplicate_htlc_different_direction_onchain() {
1455 // Test that ChannelMonitor doesn't generate 2 preimage txn
1456 // when we have 2 HTLCs with same preimage that go across a node
1457 // in opposite directions.
1458 let chanmon_cfgs = create_chanmon_cfgs(2);
1459 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1460 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1461 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1463 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1464 let logger = test_utils::TestLogger::new();
1467 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
1469 let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1471 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1472 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), None, &Vec::new(), 800_000, TEST_FINAL_CLTV, &logger).unwrap();
1473 send_along_route_with_hash(&nodes[1], route, &vec!(&nodes[0])[..], 800_000, payment_hash);
1475 // Provide preimage to node 0 by claiming payment
1476 nodes[0].node.claim_funds(payment_preimage, &None, 800_000);
1477 check_added_monitors!(nodes[0], 1);
1479 // Broadcast node 1 commitment txn
1480 let remote_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
1482 assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1483 let mut has_both_htlcs = 0; // check htlcs match ones committed
1484 for outp in remote_txn[0].output.iter() {
1485 if outp.value == 800_000 / 1000 {
1486 has_both_htlcs += 1;
1487 } else if outp.value == 900_000 / 1000 {
1488 has_both_htlcs += 1;
1491 assert_eq!(has_both_htlcs, 2);
1493 let header = BlockHeader { version: 0x2000_0000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1494 connect_block(&nodes[0], &Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
1495 check_added_monitors!(nodes[0], 1);
1497 // Check we only broadcast 1 timeout tx
1498 let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1499 let htlc_pair = if claim_txn[0].output[0].value == 800_000 / 1000 { (claim_txn[0].clone(), claim_txn[1].clone()) } else { (claim_txn[1].clone(), claim_txn[0].clone()) };
1500 assert_eq!(claim_txn.len(), 5);
1501 check_spends!(claim_txn[2], chan_1.3);
1502 check_spends!(claim_txn[3], claim_txn[2]);
1503 assert_eq!(htlc_pair.0.input.len(), 1);
1504 assert_eq!(htlc_pair.0.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1505 check_spends!(htlc_pair.0, remote_txn[0]);
1506 assert_eq!(htlc_pair.1.input.len(), 1);
1507 assert_eq!(htlc_pair.1.input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1508 check_spends!(htlc_pair.1, remote_txn[0]);
1510 let events = nodes[0].node.get_and_clear_pending_msg_events();
1511 assert_eq!(events.len(), 2);
1514 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1515 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, .. } } => {
1516 assert!(update_add_htlcs.is_empty());
1517 assert!(update_fail_htlcs.is_empty());
1518 assert_eq!(update_fulfill_htlcs.len(), 1);
1519 assert!(update_fail_malformed_htlcs.is_empty());
1520 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1522 _ => panic!("Unexpected event"),
1528 fn test_basic_channel_reserve() {
1529 let chanmon_cfgs = create_chanmon_cfgs(2);
1530 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1531 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1532 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1533 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1534 let logger = test_utils::TestLogger::new();
1536 let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1537 let channel_reserve = chan_stat.channel_reserve_msat;
1539 // The 2* and +1 are for the fee spike reserve.
1540 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
1541 let commit_tx_fee = 2 * commit_tx_fee_msat(get_feerate!(nodes[0], chan.2), 1 + 1);
1542 let max_can_send = 5000000 - channel_reserve - commit_tx_fee;
1543 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1544 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes.last().unwrap().node.get_our_node_id(), None, &Vec::new(), max_can_send + 1, TEST_FINAL_CLTV, &logger).unwrap();
1545 let err = nodes[0].node.send_payment(&route, our_payment_hash, &None).err().unwrap();
1547 PaymentSendFailure::AllFailedRetrySafe(ref fails) => {
1549 &APIError::ChannelUnavailable{ref err} =>
1550 assert!(regex::Regex::new(r"Cannot send value that would put us under local channel reserve value \(\d+\)").unwrap().is_match(err)),
1551 _ => panic!("Unexpected error variant"),
1554 _ => panic!("Unexpected error variant"),
1556 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1557 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us under local channel reserve value".to_string(), 1);
1559 send_payment(&nodes[0], &vec![&nodes[1]], max_can_send, max_can_send);
1563 fn test_fee_spike_violation_fails_htlc() {
1564 let chanmon_cfgs = create_chanmon_cfgs(2);
1565 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1566 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1567 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1568 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1569 let logger = test_utils::TestLogger::new();
1571 macro_rules! get_route_and_payment_hash {
1572 ($recv_value: expr) => {{
1573 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[1]);
1574 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler.network_graph.read().unwrap();
1575 let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes.last().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1576 (route, payment_hash, payment_preimage)
1580 let (route, payment_hash, _) = get_route_and_payment_hash!(3460001);
1581 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1582 let secp_ctx = Secp256k1::new();
1583 let session_priv = SecretKey::from_slice(&[42; 32]).expect("RNG is bad!");
1585 let cur_height = nodes[1].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1587 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1588 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3460001, &None, cur_height).unwrap();
1589 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1590 let msg = msgs::UpdateAddHTLC {
1593 amount_msat: htlc_msat,
1594 payment_hash: payment_hash,
1595 cltv_expiry: htlc_cltv,
1596 onion_routing_packet: onion_packet,
1599 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1601 // Now manually create the commitment_signed message corresponding to the update_add
1602 // nodes[0] just sent. In the code for construction of this message, "local" refers
1603 // to the sender of the message, and "remote" refers to the receiver.
1605 let feerate_per_kw = get_feerate!(nodes[0], chan.2);
1607 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
1609 // Get the EnforcingChannelKeys for each channel, which will be used to (1) get the keys
1610 // needed to sign the new commitment tx and (2) sign the new commitment tx.
1611 let (local_revocation_basepoint, local_htlc_basepoint, local_payment_point, local_secret, local_secret2) = {
1612 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
1613 let local_chan = chan_lock.by_id.get(&chan.2).unwrap();
1614 let chan_keys = local_chan.get_local_keys();
1615 let pubkeys = chan_keys.pubkeys();
1616 (pubkeys.revocation_basepoint, pubkeys.htlc_basepoint, pubkeys.payment_point,
1617 chan_keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER), chan_keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2))
1619 let (remote_delayed_payment_basepoint, remote_htlc_basepoint, remote_payment_point, remote_secret1) = {
1620 let chan_lock = nodes[1].node.channel_state.lock().unwrap();
1621 let remote_chan = chan_lock.by_id.get(&chan.2).unwrap();
1622 let chan_keys = remote_chan.get_local_keys();
1623 let pubkeys = chan_keys.pubkeys();
1624 (pubkeys.delayed_payment_basepoint, pubkeys.htlc_basepoint, pubkeys.payment_point,
1625 chan_keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 1))
1628 // Assemble the set of keys we can use for signatures for our commitment_signed message.
1629 let commitment_secret = SecretKey::from_slice(&remote_secret1).unwrap();
1630 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &commitment_secret);
1631 let commit_tx_keys = chan_utils::TxCreationKeys::new(&secp_ctx, &per_commitment_point, &remote_delayed_payment_basepoint,
1632 &remote_htlc_basepoint, &local_revocation_basepoint, &local_htlc_basepoint).unwrap();
1634 // Build the remote commitment transaction so we can sign it, and then later use the
1635 // signature for the commitment_signed message.
1636 let local_chan_balance = 1313;
1637 let static_payment_pk = local_payment_point.serialize();
1638 let remote_commit_tx_output = TxOut {
1639 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0)
1640 .push_slice(&WPubkeyHash::hash(&static_payment_pk)[..])
1642 value: local_chan_balance as u64
1645 let local_commit_tx_output = TxOut {
1646 script_pubkey: chan_utils::get_revokeable_redeemscript(&commit_tx_keys.revocation_key,
1648 &commit_tx_keys.a_delayed_payment_key).to_v0_p2wsh(),
1652 let accepted_htlc_info = chan_utils::HTLCOutputInCommitment {
1654 amount_msat: 3460001,
1655 cltv_expiry: htlc_cltv,
1656 payment_hash: payment_hash,
1657 transaction_output_index: Some(1),
1660 let htlc_output = TxOut {
1661 script_pubkey: chan_utils::get_htlc_redeemscript(&accepted_htlc_info, &commit_tx_keys).to_v0_p2wsh(),
1662 value: 3460001 / 1000
1665 let commit_tx_obscure_factor = {
1666 let mut sha = Sha256::engine();
1667 let remote_payment_point = &remote_payment_point.serialize();
1668 sha.input(&local_payment_point.serialize());
1669 sha.input(remote_payment_point);
1670 let res = Sha256::from_engine(sha).into_inner();
1672 ((res[26] as u64) << 5*8) |
1673 ((res[27] as u64) << 4*8) |
1674 ((res[28] as u64) << 3*8) |
1675 ((res[29] as u64) << 2*8) |
1676 ((res[30] as u64) << 1*8) |
1677 ((res[31] as u64) << 0*8)
1679 let commitment_number = 1;
1680 let obscured_commitment_transaction_number = commit_tx_obscure_factor ^ commitment_number;
1681 let lock_time = ((0x20 as u32) << 8*3) | ((obscured_commitment_transaction_number & 0xffffffu64) as u32);
1683 previous_output: BitcoinOutPoint { txid: chan.3.txid(), vout: 0 },
1684 script_sig: Script::new(),
1685 sequence: ((0x80 as u32) << 8*3) | ((obscured_commitment_transaction_number >> 3*8) as u32),
1686 witness: Vec::new(),
1689 let commit_tx = Transaction {
1693 output: vec![remote_commit_tx_output, htlc_output, local_commit_tx_output],
1696 let local_chan_lock = nodes[0].node.channel_state.lock().unwrap();
1697 let local_chan = local_chan_lock.by_id.get(&chan.2).unwrap();
1698 let local_chan_keys = local_chan.get_local_keys();
1699 local_chan_keys.sign_remote_commitment(feerate_per_kw, &commit_tx, &commit_tx_keys, &[&accepted_htlc_info], &secp_ctx).unwrap()
1702 let commit_signed_msg = msgs::CommitmentSigned {
1705 htlc_signatures: res.1
1708 // Send the commitment_signed message to the nodes[1].
1709 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commit_signed_msg);
1710 let _ = nodes[1].node.get_and_clear_pending_msg_events();
1712 // Send the RAA to nodes[1].
1713 let per_commitment_secret = local_secret;
1714 let next_secret = SecretKey::from_slice(&local_secret2).unwrap();
1715 let next_per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &next_secret);
1716 let raa_msg = msgs::RevokeAndACK{ channel_id: chan.2, per_commitment_secret, next_per_commitment_point};
1717 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_msg);
1719 let events = nodes[1].node.get_and_clear_pending_msg_events();
1720 assert_eq!(events.len(), 1);
1721 // Make sure the HTLC failed in the way we expect.
1723 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, .. }, .. } => {
1724 assert_eq!(update_fail_htlcs.len(), 1);
1725 update_fail_htlcs[0].clone()
1727 _ => panic!("Unexpected event"),
1729 nodes[1].logger.assert_log("lightning::ln::channel".to_string(), "Attempting to fail HTLC due to fee spike buffer violation".to_string(), 1);
1731 check_added_monitors!(nodes[1], 2);
1735 fn test_chan_reserve_violation_outbound_htlc_inbound_chan() {
1736 let mut chanmon_cfgs = create_chanmon_cfgs(2);
1737 // Set the fee rate for the channel very high, to the point where the fundee
1738 // sending any amount would result in a channel reserve violation. In this test
1739 // we check that we would be prevented from sending an HTLC in this situation.
1740 chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1741 chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1742 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1743 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1744 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1745 let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1746 let logger = test_utils::TestLogger::new();
1748 macro_rules! get_route_and_payment_hash {
1749 ($recv_value: expr) => {{
1750 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[1]);
1751 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1752 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();
1753 (route, payment_hash, payment_preimage)
1757 let (route, our_payment_hash, _) = get_route_and_payment_hash!(1000);
1758 unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
1759 assert_eq!(err, "Cannot send value that would put them under remote channel reserve value"));
1760 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1761 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put them under remote channel reserve value".to_string(), 1);
1765 fn test_chan_reserve_violation_inbound_htlc_outbound_channel() {
1766 let mut chanmon_cfgs = create_chanmon_cfgs(2);
1767 // Set the fee rate for the channel very high, to the point where the funder
1768 // receiving 1 update_add_htlc would result in them closing the channel due
1769 // to channel reserve violation. This close could also happen if the fee went
1770 // up a more realistic amount, but many HTLCs were outstanding at the time of
1771 // the update_add_htlc.
1772 chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1773 chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1774 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1775 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1776 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1777 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1778 let logger = test_utils::TestLogger::new();
1780 macro_rules! get_route_and_payment_hash {
1781 ($recv_value: expr) => {{
1782 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[1]);
1783 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1784 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();
1785 (route, payment_hash, payment_preimage)
1789 let (route, payment_hash, _) = get_route_and_payment_hash!(1000);
1790 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1791 let secp_ctx = Secp256k1::new();
1792 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1793 let cur_height = nodes[1].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1794 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1795 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 1000, &None, cur_height).unwrap();
1796 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1797 let msg = msgs::UpdateAddHTLC {
1800 amount_msat: htlc_msat + 1,
1801 payment_hash: payment_hash,
1802 cltv_expiry: htlc_cltv,
1803 onion_routing_packet: onion_packet,
1806 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &msg);
1807 // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1808 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot receive value that would put us under local channel reserve value".to_string(), 1);
1809 assert_eq!(nodes[0].node.list_channels().len(), 0);
1810 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
1811 assert_eq!(err_msg.data, "Cannot receive value that would put us under local channel reserve value");
1812 check_added_monitors!(nodes[0], 1);
1816 fn test_chan_reserve_violation_inbound_htlc_inbound_chan() {
1817 let chanmon_cfgs = create_chanmon_cfgs(3);
1818 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1819 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1820 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1821 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1822 let _ = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1823 let logger = test_utils::TestLogger::new();
1825 macro_rules! get_route_and_payment_hash {
1826 ($recv_value: expr) => {{
1827 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1828 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1829 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();
1830 (route, payment_hash, payment_preimage)
1835 let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1836 let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1837 let feerate = get_feerate!(nodes[0], chan.2);
1839 // Add a 2* and +1 for the fee spike reserve.
1840 let commit_tx_fee_2_htlc = 2*commit_tx_fee_msat(feerate, 2 + 1);
1841 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;
1842 let amt_msat_1 = recv_value_1 + total_routing_fee_msat;
1844 // Add a pending HTLC.
1845 let (route_1, our_payment_hash_1, _) = get_route_and_payment_hash!(amt_msat_1);
1846 let payment_event_1 = {
1847 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &None).unwrap();
1848 check_added_monitors!(nodes[0], 1);
1850 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1851 assert_eq!(events.len(), 1);
1852 SendEvent::from_event(events.remove(0))
1854 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1856 // Attempt to trigger a channel reserve violation --> payment failure.
1857 let commit_tx_fee_2_htlcs = commit_tx_fee_msat(feerate, 2);
1858 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;
1859 let amt_msat_2 = recv_value_2 + total_routing_fee_msat;
1860 let (route_2, _, _) = get_route_and_payment_hash!(amt_msat_2);
1862 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1863 let secp_ctx = Secp256k1::new();
1864 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1865 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1866 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route_2.paths[0], &session_priv).unwrap();
1867 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route_2.paths[0], recv_value_2, &None, cur_height).unwrap();
1868 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash_1);
1869 let msg = msgs::UpdateAddHTLC {
1872 amount_msat: htlc_msat + 1,
1873 payment_hash: our_payment_hash_1,
1874 cltv_expiry: htlc_cltv,
1875 onion_routing_packet: onion_packet,
1878 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1879 // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1880 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote HTLC add would put them under remote reserve value".to_string(), 1);
1881 assert_eq!(nodes[1].node.list_channels().len(), 1);
1882 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1883 assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
1884 check_added_monitors!(nodes[1], 1);
1887 fn commit_tx_fee_msat(feerate: u32, num_htlcs: u64) -> u64 {
1888 (COMMITMENT_TX_BASE_WEIGHT + num_htlcs * COMMITMENT_TX_WEIGHT_PER_HTLC) * feerate as u64 / 1000 * 1000
1892 fn test_channel_reserve_holding_cell_htlcs() {
1893 let chanmon_cfgs = create_chanmon_cfgs(3);
1894 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1895 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1896 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1897 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1898 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1899 let logger = test_utils::TestLogger::new();
1901 let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1902 let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1904 let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1905 let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1907 macro_rules! get_route_and_payment_hash {
1908 ($recv_value: expr) => {{
1909 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1910 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1911 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();
1912 (route, payment_hash, payment_preimage)
1916 macro_rules! expect_forward {
1918 let mut events = $node.node.get_and_clear_pending_msg_events();
1919 assert_eq!(events.len(), 1);
1920 check_added_monitors!($node, 1);
1921 let payment_event = SendEvent::from_event(events.remove(0));
1926 let feemsat = 239; // somehow we know?
1927 let total_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1928 let feerate = get_feerate!(nodes[0], chan_1.2);
1930 let recv_value_0 = stat01.their_max_htlc_value_in_flight_msat - total_fee_msat;
1932 // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1934 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_0 + 1);
1935 assert!(route.paths[0].iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1936 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
1937 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)));
1938 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1939 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);
1942 // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1943 // nodes[0]'s wealth
1945 let amt_msat = recv_value_0 + total_fee_msat;
1946 // 3 for the 3 HTLCs that will be sent, 2* and +1 for the fee spike reserve.
1947 // Also, ensure that each payment has enough to be over the dust limit to
1948 // ensure it'll be included in each commit tx fee calculation.
1949 let commit_tx_fee_all_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1950 let ensure_htlc_amounts_above_dust_buffer = 3 * (stat01.their_dust_limit_msat + 1000);
1951 if stat01.value_to_self_msat < stat01.channel_reserve_msat + commit_tx_fee_all_htlcs + ensure_htlc_amounts_above_dust_buffer + amt_msat {
1954 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0, recv_value_0);
1956 let (stat01_, stat11_, stat12_, stat22_) = (
1957 get_channel_value_stat!(nodes[0], chan_1.2),
1958 get_channel_value_stat!(nodes[1], chan_1.2),
1959 get_channel_value_stat!(nodes[1], chan_2.2),
1960 get_channel_value_stat!(nodes[2], chan_2.2),
1963 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1964 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1965 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1966 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1967 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1970 // adding pending output.
1971 // 2* and +1 HTLCs on the commit tx fee for the fee spike reserve.
1972 // The reason we're dividing by two here is as follows: the dividend is the total outbound liquidity
1973 // after fees, the channel reserve, and the fee spike buffer are removed. We eventually want to
1974 // divide this quantity into 3 portions, that will each be sent in an HTLC. This allows us
1975 // to test channel channel reserve policy at the edges of what amount is sendable, i.e.
1976 // cases where 1 msat over X amount will cause a payment failure, but anything less than
1977 // that can be sent successfully. So, dividing by two is a somewhat arbitrary way of getting
1978 // the amount of the first of these aforementioned 3 payments. The reason we split into 3 payments
1979 // is to test the behavior of the holding cell with respect to channel reserve and commit tx fee
1981 let commit_tx_fee_2_htlcs = 2*commit_tx_fee_msat(feerate, 2 + 1);
1982 let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs)/2;
1983 let amt_msat_1 = recv_value_1 + total_fee_msat;
1985 let (route_1, our_payment_hash_1, our_payment_preimage_1) = get_route_and_payment_hash!(recv_value_1);
1986 let payment_event_1 = {
1987 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &None).unwrap();
1988 check_added_monitors!(nodes[0], 1);
1990 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1991 assert_eq!(events.len(), 1);
1992 SendEvent::from_event(events.remove(0))
1994 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1996 // channel reserve test with htlc pending output > 0
1997 let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs;
1999 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
2000 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
2001 assert!(regex::Regex::new(r"Cannot send value that would put us under local channel reserve value \(\d+\)").unwrap().is_match(err)));
2002 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2005 // split the rest to test holding cell
2006 let commit_tx_fee_3_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
2007 let additional_htlc_cost_msat = commit_tx_fee_3_htlcs - commit_tx_fee_2_htlcs;
2008 let recv_value_21 = recv_value_2/2 - additional_htlc_cost_msat/2;
2009 let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat - additional_htlc_cost_msat;
2011 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
2012 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);
2015 // now see if they go through on both sides
2016 let (route_21, our_payment_hash_21, our_payment_preimage_21) = get_route_and_payment_hash!(recv_value_21);
2017 // but this will stuck in the holding cell
2018 nodes[0].node.send_payment(&route_21, our_payment_hash_21, &None).unwrap();
2019 check_added_monitors!(nodes[0], 0);
2020 let events = nodes[0].node.get_and_clear_pending_events();
2021 assert_eq!(events.len(), 0);
2023 // test with outbound holding cell amount > 0
2025 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_22+1);
2026 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
2027 assert!(regex::Regex::new(r"Cannot send value that would put us under local channel reserve value \(\d+\)").unwrap().is_match(err)));
2028 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2029 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us under local channel reserve value".to_string(), 2);
2032 let (route_22, our_payment_hash_22, our_payment_preimage_22) = get_route_and_payment_hash!(recv_value_22);
2033 // this will also stuck in the holding cell
2034 nodes[0].node.send_payment(&route_22, our_payment_hash_22, &None).unwrap();
2035 check_added_monitors!(nodes[0], 0);
2036 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
2037 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2039 // flush the pending htlc
2040 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
2041 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2042 check_added_monitors!(nodes[1], 1);
2044 // the pending htlc should be promoted to committed
2045 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
2046 check_added_monitors!(nodes[0], 1);
2047 let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2049 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
2050 let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2051 // No commitment_signed so get_event_msg's assert(len == 1) passes
2052 check_added_monitors!(nodes[0], 1);
2054 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
2055 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2056 check_added_monitors!(nodes[1], 1);
2058 expect_pending_htlcs_forwardable!(nodes[1]);
2060 let ref payment_event_11 = expect_forward!(nodes[1]);
2061 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
2062 commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
2064 expect_pending_htlcs_forwardable!(nodes[2]);
2065 expect_payment_received!(nodes[2], our_payment_hash_1, recv_value_1);
2067 // flush the htlcs in the holding cell
2068 assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
2069 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
2070 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
2071 commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
2072 expect_pending_htlcs_forwardable!(nodes[1]);
2074 let ref payment_event_3 = expect_forward!(nodes[1]);
2075 assert_eq!(payment_event_3.msgs.len(), 2);
2076 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
2077 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
2079 commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
2080 expect_pending_htlcs_forwardable!(nodes[2]);
2082 let events = nodes[2].node.get_and_clear_pending_events();
2083 assert_eq!(events.len(), 2);
2085 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
2086 assert_eq!(our_payment_hash_21, *payment_hash);
2087 assert_eq!(*payment_secret, None);
2088 assert_eq!(recv_value_21, amt);
2090 _ => panic!("Unexpected event"),
2093 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
2094 assert_eq!(our_payment_hash_22, *payment_hash);
2095 assert_eq!(None, *payment_secret);
2096 assert_eq!(recv_value_22, amt);
2098 _ => panic!("Unexpected event"),
2101 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1, recv_value_1);
2102 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21, recv_value_21);
2103 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22, recv_value_22);
2105 let commit_tx_fee_0_htlcs = 2*commit_tx_fee_msat(feerate, 1);
2106 let recv_value_3 = commit_tx_fee_2_htlcs - commit_tx_fee_0_htlcs - total_fee_msat;
2108 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_3 + 1);
2109 let err = nodes[0].node.send_payment(&route, our_payment_hash, &None).err().unwrap();
2111 PaymentSendFailure::AllFailedRetrySafe(ref fails) => {
2113 &APIError::ChannelUnavailable{ref err} =>
2114 assert!(regex::Regex::new(r"Cannot send value that would put us under local channel reserve value \(\d+\)").unwrap().is_match(err)),
2115 _ => panic!("Unexpected error variant"),
2118 _ => panic!("Unexpected error variant"),
2120 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2121 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us under local channel reserve value".to_string(), 3);
2124 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_3, recv_value_3);
2126 let commit_tx_fee_1_htlc = 2*commit_tx_fee_msat(feerate, 1 + 1);
2127 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);
2128 let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
2129 assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
2130 assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat + commit_tx_fee_1_htlc);
2132 let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
2133 assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22 + recv_value_3);
2137 fn channel_reserve_in_flight_removes() {
2138 // In cases where one side claims an HTLC, it thinks it has additional available funds that it
2139 // can send to its counterparty, but due to update ordering, the other side may not yet have
2140 // considered those HTLCs fully removed.
2141 // This tests that we don't count HTLCs which will not be included in the next remote
2142 // commitment transaction towards the reserve value (as it implies no commitment transaction
2143 // will be generated which violates the remote reserve value).
2144 // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
2146 // * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
2147 // you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
2148 // you only consider the value of the first HTLC, it may not),
2149 // * start routing a third HTLC from A to B,
2150 // * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
2151 // the other claim in its holding cell, as it immediately goes into AwaitingRAA),
2152 // * deliver the first fulfill from B
2153 // * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
2155 // * deliver A's response CS and RAA.
2156 // This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
2157 // removed it fully. B now has the push_msat plus the first two HTLCs in value.
2158 // * Now B happily sends another HTLC, potentially violating its reserve value from A's point
2159 // of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
2160 let chanmon_cfgs = create_chanmon_cfgs(2);
2161 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2162 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2163 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2164 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2165 let logger = test_utils::TestLogger::new();
2167 let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
2168 // Route the first two HTLCs.
2169 let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
2170 let (payment_preimage_2, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
2172 // Start routing the third HTLC (this is just used to get everyone in the right state).
2173 let (payment_preimage_3, payment_hash_3) = get_payment_preimage_hash!(nodes[0]);
2175 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
2176 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();
2177 nodes[0].node.send_payment(&route, payment_hash_3, &None).unwrap();
2178 check_added_monitors!(nodes[0], 1);
2179 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2180 assert_eq!(events.len(), 1);
2181 SendEvent::from_event(events.remove(0))
2184 // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
2185 // initial fulfill/CS.
2186 assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000));
2187 check_added_monitors!(nodes[1], 1);
2188 let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2190 // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
2191 // remove the second HTLC when we send the HTLC back from B to A.
2192 assert!(nodes[1].node.claim_funds(payment_preimage_2, &None, 20000));
2193 check_added_monitors!(nodes[1], 1);
2194 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2196 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
2197 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
2198 check_added_monitors!(nodes[0], 1);
2199 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2200 expect_payment_sent!(nodes[0], payment_preimage_1);
2202 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
2203 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
2204 check_added_monitors!(nodes[1], 1);
2205 // B is already AwaitingRAA, so cant generate a CS here
2206 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2208 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2209 check_added_monitors!(nodes[1], 1);
2210 let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2212 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2213 check_added_monitors!(nodes[0], 1);
2214 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2216 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2217 check_added_monitors!(nodes[1], 1);
2218 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2220 // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
2221 // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
2222 // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
2223 // can no longer broadcast a commitment transaction with it and B has the preimage so can go
2224 // on-chain as necessary).
2225 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
2226 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
2227 check_added_monitors!(nodes[0], 1);
2228 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2229 expect_payment_sent!(nodes[0], payment_preimage_2);
2231 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2232 check_added_monitors!(nodes[1], 1);
2233 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2235 expect_pending_htlcs_forwardable!(nodes[1]);
2236 expect_payment_received!(nodes[1], payment_hash_3, 100000);
2238 // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
2239 // resolve the second HTLC from A's point of view.
2240 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2241 check_added_monitors!(nodes[0], 1);
2242 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2244 // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
2245 // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
2246 let (payment_preimage_4, payment_hash_4) = get_payment_preimage_hash!(nodes[1]);
2248 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
2249 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();
2250 nodes[1].node.send_payment(&route, payment_hash_4, &None).unwrap();
2251 check_added_monitors!(nodes[1], 1);
2252 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
2253 assert_eq!(events.len(), 1);
2254 SendEvent::from_event(events.remove(0))
2257 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
2258 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
2259 check_added_monitors!(nodes[0], 1);
2260 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2262 // Now just resolve all the outstanding messages/HTLCs for completeness...
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[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2269 check_added_monitors!(nodes[1], 1);
2271 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2272 check_added_monitors!(nodes[0], 1);
2273 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2275 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2276 check_added_monitors!(nodes[1], 1);
2277 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2279 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2280 check_added_monitors!(nodes[0], 1);
2282 expect_pending_htlcs_forwardable!(nodes[0]);
2283 expect_payment_received!(nodes[0], payment_hash_4, 10000);
2285 claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4, 10_000);
2286 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3, 100_000);
2290 fn channel_monitor_network_test() {
2291 // Simple test which builds a network of ChannelManagers, connects them to each other, and
2292 // tests that ChannelMonitor is able to recover from various states.
2293 let chanmon_cfgs = create_chanmon_cfgs(5);
2294 let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
2295 let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
2296 let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
2298 // Create some initial channels
2299 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2300 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2301 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
2302 let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
2304 // Rebalance the network a bit by relaying one payment through all the channels...
2305 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2306 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2307 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2308 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2310 // Simple case with no pending HTLCs:
2311 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
2312 check_added_monitors!(nodes[1], 1);
2314 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
2315 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2316 connect_block(&nodes[0], &Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
2317 check_added_monitors!(nodes[0], 1);
2318 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
2320 get_announce_close_broadcast_events(&nodes, 0, 1);
2321 assert_eq!(nodes[0].node.list_channels().len(), 0);
2322 assert_eq!(nodes[1].node.list_channels().len(), 1);
2324 // One pending HTLC is discarded by the force-close:
2325 let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
2327 // Simple case of one pending HTLC to HTLC-Timeout
2328 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
2329 check_added_monitors!(nodes[1], 1);
2331 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
2332 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2333 connect_block(&nodes[2], &Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
2334 check_added_monitors!(nodes[2], 1);
2335 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
2337 get_announce_close_broadcast_events(&nodes, 1, 2);
2338 assert_eq!(nodes[1].node.list_channels().len(), 0);
2339 assert_eq!(nodes[2].node.list_channels().len(), 1);
2341 macro_rules! claim_funds {
2342 ($node: expr, $prev_node: expr, $preimage: expr, $amount: expr) => {
2344 assert!($node.node.claim_funds($preimage, &None, $amount));
2345 check_added_monitors!($node, 1);
2347 let events = $node.node.get_and_clear_pending_msg_events();
2348 assert_eq!(events.len(), 1);
2350 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2351 assert!(update_add_htlcs.is_empty());
2352 assert!(update_fail_htlcs.is_empty());
2353 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2355 _ => panic!("Unexpected event"),
2361 // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2362 // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2363 nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2364 check_added_monitors!(nodes[2], 1);
2365 let node2_commitment_txid;
2367 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2368 node2_commitment_txid = node_txn[0].txid();
2370 // Claim the payment on nodes[3], giving it knowledge of the preimage
2371 claim_funds!(nodes[3], nodes[2], payment_preimage_1, 3_000_000);
2373 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2374 connect_block(&nodes[3], &Block { header, txdata: vec![node_txn[0].clone()] }, 1);
2375 check_added_monitors!(nodes[3], 1);
2377 check_preimage_claim(&nodes[3], &node_txn);
2379 get_announce_close_broadcast_events(&nodes, 2, 3);
2380 assert_eq!(nodes[2].node.list_channels().len(), 0);
2381 assert_eq!(nodes[3].node.list_channels().len(), 1);
2383 { // Cheat and reset nodes[4]'s height to 1
2384 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2385 connect_block(&nodes[4], &Block { header, txdata: vec![] }, 1);
2388 assert_eq!(nodes[3].node.latest_block_height.load(Ordering::Acquire), 1);
2389 assert_eq!(nodes[4].node.latest_block_height.load(Ordering::Acquire), 1);
2390 // One pending HTLC to time out:
2391 let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2392 // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2396 let mut block = Block {
2397 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
2400 connect_block(&nodes[3], &block, 2);
2401 for i in 3..TEST_FINAL_CLTV + 2 + LATENCY_GRACE_PERIOD_BLOCKS + 1 {
2403 header: BlockHeader { version: 0x20000000, prev_blockhash: block.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
2406 connect_block(&nodes[3], &block, i);
2408 check_added_monitors!(nodes[3], 1);
2410 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2412 let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2413 node_txn.retain(|tx| {
2414 if tx.input[0].previous_output.txid == node2_commitment_txid {
2420 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2422 // Claim the payment on nodes[4], giving it knowledge of the preimage
2423 claim_funds!(nodes[4], nodes[3], payment_preimage_2, 3_000_000);
2426 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
2430 connect_block(&nodes[4], &block, 2);
2431 for i in 3..TEST_FINAL_CLTV + 2 - CLTV_CLAIM_BUFFER + 1 {
2433 header: BlockHeader { version: 0x20000000, prev_blockhash: block.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
2436 connect_block(&nodes[4], &block, i);
2439 check_added_monitors!(nodes[4], 1);
2440 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2443 header: BlockHeader { version: 0x20000000, prev_blockhash: block.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
2444 txdata: vec![node_txn[0].clone()],
2446 connect_block(&nodes[4], &block, TEST_FINAL_CLTV - 5);
2448 check_preimage_claim(&nodes[4], &node_txn);
2450 get_announce_close_broadcast_events(&nodes, 3, 4);
2451 assert_eq!(nodes[3].node.list_channels().len(), 0);
2452 assert_eq!(nodes[4].node.list_channels().len(), 0);
2456 fn test_justice_tx() {
2457 // Test justice txn built on revoked HTLC-Success tx, against both sides
2458 let mut alice_config = UserConfig::default();
2459 alice_config.channel_options.announced_channel = true;
2460 alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2461 alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2462 let mut bob_config = UserConfig::default();
2463 bob_config.channel_options.announced_channel = true;
2464 bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2465 bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2466 let user_cfgs = [Some(alice_config), Some(bob_config)];
2467 let chanmon_cfgs = create_chanmon_cfgs(2);
2468 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2469 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2470 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2471 // Create some new channels:
2472 let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2474 // A pending HTLC which will be revoked:
2475 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2476 // Get the will-be-revoked local txn from nodes[0]
2477 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2478 assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2479 assert_eq!(revoked_local_txn[0].input.len(), 1);
2480 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2481 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2482 assert_eq!(revoked_local_txn[1].input.len(), 1);
2483 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2484 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2485 // Revoke the old state
2486 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 3_000_000);
2489 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2490 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2492 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2493 assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2494 assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2496 check_spends!(node_txn[0], revoked_local_txn[0]);
2497 node_txn.swap_remove(0);
2498 node_txn.truncate(1);
2500 check_added_monitors!(nodes[1], 1);
2501 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2503 connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2504 // Verify broadcast of revoked HTLC-timeout
2505 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2506 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2507 check_added_monitors!(nodes[0], 1);
2508 // Broadcast revoked HTLC-timeout on node 1
2509 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2510 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2512 get_announce_close_broadcast_events(&nodes, 0, 1);
2514 assert_eq!(nodes[0].node.list_channels().len(), 0);
2515 assert_eq!(nodes[1].node.list_channels().len(), 0);
2517 // We test justice_tx build by A on B's revoked HTLC-Success tx
2518 // Create some new channels:
2519 let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2521 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2525 // A pending HTLC which will be revoked:
2526 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2527 // Get the will-be-revoked local txn from B
2528 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2529 assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2530 assert_eq!(revoked_local_txn[0].input.len(), 1);
2531 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2532 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2533 // Revoke the old state
2534 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4, 3_000_000);
2536 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2537 connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2539 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2540 assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2541 assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2543 check_spends!(node_txn[0], revoked_local_txn[0]);
2544 node_txn.swap_remove(0);
2546 check_added_monitors!(nodes[0], 1);
2547 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2549 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2550 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2551 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2552 check_added_monitors!(nodes[1], 1);
2553 connect_block(&nodes[0], &Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2554 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2556 get_announce_close_broadcast_events(&nodes, 0, 1);
2557 assert_eq!(nodes[0].node.list_channels().len(), 0);
2558 assert_eq!(nodes[1].node.list_channels().len(), 0);
2562 fn revoked_output_claim() {
2563 // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2564 // transaction is broadcast by its counterparty
2565 let chanmon_cfgs = create_chanmon_cfgs(2);
2566 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2567 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2568 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2569 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2570 // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2571 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2572 assert_eq!(revoked_local_txn.len(), 1);
2573 // Only output is the full channel value back to nodes[0]:
2574 assert_eq!(revoked_local_txn[0].output.len(), 1);
2575 // Send a payment through, updating everyone's latest commitment txn
2576 send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000, 5_000_000);
2578 // Inform nodes[1] that nodes[0] broadcast a stale tx
2579 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2580 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2581 check_added_monitors!(nodes[1], 1);
2582 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2583 assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2585 check_spends!(node_txn[0], revoked_local_txn[0]);
2586 check_spends!(node_txn[1], chan_1.3);
2588 // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2589 connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2590 get_announce_close_broadcast_events(&nodes, 0, 1);
2591 check_added_monitors!(nodes[0], 1)
2595 fn claim_htlc_outputs_shared_tx() {
2596 // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2597 let chanmon_cfgs = create_chanmon_cfgs(2);
2598 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2599 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2600 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2602 // Create some new channel:
2603 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2605 // Rebalance the network to generate htlc in the two directions
2606 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2607 // 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
2608 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2609 let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2611 // Get the will-be-revoked local txn from node[0]
2612 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2613 assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2614 assert_eq!(revoked_local_txn[0].input.len(), 1);
2615 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2616 assert_eq!(revoked_local_txn[1].input.len(), 1);
2617 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2618 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2619 check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2621 //Revoke the old state
2622 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2625 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2626 connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2627 check_added_monitors!(nodes[0], 1);
2628 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2629 check_added_monitors!(nodes[1], 1);
2630 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2631 expect_payment_failed!(nodes[1], payment_hash_2, true);
2633 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2634 assert_eq!(node_txn.len(), 3); // ChannelMonitor: penalty tx, ChannelManager: local commitment + HTLC-timeout
2636 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2637 check_spends!(node_txn[0], revoked_local_txn[0]);
2639 let mut witness_lens = BTreeSet::new();
2640 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2641 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2642 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2643 assert_eq!(witness_lens.len(), 3);
2644 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2645 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2646 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2648 // Next nodes[1] broadcasts its current local tx state:
2649 assert_eq!(node_txn[1].input.len(), 1);
2650 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2652 assert_eq!(node_txn[2].input.len(), 1);
2653 let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
2654 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2655 assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
2656 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2657 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
2659 get_announce_close_broadcast_events(&nodes, 0, 1);
2660 assert_eq!(nodes[0].node.list_channels().len(), 0);
2661 assert_eq!(nodes[1].node.list_channels().len(), 0);
2665 fn claim_htlc_outputs_single_tx() {
2666 // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2667 let chanmon_cfgs = create_chanmon_cfgs(2);
2668 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2669 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2670 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2672 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2674 // Rebalance the network to generate htlc in the two directions
2675 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2676 // 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
2677 // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2678 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2679 let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2681 // Get the will-be-revoked local txn from node[0]
2682 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2684 //Revoke the old state
2685 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2688 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2689 connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2690 check_added_monitors!(nodes[0], 1);
2691 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2692 check_added_monitors!(nodes[1], 1);
2693 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
2695 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
2696 expect_payment_failed!(nodes[1], payment_hash_2, true);
2698 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2699 assert_eq!(node_txn.len(), 9);
2700 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2701 // ChannelManager: local commmitment + local HTLC-timeout (2)
2702 // 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)
2703 // ChannelMonitor: local commitment + local HTLC-timeout (2)
2705 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2706 assert_eq!(node_txn[2].input.len(), 1);
2707 check_spends!(node_txn[2], chan_1.3);
2708 assert_eq!(node_txn[3].input.len(), 1);
2709 let witness_script = node_txn[3].input[0].witness.last().unwrap();
2710 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2711 check_spends!(node_txn[3], node_txn[2]);
2713 // Justice transactions are indices 1-2-4
2714 assert_eq!(node_txn[0].input.len(), 1);
2715 assert_eq!(node_txn[1].input.len(), 1);
2716 assert_eq!(node_txn[4].input.len(), 1);
2718 check_spends!(node_txn[0], revoked_local_txn[0]);
2719 check_spends!(node_txn[1], revoked_local_txn[0]);
2720 check_spends!(node_txn[4], revoked_local_txn[0]);
2722 let mut witness_lens = BTreeSet::new();
2723 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2724 witness_lens.insert(node_txn[1].input[0].witness.last().unwrap().len());
2725 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2726 assert_eq!(witness_lens.len(), 3);
2727 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2728 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2729 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2731 get_announce_close_broadcast_events(&nodes, 0, 1);
2732 assert_eq!(nodes[0].node.list_channels().len(), 0);
2733 assert_eq!(nodes[1].node.list_channels().len(), 0);
2737 fn test_htlc_on_chain_success() {
2738 // Test that in case of a unilateral close onchain, we detect the state of output and pass
2739 // the preimage backward accordingly. So here we test that ChannelManager is
2740 // broadcasting the right event to other nodes in payment path.
2741 // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2742 // A --------------------> B ----------------------> C (preimage)
2743 // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2744 // commitment transaction was broadcast.
2745 // Then, B should learn the preimage from said transactions, attempting to claim backwards
2747 // B should be able to claim via preimage if A then broadcasts its local tx.
2748 // Finally, when A sees B's latest local commitment transaction it should be able to claim
2749 // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2750 // PaymentSent event).
2752 let chanmon_cfgs = create_chanmon_cfgs(3);
2753 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2754 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2755 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2757 // Create some initial channels
2758 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2759 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2761 // Rebalance the network a bit by relaying one payment through all the channels...
2762 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2763 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2765 let (our_payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2766 let (our_payment_preimage_2, _payment_hash_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2767 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2769 // Broadcast legit commitment tx from C on B's chain
2770 // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2771 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2772 assert_eq!(commitment_tx.len(), 1);
2773 check_spends!(commitment_tx[0], chan_2.3);
2774 nodes[2].node.claim_funds(our_payment_preimage, &None, 3_000_000);
2775 nodes[2].node.claim_funds(our_payment_preimage_2, &None, 3_000_000);
2776 check_added_monitors!(nodes[2], 2);
2777 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2778 assert!(updates.update_add_htlcs.is_empty());
2779 assert!(updates.update_fail_htlcs.is_empty());
2780 assert!(updates.update_fail_malformed_htlcs.is_empty());
2781 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2783 connect_block(&nodes[2], &Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2784 check_closed_broadcast!(nodes[2], false);
2785 check_added_monitors!(nodes[2], 1);
2786 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)
2787 assert_eq!(node_txn.len(), 5);
2788 assert_eq!(node_txn[0], node_txn[3]);
2789 assert_eq!(node_txn[1], node_txn[4]);
2790 assert_eq!(node_txn[2], commitment_tx[0]);
2791 check_spends!(node_txn[0], commitment_tx[0]);
2792 check_spends!(node_txn[1], commitment_tx[0]);
2793 assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2794 assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2795 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2796 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2797 assert_eq!(node_txn[0].lock_time, 0);
2798 assert_eq!(node_txn[1].lock_time, 0);
2800 // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2801 connect_block(&nodes[1], &Block { header, txdata: node_txn}, 1);
2803 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2804 assert_eq!(added_monitors.len(), 1);
2805 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2806 added_monitors.clear();
2808 let events = nodes[1].node.get_and_clear_pending_msg_events();
2810 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2811 assert_eq!(added_monitors.len(), 2);
2812 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2813 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2814 added_monitors.clear();
2816 assert_eq!(events.len(), 2);
2818 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2819 _ => panic!("Unexpected event"),
2822 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, .. } } => {
2823 assert!(update_add_htlcs.is_empty());
2824 assert!(update_fail_htlcs.is_empty());
2825 assert_eq!(update_fulfill_htlcs.len(), 1);
2826 assert!(update_fail_malformed_htlcs.is_empty());
2827 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2829 _ => panic!("Unexpected event"),
2831 macro_rules! check_tx_local_broadcast {
2832 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2833 let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2834 assert_eq!(node_txn.len(), 5);
2835 // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2836 // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout
2837 check_spends!(node_txn[0], $commitment_tx);
2838 check_spends!(node_txn[1], $commitment_tx);
2839 assert_ne!(node_txn[0].lock_time, 0);
2840 assert_ne!(node_txn[1].lock_time, 0);
2842 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2843 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2844 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2845 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2847 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2848 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2849 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2850 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2852 check_spends!(node_txn[2], $chan_tx);
2853 check_spends!(node_txn[3], node_txn[2]);
2854 check_spends!(node_txn[4], node_txn[2]);
2855 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), 71);
2856 assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2857 assert_eq!(node_txn[4].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2858 assert!(node_txn[3].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2859 assert!(node_txn[4].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2860 assert_ne!(node_txn[3].lock_time, 0);
2861 assert_ne!(node_txn[4].lock_time, 0);
2865 // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2866 // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2867 // timeout-claim of the output that nodes[2] just claimed via success.
2868 check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2870 // Broadcast legit commitment tx from A on B's chain
2871 // Broadcast preimage tx by B on offered output from A commitment tx on A's chain
2872 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2873 check_spends!(commitment_tx[0], chan_1.3);
2874 connect_block(&nodes[1], &Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2875 check_closed_broadcast!(nodes[1], false);
2876 check_added_monitors!(nodes[1], 1);
2877 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 1 (HTLC-Success)
2878 assert_eq!(node_txn.len(), 4);
2879 check_spends!(node_txn[0], commitment_tx[0]);
2880 assert_eq!(node_txn[0].input.len(), 2);
2881 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2882 assert_eq!(node_txn[0].input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2883 assert_eq!(node_txn[0].lock_time, 0);
2884 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2885 check_spends!(node_txn[1], chan_1.3);
2886 assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2887 check_spends!(node_txn[2], node_txn[1]);
2888 check_spends!(node_txn[3], node_txn[1]);
2889 // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2890 // we already checked the same situation with A.
2892 // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2893 connect_block(&nodes[0], &Block { header, txdata: vec![commitment_tx[0].clone(), node_txn[0].clone()] }, 1);
2894 check_closed_broadcast!(nodes[0], false);
2895 check_added_monitors!(nodes[0], 1);
2896 let events = nodes[0].node.get_and_clear_pending_events();
2897 assert_eq!(events.len(), 2);
2898 let mut first_claimed = false;
2899 for event in events {
2901 Event::PaymentSent { payment_preimage } => {
2902 if payment_preimage == our_payment_preimage {
2903 assert!(!first_claimed);
2904 first_claimed = true;
2906 assert_eq!(payment_preimage, our_payment_preimage_2);
2909 _ => panic!("Unexpected event"),
2912 check_tx_local_broadcast!(nodes[0], true, commitment_tx[0], chan_1.3);
2916 fn test_htlc_on_chain_timeout() {
2917 // Test that in case of a unilateral close onchain, we detect the state of output and
2918 // timeout the HTLC backward accordingly. So here we test that ChannelManager is
2919 // broadcasting the right event to other nodes in payment path.
2920 // A ------------------> B ----------------------> C (timeout)
2921 // B's commitment tx C's commitment tx
2923 // B's HTLC timeout tx B's timeout tx
2925 let chanmon_cfgs = create_chanmon_cfgs(3);
2926 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2927 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2928 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2930 // Create some intial channels
2931 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2932 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2934 // Rebalance the network a bit by relaying one payment thorugh all the channels...
2935 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2936 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2938 let (_payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2939 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2941 // Broadcast legit commitment tx from C on B's chain
2942 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2943 check_spends!(commitment_tx[0], chan_2.3);
2944 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
2945 check_added_monitors!(nodes[2], 0);
2946 expect_pending_htlcs_forwardable!(nodes[2]);
2947 check_added_monitors!(nodes[2], 1);
2949 let events = nodes[2].node.get_and_clear_pending_msg_events();
2950 assert_eq!(events.len(), 1);
2952 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, .. } } => {
2953 assert!(update_add_htlcs.is_empty());
2954 assert!(!update_fail_htlcs.is_empty());
2955 assert!(update_fulfill_htlcs.is_empty());
2956 assert!(update_fail_malformed_htlcs.is_empty());
2957 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2959 _ => panic!("Unexpected event"),
2961 connect_block(&nodes[2], &Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2962 check_closed_broadcast!(nodes[2], false);
2963 check_added_monitors!(nodes[2], 1);
2964 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2965 assert_eq!(node_txn.len(), 1);
2966 check_spends!(node_txn[0], chan_2.3);
2967 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2969 // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2970 // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2971 connect_block(&nodes[1], &Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2974 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2975 assert_eq!(node_txn.len(), 5); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (local commitment tx + HTLC-timeout), 1 timeout tx
2976 assert_eq!(node_txn[1], node_txn[3]);
2977 assert_eq!(node_txn[2], node_txn[4]);
2979 check_spends!(node_txn[0], commitment_tx[0]);
2980 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2982 check_spends!(node_txn[1], chan_2.3);
2983 check_spends!(node_txn[2], node_txn[1]);
2984 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2985 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2987 timeout_tx = node_txn[0].clone();
2991 connect_block(&nodes[1], &Block { header, txdata: vec![timeout_tx]}, 1);
2992 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2993 check_added_monitors!(nodes[1], 1);
2994 check_closed_broadcast!(nodes[1], false);
2996 expect_pending_htlcs_forwardable!(nodes[1]);
2997 check_added_monitors!(nodes[1], 1);
2998 let events = nodes[1].node.get_and_clear_pending_msg_events();
2999 assert_eq!(events.len(), 1);
3001 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, .. } } => {
3002 assert!(update_add_htlcs.is_empty());
3003 assert!(!update_fail_htlcs.is_empty());
3004 assert!(update_fulfill_htlcs.is_empty());
3005 assert!(update_fail_malformed_htlcs.is_empty());
3006 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3008 _ => panic!("Unexpected event"),
3010 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
3011 assert_eq!(node_txn.len(), 0);
3013 // Broadcast legit commitment tx from B on A's chain
3014 let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
3015 check_spends!(commitment_tx[0], chan_1.3);
3017 connect_block(&nodes[0], &Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
3018 check_closed_broadcast!(nodes[0], false);
3019 check_added_monitors!(nodes[0], 1);
3020 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 1 timeout tx
3021 assert_eq!(node_txn.len(), 3);
3022 check_spends!(node_txn[0], commitment_tx[0]);
3023 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3024 check_spends!(node_txn[1], chan_1.3);
3025 check_spends!(node_txn[2], node_txn[1]);
3026 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
3027 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3031 fn test_simple_commitment_revoked_fail_backward() {
3032 // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
3033 // and fail backward accordingly.
3035 let chanmon_cfgs = create_chanmon_cfgs(3);
3036 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3037 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3038 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3040 // Create some initial channels
3041 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3042 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3044 let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3045 // Get the will-be-revoked local txn from nodes[2]
3046 let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3047 // Revoke the old state
3048 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, 3_000_000);
3050 let (_, payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3052 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
3053 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3054 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
3055 check_added_monitors!(nodes[1], 1);
3056 check_closed_broadcast!(nodes[1], false);
3058 expect_pending_htlcs_forwardable!(nodes[1]);
3059 check_added_monitors!(nodes[1], 1);
3060 let events = nodes[1].node.get_and_clear_pending_msg_events();
3061 assert_eq!(events.len(), 1);
3063 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, .. } } => {
3064 assert!(update_add_htlcs.is_empty());
3065 assert_eq!(update_fail_htlcs.len(), 1);
3066 assert!(update_fulfill_htlcs.is_empty());
3067 assert!(update_fail_malformed_htlcs.is_empty());
3068 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3070 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3071 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3073 let events = nodes[0].node.get_and_clear_pending_msg_events();
3074 assert_eq!(events.len(), 1);
3076 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3077 _ => panic!("Unexpected event"),
3079 expect_payment_failed!(nodes[0], payment_hash, false);
3081 _ => panic!("Unexpected event"),
3085 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
3086 // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
3087 // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
3088 // commitment transaction anymore.
3089 // To do this, we have the peer which will broadcast a revoked commitment transaction send
3090 // a number of update_fail/commitment_signed updates without ever sending the RAA in
3091 // response to our commitment_signed. This is somewhat misbehavior-y, though not
3092 // technically disallowed and we should probably handle it reasonably.
3093 // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
3094 // failed/fulfilled backwards must be in at least one of the latest two remote commitment
3096 // * Once we move it out of our holding cell/add it, we will immediately include it in a
3097 // commitment_signed (implying it will be in the latest remote commitment transaction).
3098 // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
3099 // and once they revoke the previous commitment transaction (allowing us to send a new
3100 // commitment_signed) we will be free to fail/fulfill the HTLC backwards.
3101 let chanmon_cfgs = create_chanmon_cfgs(3);
3102 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3103 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3104 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3106 // Create some initial channels
3107 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3108 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3110 let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], if no_to_remote { 10_000 } else { 3_000_000 });
3111 // Get the will-be-revoked local txn from nodes[2]
3112 let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3113 assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
3114 // Revoke the old state
3115 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, if no_to_remote { 10_000 } else { 3_000_000});
3117 let value = if use_dust {
3118 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
3119 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
3120 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().our_dust_limit_satoshis * 1000
3123 let (_, first_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3124 let (_, second_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3125 let (_, third_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3127 assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash, &None));
3128 expect_pending_htlcs_forwardable!(nodes[2]);
3129 check_added_monitors!(nodes[2], 1);
3130 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3131 assert!(updates.update_add_htlcs.is_empty());
3132 assert!(updates.update_fulfill_htlcs.is_empty());
3133 assert!(updates.update_fail_malformed_htlcs.is_empty());
3134 assert_eq!(updates.update_fail_htlcs.len(), 1);
3135 assert!(updates.update_fee.is_none());
3136 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3137 let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
3138 // Drop the last RAA from 3 -> 2
3140 assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash, &None));
3141 expect_pending_htlcs_forwardable!(nodes[2]);
3142 check_added_monitors!(nodes[2], 1);
3143 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3144 assert!(updates.update_add_htlcs.is_empty());
3145 assert!(updates.update_fulfill_htlcs.is_empty());
3146 assert!(updates.update_fail_malformed_htlcs.is_empty());
3147 assert_eq!(updates.update_fail_htlcs.len(), 1);
3148 assert!(updates.update_fee.is_none());
3149 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3150 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3151 check_added_monitors!(nodes[1], 1);
3152 // Note that nodes[1] is in AwaitingRAA, so won't send a CS
3153 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3154 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3155 check_added_monitors!(nodes[2], 1);
3157 assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash, &None));
3158 expect_pending_htlcs_forwardable!(nodes[2]);
3159 check_added_monitors!(nodes[2], 1);
3160 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3161 assert!(updates.update_add_htlcs.is_empty());
3162 assert!(updates.update_fulfill_htlcs.is_empty());
3163 assert!(updates.update_fail_malformed_htlcs.is_empty());
3164 assert_eq!(updates.update_fail_htlcs.len(), 1);
3165 assert!(updates.update_fee.is_none());
3166 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3167 // At this point first_payment_hash has dropped out of the latest two commitment
3168 // transactions that nodes[1] is tracking...
3169 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3170 check_added_monitors!(nodes[1], 1);
3171 // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
3172 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3173 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3174 check_added_monitors!(nodes[2], 1);
3176 // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
3177 // on nodes[2]'s RAA.
3178 let (_, fourth_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3179 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3180 let logger = test_utils::TestLogger::new();
3181 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();
3182 nodes[1].node.send_payment(&route, fourth_payment_hash, &None).unwrap();
3183 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3184 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3185 check_added_monitors!(nodes[1], 0);
3188 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
3189 // One monitor for the new revocation preimage, no second on as we won't generate a new
3190 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
3191 check_added_monitors!(nodes[1], 1);
3192 let events = nodes[1].node.get_and_clear_pending_events();
3193 assert_eq!(events.len(), 1);
3195 Event::PendingHTLCsForwardable { .. } => { },
3196 _ => panic!("Unexpected event"),
3198 // Deliberately don't process the pending fail-back so they all fail back at once after
3199 // block connection just like the !deliver_bs_raa case
3202 let mut failed_htlcs = HashSet::new();
3203 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3205 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
3206 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3207 check_added_monitors!(nodes[1], 1);
3208 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
3210 let events = nodes[1].node.get_and_clear_pending_events();
3211 assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
3213 Event::PaymentFailed { ref payment_hash, .. } => {
3214 assert_eq!(*payment_hash, fourth_payment_hash);
3216 _ => panic!("Unexpected event"),
3218 if !deliver_bs_raa {
3220 Event::PendingHTLCsForwardable { .. } => { },
3221 _ => panic!("Unexpected event"),
3224 nodes[1].node.process_pending_htlc_forwards();
3225 check_added_monitors!(nodes[1], 1);
3227 let events = nodes[1].node.get_and_clear_pending_msg_events();
3228 assert_eq!(events.len(), if deliver_bs_raa { 3 } else { 2 });
3229 match events[if deliver_bs_raa { 1 } else { 0 }] {
3230 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
3231 _ => panic!("Unexpected event"),
3235 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, .. } } => {
3236 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
3237 assert_eq!(update_add_htlcs.len(), 1);
3238 assert!(update_fulfill_htlcs.is_empty());
3239 assert!(update_fail_htlcs.is_empty());
3240 assert!(update_fail_malformed_htlcs.is_empty());
3242 _ => panic!("Unexpected event"),
3245 match events[if deliver_bs_raa { 2 } else { 1 }] {
3246 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, .. } } => {
3247 assert!(update_add_htlcs.is_empty());
3248 assert_eq!(update_fail_htlcs.len(), 3);
3249 assert!(update_fulfill_htlcs.is_empty());
3250 assert!(update_fail_malformed_htlcs.is_empty());
3251 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3253 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3254 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
3255 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
3257 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3259 let events = nodes[0].node.get_and_clear_pending_msg_events();
3260 // If we delivered B's RAA we got an unknown preimage error, not something
3261 // that we should update our routing table for.
3262 assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
3263 for event in events {
3265 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3266 _ => panic!("Unexpected event"),
3269 let events = nodes[0].node.get_and_clear_pending_events();
3270 assert_eq!(events.len(), 3);
3272 Event::PaymentFailed { ref payment_hash, .. } => {
3273 assert!(failed_htlcs.insert(payment_hash.0));
3275 _ => panic!("Unexpected event"),
3278 Event::PaymentFailed { ref payment_hash, .. } => {
3279 assert!(failed_htlcs.insert(payment_hash.0));
3281 _ => panic!("Unexpected event"),
3284 Event::PaymentFailed { ref payment_hash, .. } => {
3285 assert!(failed_htlcs.insert(payment_hash.0));
3287 _ => panic!("Unexpected event"),
3290 _ => panic!("Unexpected event"),
3293 assert!(failed_htlcs.contains(&first_payment_hash.0));
3294 assert!(failed_htlcs.contains(&second_payment_hash.0));
3295 assert!(failed_htlcs.contains(&third_payment_hash.0));
3299 fn test_commitment_revoked_fail_backward_exhaustive_a() {
3300 do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
3301 do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
3302 do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
3303 do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
3307 fn test_commitment_revoked_fail_backward_exhaustive_b() {
3308 do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
3309 do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
3310 do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
3311 do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
3315 fn fail_backward_pending_htlc_upon_channel_failure() {
3316 let chanmon_cfgs = create_chanmon_cfgs(2);
3317 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3318 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3319 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3320 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
3321 let logger = test_utils::TestLogger::new();
3323 // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
3325 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
3326 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3327 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();
3328 nodes[0].node.send_payment(&route, payment_hash, &None).unwrap();
3329 check_added_monitors!(nodes[0], 1);
3331 let payment_event = {
3332 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3333 assert_eq!(events.len(), 1);
3334 SendEvent::from_event(events.remove(0))
3336 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3337 assert_eq!(payment_event.msgs.len(), 1);
3340 // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3341 let (_, failed_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3343 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3344 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3345 nodes[0].node.send_payment(&route, failed_payment_hash, &None).unwrap();
3346 check_added_monitors!(nodes[0], 0);
3348 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3351 // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3353 let (_, payment_hash) = get_payment_preimage_hash!(nodes[1]);
3355 let secp_ctx = Secp256k1::new();
3356 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
3357 let current_height = nodes[1].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
3358 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3359 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();
3360 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &None, current_height).unwrap();
3361 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3362 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3364 // Send a 0-msat update_add_htlc to fail the channel.
3365 let update_add_htlc = msgs::UpdateAddHTLC {
3371 onion_routing_packet,
3373 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3376 // Check that Alice fails backward the pending HTLC from the second payment.
3377 expect_payment_failed!(nodes[0], failed_payment_hash, true);
3378 check_closed_broadcast!(nodes[0], true);
3379 check_added_monitors!(nodes[0], 1);
3383 fn test_htlc_ignore_latest_remote_commitment() {
3384 // Test that HTLC transactions spending the latest remote commitment transaction are simply
3385 // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3386 let chanmon_cfgs = create_chanmon_cfgs(2);
3387 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3388 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3389 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3390 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3392 route_payment(&nodes[0], &[&nodes[1]], 10000000);
3393 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id);
3394 check_closed_broadcast!(nodes[0], false);
3395 check_added_monitors!(nodes[0], 1);
3397 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3398 assert_eq!(node_txn.len(), 2);
3400 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3401 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
3402 check_closed_broadcast!(nodes[1], false);
3403 check_added_monitors!(nodes[1], 1);
3405 // Duplicate the block_connected call since this may happen due to other listeners
3406 // registering new transactions
3407 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
3411 fn test_force_close_fail_back() {
3412 // Check which HTLCs are failed-backwards on channel force-closure
3413 let chanmon_cfgs = create_chanmon_cfgs(3);
3414 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3415 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3416 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3417 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3418 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3419 let logger = test_utils::TestLogger::new();
3421 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3423 let mut payment_event = {
3424 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3425 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();
3426 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
3427 check_added_monitors!(nodes[0], 1);
3429 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3430 assert_eq!(events.len(), 1);
3431 SendEvent::from_event(events.remove(0))
3434 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3435 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3437 expect_pending_htlcs_forwardable!(nodes[1]);
3439 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3440 assert_eq!(events_2.len(), 1);
3441 payment_event = SendEvent::from_event(events_2.remove(0));
3442 assert_eq!(payment_event.msgs.len(), 1);
3444 check_added_monitors!(nodes[1], 1);
3445 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3446 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3447 check_added_monitors!(nodes[2], 1);
3448 let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3450 // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3451 // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3452 // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3454 nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id);
3455 check_closed_broadcast!(nodes[2], false);
3456 check_added_monitors!(nodes[2], 1);
3458 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3459 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3460 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3461 // back to nodes[1] upon timeout otherwise.
3462 assert_eq!(node_txn.len(), 1);
3467 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
3468 txdata: vec![tx.clone()],
3470 connect_block(&nodes[1], &block, 1);
3472 // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3473 check_closed_broadcast!(nodes[1], false);
3474 check_added_monitors!(nodes[1], 1);
3476 // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3478 let mut monitors = nodes[2].chain_monitor.chain_monitor.monitors.lock().unwrap();
3479 monitors.get_mut(&OutPoint{ txid: Txid::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), index: 0 }).unwrap()
3480 .provide_payment_preimage(&our_payment_hash, &our_payment_preimage);
3482 connect_block(&nodes[2], &block, 1);
3483 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3484 assert_eq!(node_txn.len(), 1);
3485 assert_eq!(node_txn[0].input.len(), 1);
3486 assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3487 assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3488 assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3490 check_spends!(node_txn[0], tx);
3494 fn test_unconf_chan() {
3495 // After creating a chan between nodes, we disconnect all blocks previously seen to force a channel close on nodes[0] side
3496 let chanmon_cfgs = create_chanmon_cfgs(2);
3497 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3498 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3499 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3500 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3502 let channel_state = nodes[0].node.channel_state.lock().unwrap();
3503 assert_eq!(channel_state.by_id.len(), 1);
3504 assert_eq!(channel_state.short_to_id.len(), 1);
3505 mem::drop(channel_state);
3507 let mut headers = Vec::new();
3508 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3509 headers.push(header.clone());
3511 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3512 headers.push(header.clone());
3514 let mut height = 99;
3515 while !headers.is_empty() {
3516 nodes[0].node.block_disconnected(&headers.pop().unwrap(), height);
3519 check_closed_broadcast!(nodes[0], false);
3520 check_added_monitors!(nodes[0], 1);
3521 let channel_state = nodes[0].node.channel_state.lock().unwrap();
3522 assert_eq!(channel_state.by_id.len(), 0);
3523 assert_eq!(channel_state.short_to_id.len(), 0);
3527 fn test_simple_peer_disconnect() {
3528 // Test that we can reconnect when there are no lost messages
3529 let chanmon_cfgs = create_chanmon_cfgs(3);
3530 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3531 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3532 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3533 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3534 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3536 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3537 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3538 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3540 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3541 let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3542 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3543 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1, 1_000_000);
3545 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3546 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3547 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3549 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3550 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3551 let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3552 let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3554 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3555 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3557 claim_payment_along_route(&nodes[0], &vec!(&nodes[1], &nodes[2]), true, payment_preimage_3, 1_000_000);
3558 fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3560 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3562 let events = nodes[0].node.get_and_clear_pending_events();
3563 assert_eq!(events.len(), 2);
3565 Event::PaymentSent { payment_preimage } => {
3566 assert_eq!(payment_preimage, payment_preimage_3);
3568 _ => panic!("Unexpected event"),
3571 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3572 assert_eq!(payment_hash, payment_hash_5);
3573 assert!(rejected_by_dest);
3575 _ => panic!("Unexpected event"),
3579 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4, 1_000_000);
3580 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3583 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
3584 // Test that we can reconnect when in-flight HTLC updates get dropped
3585 let chanmon_cfgs = create_chanmon_cfgs(2);
3586 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3587 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3588 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3589 if messages_delivered == 0 {
3590 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3591 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3593 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3596 let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
3598 let logger = test_utils::TestLogger::new();
3599 let payment_event = {
3600 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3601 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(), Some(&nodes[0].node.list_usable_channels()), &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3602 nodes[0].node.send_payment(&route, payment_hash_1, &None).unwrap();
3603 check_added_monitors!(nodes[0], 1);
3605 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3606 assert_eq!(events.len(), 1);
3607 SendEvent::from_event(events.remove(0))
3609 assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3611 if messages_delivered < 2 {
3612 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3614 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3615 if messages_delivered >= 3 {
3616 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3617 check_added_monitors!(nodes[1], 1);
3618 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3620 if messages_delivered >= 4 {
3621 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3622 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3623 check_added_monitors!(nodes[0], 1);
3625 if messages_delivered >= 5 {
3626 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3627 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3628 // No commitment_signed so get_event_msg's assert(len == 1) passes
3629 check_added_monitors!(nodes[0], 1);
3631 if messages_delivered >= 6 {
3632 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3633 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3634 check_added_monitors!(nodes[1], 1);
3641 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3642 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3643 if messages_delivered < 3 {
3644 // Even if the funding_locked messages get exchanged, as long as nothing further was
3645 // received on either side, both sides will need to resend them.
3646 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3647 } else if messages_delivered == 3 {
3648 // nodes[0] still wants its RAA + commitment_signed
3649 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3650 } else if messages_delivered == 4 {
3651 // nodes[0] still wants its commitment_signed
3652 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3653 } else if messages_delivered == 5 {
3654 // nodes[1] still wants its final RAA
3655 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3656 } else if messages_delivered == 6 {
3657 // Everything was delivered...
3658 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3661 let events_1 = nodes[1].node.get_and_clear_pending_events();
3662 assert_eq!(events_1.len(), 1);
3664 Event::PendingHTLCsForwardable { .. } => { },
3665 _ => panic!("Unexpected event"),
3668 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3669 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3670 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3672 nodes[1].node.process_pending_htlc_forwards();
3674 let events_2 = nodes[1].node.get_and_clear_pending_events();
3675 assert_eq!(events_2.len(), 1);
3677 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
3678 assert_eq!(payment_hash_1, *payment_hash);
3679 assert_eq!(*payment_secret, None);
3680 assert_eq!(amt, 1000000);
3682 _ => panic!("Unexpected event"),
3685 nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000);
3686 check_added_monitors!(nodes[1], 1);
3688 let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3689 assert_eq!(events_3.len(), 1);
3690 let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3691 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3692 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3693 assert!(updates.update_add_htlcs.is_empty());
3694 assert!(updates.update_fail_htlcs.is_empty());
3695 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3696 assert!(updates.update_fail_malformed_htlcs.is_empty());
3697 assert!(updates.update_fee.is_none());
3698 (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3700 _ => panic!("Unexpected event"),
3703 if messages_delivered >= 1 {
3704 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3706 let events_4 = nodes[0].node.get_and_clear_pending_events();
3707 assert_eq!(events_4.len(), 1);
3709 Event::PaymentSent { ref payment_preimage } => {
3710 assert_eq!(payment_preimage_1, *payment_preimage);
3712 _ => panic!("Unexpected event"),
3715 if messages_delivered >= 2 {
3716 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3717 check_added_monitors!(nodes[0], 1);
3718 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3720 if messages_delivered >= 3 {
3721 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3722 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3723 check_added_monitors!(nodes[1], 1);
3725 if messages_delivered >= 4 {
3726 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3727 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3728 // No commitment_signed so get_event_msg's assert(len == 1) passes
3729 check_added_monitors!(nodes[1], 1);
3731 if messages_delivered >= 5 {
3732 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3733 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3734 check_added_monitors!(nodes[0], 1);
3741 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3742 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3743 if messages_delivered < 2 {
3744 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3745 //TODO: Deduplicate PaymentSent events, then enable this if:
3746 //if messages_delivered < 1 {
3747 let events_4 = nodes[0].node.get_and_clear_pending_events();
3748 assert_eq!(events_4.len(), 1);
3750 Event::PaymentSent { ref payment_preimage } => {
3751 assert_eq!(payment_preimage_1, *payment_preimage);
3753 _ => panic!("Unexpected event"),
3756 } else if messages_delivered == 2 {
3757 // nodes[0] still wants its RAA + commitment_signed
3758 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3759 } else if messages_delivered == 3 {
3760 // nodes[0] still wants its commitment_signed
3761 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3762 } else if messages_delivered == 4 {
3763 // nodes[1] still wants its final RAA
3764 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3765 } else if messages_delivered == 5 {
3766 // Everything was delivered...
3767 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3770 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3771 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3772 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3774 // Channel should still work fine...
3775 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3776 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(), Some(&nodes[0].node.list_usable_channels()), &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3777 let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3778 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3782 fn test_drop_messages_peer_disconnect_a() {
3783 do_test_drop_messages_peer_disconnect(0);
3784 do_test_drop_messages_peer_disconnect(1);
3785 do_test_drop_messages_peer_disconnect(2);
3786 do_test_drop_messages_peer_disconnect(3);
3790 fn test_drop_messages_peer_disconnect_b() {
3791 do_test_drop_messages_peer_disconnect(4);
3792 do_test_drop_messages_peer_disconnect(5);
3793 do_test_drop_messages_peer_disconnect(6);
3797 fn test_funding_peer_disconnect() {
3798 // Test that we can lock in our funding tx while disconnected
3799 let chanmon_cfgs = create_chanmon_cfgs(2);
3800 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3801 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3802 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3803 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3805 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3806 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3808 confirm_transaction(&nodes[0], &tx);
3809 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3810 assert_eq!(events_1.len(), 1);
3812 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3813 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3815 _ => panic!("Unexpected event"),
3818 reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3820 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3821 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3823 confirm_transaction(&nodes[1], &tx);
3824 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3825 assert_eq!(events_2.len(), 2);
3826 let funding_locked = match events_2[0] {
3827 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3828 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3831 _ => panic!("Unexpected event"),
3833 let bs_announcement_sigs = match events_2[1] {
3834 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3835 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3838 _ => panic!("Unexpected event"),
3841 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3843 nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3844 nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3845 let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3846 assert_eq!(events_3.len(), 2);
3847 let as_announcement_sigs = match events_3[0] {
3848 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3849 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3852 _ => panic!("Unexpected event"),
3854 let (as_announcement, as_update) = match events_3[1] {
3855 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3856 (msg.clone(), update_msg.clone())
3858 _ => panic!("Unexpected event"),
3861 nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3862 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3863 assert_eq!(events_4.len(), 1);
3864 let (_, bs_update) = match events_4[0] {
3865 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3866 (msg.clone(), update_msg.clone())
3868 _ => panic!("Unexpected event"),
3871 nodes[0].net_graph_msg_handler.handle_channel_announcement(&as_announcement).unwrap();
3872 nodes[0].net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
3873 nodes[0].net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
3875 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3876 let logger = test_utils::TestLogger::new();
3877 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();
3878 let (payment_preimage, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3879 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage, 1_000_000);
3883 fn test_drop_messages_peer_disconnect_dual_htlc() {
3884 // Test that we can handle reconnecting when both sides of a channel have pending
3885 // commitment_updates when we disconnect.
3886 let chanmon_cfgs = create_chanmon_cfgs(2);
3887 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3888 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3889 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3890 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3891 let logger = test_utils::TestLogger::new();
3893 let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3895 // Now try to send a second payment which will fail to send
3896 let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
3897 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3898 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();
3899 nodes[0].node.send_payment(&route, payment_hash_2, &None).unwrap();
3900 check_added_monitors!(nodes[0], 1);
3902 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3903 assert_eq!(events_1.len(), 1);
3905 MessageSendEvent::UpdateHTLCs { .. } => {},
3906 _ => panic!("Unexpected event"),
3909 assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000));
3910 check_added_monitors!(nodes[1], 1);
3912 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3913 assert_eq!(events_2.len(), 1);
3915 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 } } => {
3916 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3917 assert!(update_add_htlcs.is_empty());
3918 assert_eq!(update_fulfill_htlcs.len(), 1);
3919 assert!(update_fail_htlcs.is_empty());
3920 assert!(update_fail_malformed_htlcs.is_empty());
3921 assert!(update_fee.is_none());
3923 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3924 let events_3 = nodes[0].node.get_and_clear_pending_events();
3925 assert_eq!(events_3.len(), 1);
3927 Event::PaymentSent { ref payment_preimage } => {
3928 assert_eq!(*payment_preimage, payment_preimage_1);
3930 _ => panic!("Unexpected event"),
3933 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
3934 let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3935 // No commitment_signed so get_event_msg's assert(len == 1) passes
3936 check_added_monitors!(nodes[0], 1);
3938 _ => panic!("Unexpected event"),
3941 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3942 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3944 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3945 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3946 assert_eq!(reestablish_1.len(), 1);
3947 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3948 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3949 assert_eq!(reestablish_2.len(), 1);
3951 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3952 let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3953 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3954 let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3956 assert!(as_resp.0.is_none());
3957 assert!(bs_resp.0.is_none());
3959 assert!(bs_resp.1.is_none());
3960 assert!(bs_resp.2.is_none());
3962 assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3964 assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3965 assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3966 assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3967 assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3968 assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3969 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
3970 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
3971 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3972 // No commitment_signed so get_event_msg's assert(len == 1) passes
3973 check_added_monitors!(nodes[1], 1);
3975 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
3976 let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3977 assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
3978 assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
3979 assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
3980 assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
3981 assert!(bs_second_commitment_signed.update_fee.is_none());
3982 check_added_monitors!(nodes[1], 1);
3984 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3985 let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3986 assert!(as_commitment_signed.update_add_htlcs.is_empty());
3987 assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
3988 assert!(as_commitment_signed.update_fail_htlcs.is_empty());
3989 assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
3990 assert!(as_commitment_signed.update_fee.is_none());
3991 check_added_monitors!(nodes[0], 1);
3993 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
3994 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3995 // No commitment_signed so get_event_msg's assert(len == 1) passes
3996 check_added_monitors!(nodes[0], 1);
3998 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
3999 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4000 // No commitment_signed so get_event_msg's assert(len == 1) passes
4001 check_added_monitors!(nodes[1], 1);
4003 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
4004 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4005 check_added_monitors!(nodes[1], 1);
4007 expect_pending_htlcs_forwardable!(nodes[1]);
4009 let events_5 = nodes[1].node.get_and_clear_pending_events();
4010 assert_eq!(events_5.len(), 1);
4012 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt: _ } => {
4013 assert_eq!(payment_hash_2, *payment_hash);
4014 assert_eq!(*payment_secret, None);
4016 _ => panic!("Unexpected event"),
4019 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
4020 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4021 check_added_monitors!(nodes[0], 1);
4023 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
4026 fn do_test_htlc_timeout(send_partial_mpp: bool) {
4027 // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
4028 // to avoid our counterparty failing the channel.
4029 let chanmon_cfgs = create_chanmon_cfgs(2);
4030 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4031 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4032 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4034 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4035 let logger = test_utils::TestLogger::new();
4037 let our_payment_hash = if send_partial_mpp {
4038 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4039 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();
4040 let (_, our_payment_hash) = get_payment_preimage_hash!(&nodes[0]);
4041 let payment_secret = PaymentSecret([0xdb; 32]);
4042 // Use the utility function send_payment_along_path to send the payment with MPP data which
4043 // indicates there are more HTLCs coming.
4044 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200000, CHAN_CONFIRM_DEPTH).unwrap();
4045 check_added_monitors!(nodes[0], 1);
4046 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4047 assert_eq!(events.len(), 1);
4048 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
4049 // hop should *not* yet generate any PaymentReceived event(s).
4050 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false);
4053 route_payment(&nodes[0], &[&nodes[1]], 100000).1
4056 let mut block = Block {
4057 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
4060 connect_block(&nodes[0], &block, 101);
4061 connect_block(&nodes[1], &block, 101);
4062 for i in 102..TEST_FINAL_CLTV + 100 + 1 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS {
4063 block.header.prev_blockhash = block.bitcoin_hash();
4064 connect_block(&nodes[0], &block, i);
4065 connect_block(&nodes[1], &block, i);
4068 expect_pending_htlcs_forwardable!(nodes[1]);
4070 check_added_monitors!(nodes[1], 1);
4071 let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4072 assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
4073 assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
4074 assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
4075 assert!(htlc_timeout_updates.update_fee.is_none());
4077 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
4078 commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
4079 // 100_000 msat as u64, followed by a height of 123 as u32
4080 let mut expected_failure_data = byte_utils::be64_to_array(100_000).to_vec();
4081 expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(123));
4082 expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
4086 fn test_htlc_timeout() {
4087 do_test_htlc_timeout(true);
4088 do_test_htlc_timeout(false);
4091 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
4092 // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
4093 let chanmon_cfgs = create_chanmon_cfgs(3);
4094 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4095 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4096 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4097 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4098 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
4099 let logger = test_utils::TestLogger::new();
4101 // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
4102 let (_, first_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4104 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4105 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4106 nodes[1].node.send_payment(&route, first_payment_hash, &None).unwrap();
4108 assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
4109 check_added_monitors!(nodes[1], 1);
4111 // Now attempt to route a second payment, which should be placed in the holding cell
4112 let (_, second_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4114 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4115 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();
4116 nodes[0].node.send_payment(&route, second_payment_hash, &None).unwrap();
4117 check_added_monitors!(nodes[0], 1);
4118 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4119 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
4120 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4121 expect_pending_htlcs_forwardable!(nodes[1]);
4122 check_added_monitors!(nodes[1], 0);
4124 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4125 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();
4126 nodes[1].node.send_payment(&route, second_payment_hash, &None).unwrap();
4127 check_added_monitors!(nodes[1], 0);
4130 let mut block = Block {
4131 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
4134 connect_block(&nodes[1], &block, 101);
4135 for i in 102..TEST_FINAL_CLTV + 100 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS {
4136 block.header.prev_blockhash = block.bitcoin_hash();
4137 connect_block(&nodes[1], &block, i);
4140 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4141 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4143 block.header.prev_blockhash = block.bitcoin_hash();
4144 connect_block(&nodes[1], &block, TEST_FINAL_CLTV + 100 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS);
4147 expect_pending_htlcs_forwardable!(nodes[1]);
4148 check_added_monitors!(nodes[1], 1);
4149 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
4150 assert_eq!(fail_commit.len(), 1);
4151 match fail_commit[0] {
4152 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
4153 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
4154 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
4156 _ => unreachable!(),
4158 expect_payment_failed!(nodes[0], second_payment_hash, false);
4159 if let &MessageSendEvent::PaymentFailureNetworkUpdate { ref update } = &nodes[0].node.get_and_clear_pending_msg_events()[0] {
4161 &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {},
4162 _ => panic!("Unexpected event"),
4165 panic!("Unexpected event");
4168 expect_payment_failed!(nodes[1], second_payment_hash, true);
4173 fn test_holding_cell_htlc_add_timeouts() {
4174 do_test_holding_cell_htlc_add_timeouts(false);
4175 do_test_holding_cell_htlc_add_timeouts(true);
4179 fn test_invalid_channel_announcement() {
4180 //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
4181 let secp_ctx = Secp256k1::new();
4182 let chanmon_cfgs = create_chanmon_cfgs(2);
4183 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4184 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4185 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4187 let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
4189 let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
4190 let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
4191 let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4192 let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4194 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 } );
4196 let as_bitcoin_key = as_chan.get_local_keys().inner.local_channel_pubkeys.funding_pubkey;
4197 let bs_bitcoin_key = bs_chan.get_local_keys().inner.local_channel_pubkeys.funding_pubkey;
4199 let as_network_key = nodes[0].node.get_our_node_id();
4200 let bs_network_key = nodes[1].node.get_our_node_id();
4202 let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
4204 let mut chan_announcement;
4206 macro_rules! dummy_unsigned_msg {
4208 msgs::UnsignedChannelAnnouncement {
4209 features: ChannelFeatures::known(),
4210 chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
4211 short_channel_id: as_chan.get_short_channel_id().unwrap(),
4212 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
4213 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
4214 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
4215 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
4216 excess_data: Vec::new(),
4221 macro_rules! sign_msg {
4222 ($unsigned_msg: expr) => {
4223 let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
4224 let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_local_keys().inner.funding_key);
4225 let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_local_keys().inner.funding_key);
4226 let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
4227 let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
4228 chan_announcement = msgs::ChannelAnnouncement {
4229 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
4230 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
4231 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
4232 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
4233 contents: $unsigned_msg
4238 let unsigned_msg = dummy_unsigned_msg!();
4239 sign_msg!(unsigned_msg);
4240 assert_eq!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).unwrap(), true);
4241 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 } );
4243 // Configured with Network::Testnet
4244 let mut unsigned_msg = dummy_unsigned_msg!();
4245 unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.bitcoin_hash();
4246 sign_msg!(unsigned_msg);
4247 assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4249 let mut unsigned_msg = dummy_unsigned_msg!();
4250 unsigned_msg.chain_hash = BlockHash::hash(&[1,2,3,4,5,6,7,8,9]);
4251 sign_msg!(unsigned_msg);
4252 assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4256 fn test_no_txn_manager_serialize_deserialize() {
4257 let chanmon_cfgs = create_chanmon_cfgs(2);
4258 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4259 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4260 let logger: test_utils::TestLogger;
4261 let fee_estimator: test_utils::TestFeeEstimator;
4262 let new_chain_monitor: test_utils::TestChainMonitor;
4263 let keys_manager: test_utils::TestKeysInterface;
4264 let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4265 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4267 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
4269 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4271 let nodes_0_serialized = nodes[0].node.encode();
4272 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4273 nodes[0].chain_monitor.chain_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
4275 logger = test_utils::TestLogger::new();
4276 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4277 new_chain_monitor = test_utils::TestChainMonitor::new(nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator);
4278 nodes[0].chain_monitor = &new_chain_monitor;
4279 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4280 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read).unwrap();
4281 assert!(chan_0_monitor_read.is_empty());
4283 let mut nodes_0_read = &nodes_0_serialized[..];
4284 let config = UserConfig::default();
4285 keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
4286 let (_, nodes_0_deserialized_tmp) = {
4287 let mut channel_monitors = HashMap::new();
4288 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4289 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4290 default_config: config,
4291 keys_manager: &keys_manager,
4292 fee_estimator: &fee_estimator,
4293 chain_monitor: nodes[0].chain_monitor,
4294 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4296 channel_monitors: &mut channel_monitors,
4299 nodes_0_deserialized = nodes_0_deserialized_tmp;
4300 assert!(nodes_0_read.is_empty());
4302 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4303 nodes[0].node = &nodes_0_deserialized;
4304 assert_eq!(nodes[0].node.list_channels().len(), 1);
4305 check_added_monitors!(nodes[0], 1);
4307 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4308 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4309 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4310 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4312 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4313 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4314 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4315 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4317 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4318 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4319 for node in nodes.iter() {
4320 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4321 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4322 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4325 send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
4329 fn test_manager_serialize_deserialize_events() {
4330 // This test makes sure the events field in ChannelManager survives de/serialization
4331 let chanmon_cfgs = create_chanmon_cfgs(2);
4332 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4333 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4334 let fee_estimator: test_utils::TestFeeEstimator;
4335 let logger: test_utils::TestLogger;
4336 let new_chain_monitor: test_utils::TestChainMonitor;
4337 let keys_manager: test_utils::TestKeysInterface;
4338 let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4339 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4341 // Start creating a channel, but stop right before broadcasting the event message FundingBroadcastSafe
4342 let channel_value = 100000;
4343 let push_msat = 10001;
4344 let a_flags = InitFeatures::known();
4345 let b_flags = InitFeatures::known();
4346 let node_a = nodes.pop().unwrap();
4347 let node_b = nodes.pop().unwrap();
4348 node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
4349 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()));
4350 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()));
4352 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&node_a, channel_value, 42);
4354 node_a.node.funding_transaction_generated(&temporary_channel_id, funding_output);
4355 check_added_monitors!(node_a, 0);
4357 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()));
4359 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
4360 assert_eq!(added_monitors.len(), 1);
4361 assert_eq!(added_monitors[0].0, funding_output);
4362 added_monitors.clear();
4365 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()));
4367 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
4368 assert_eq!(added_monitors.len(), 1);
4369 assert_eq!(added_monitors[0].0, funding_output);
4370 added_monitors.clear();
4372 // Normally, this is where node_a would check for a FundingBroadcastSafe event, but the test de/serializes first instead
4377 // Start the de/seriailization process mid-channel creation to check that the channel manager will hold onto events that are serialized
4378 let nodes_0_serialized = nodes[0].node.encode();
4379 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4380 nodes[0].chain_monitor.chain_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
4382 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4383 logger = test_utils::TestLogger::new();
4384 new_chain_monitor = test_utils::TestChainMonitor::new(nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator);
4385 nodes[0].chain_monitor = &new_chain_monitor;
4386 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4387 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read).unwrap();
4388 assert!(chan_0_monitor_read.is_empty());
4390 let mut nodes_0_read = &nodes_0_serialized[..];
4391 let config = UserConfig::default();
4392 keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
4393 let (_, nodes_0_deserialized_tmp) = {
4394 let mut channel_monitors = HashMap::new();
4395 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4396 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4397 default_config: config,
4398 keys_manager: &keys_manager,
4399 fee_estimator: &fee_estimator,
4400 chain_monitor: nodes[0].chain_monitor,
4401 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4403 channel_monitors: &mut channel_monitors,
4406 nodes_0_deserialized = nodes_0_deserialized_tmp;
4407 assert!(nodes_0_read.is_empty());
4409 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4411 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4412 nodes[0].node = &nodes_0_deserialized;
4414 // After deserializing, make sure the FundingBroadcastSafe event is still held by the channel manager
4415 let events_4 = nodes[0].node.get_and_clear_pending_events();
4416 assert_eq!(events_4.len(), 1);
4418 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
4419 assert_eq!(user_channel_id, 42);
4420 assert_eq!(*funding_txo, funding_output);
4422 _ => panic!("Unexpected event"),
4425 // Make sure the channel is functioning as though the de/serialization never happened
4426 assert_eq!(nodes[0].node.list_channels().len(), 1);
4427 check_added_monitors!(nodes[0], 1);
4429 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4430 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4431 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4432 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4434 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4435 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4436 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4437 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4439 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4440 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4441 for node in nodes.iter() {
4442 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4443 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4444 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4447 send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
4451 fn test_simple_manager_serialize_deserialize() {
4452 let chanmon_cfgs = create_chanmon_cfgs(2);
4453 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4454 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4455 let logger: test_utils::TestLogger;
4456 let fee_estimator: test_utils::TestFeeEstimator;
4457 let new_chain_monitor: test_utils::TestChainMonitor;
4458 let keys_manager: test_utils::TestKeysInterface;
4459 let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4460 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4461 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4463 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4464 let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4466 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4468 let nodes_0_serialized = nodes[0].node.encode();
4469 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4470 nodes[0].chain_monitor.chain_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
4472 logger = test_utils::TestLogger::new();
4473 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4474 new_chain_monitor = test_utils::TestChainMonitor::new(nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator);
4475 nodes[0].chain_monitor = &new_chain_monitor;
4476 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4477 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read).unwrap();
4478 assert!(chan_0_monitor_read.is_empty());
4480 let mut nodes_0_read = &nodes_0_serialized[..];
4481 keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
4482 let (_, nodes_0_deserialized_tmp) = {
4483 let mut channel_monitors = HashMap::new();
4484 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4485 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4486 default_config: UserConfig::default(),
4487 keys_manager: &keys_manager,
4488 fee_estimator: &fee_estimator,
4489 chain_monitor: nodes[0].chain_monitor,
4490 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4492 channel_monitors: &mut channel_monitors,
4495 nodes_0_deserialized = nodes_0_deserialized_tmp;
4496 assert!(nodes_0_read.is_empty());
4498 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4499 nodes[0].node = &nodes_0_deserialized;
4500 check_added_monitors!(nodes[0], 1);
4502 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4504 fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
4505 claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage, 1_000_000);
4509 fn test_manager_serialize_deserialize_inconsistent_monitor() {
4510 // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
4511 let chanmon_cfgs = create_chanmon_cfgs(4);
4512 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4513 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4514 let logger: test_utils::TestLogger;
4515 let fee_estimator: test_utils::TestFeeEstimator;
4516 let new_chain_monitor: test_utils::TestChainMonitor;
4517 let keys_manager: test_utils::TestKeysInterface;
4518 let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4519 let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4520 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4521 create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::known(), InitFeatures::known());
4522 let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
4524 let mut node_0_stale_monitors_serialized = Vec::new();
4525 for monitor in nodes[0].chain_monitor.chain_monitor.monitors.lock().unwrap().iter() {
4526 let mut writer = test_utils::TestVecWriter(Vec::new());
4527 monitor.1.write_for_disk(&mut writer).unwrap();
4528 node_0_stale_monitors_serialized.push(writer.0);
4531 let (our_payment_preimage, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
4533 // Serialize the ChannelManager here, but the monitor we keep up-to-date
4534 let nodes_0_serialized = nodes[0].node.encode();
4536 route_payment(&nodes[0], &[&nodes[3]], 1000000);
4537 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4538 nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4539 nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4541 // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
4543 let mut node_0_monitors_serialized = Vec::new();
4544 for monitor in nodes[0].chain_monitor.chain_monitor.monitors.lock().unwrap().iter() {
4545 let mut writer = test_utils::TestVecWriter(Vec::new());
4546 monitor.1.write_for_disk(&mut writer).unwrap();
4547 node_0_monitors_serialized.push(writer.0);
4550 logger = test_utils::TestLogger::new();
4551 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4552 new_chain_monitor = test_utils::TestChainMonitor::new(nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator);
4553 nodes[0].chain_monitor = &new_chain_monitor;
4555 let mut node_0_stale_monitors = Vec::new();
4556 for serialized in node_0_stale_monitors_serialized.iter() {
4557 let mut read = &serialized[..];
4558 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut read).unwrap();
4559 assert!(read.is_empty());
4560 node_0_stale_monitors.push(monitor);
4563 let mut node_0_monitors = Vec::new();
4564 for serialized in node_0_monitors_serialized.iter() {
4565 let mut read = &serialized[..];
4566 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut read).unwrap();
4567 assert!(read.is_empty());
4568 node_0_monitors.push(monitor);
4571 keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
4573 let mut nodes_0_read = &nodes_0_serialized[..];
4574 if let Err(msgs::DecodeError::InvalidValue) =
4575 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4576 default_config: UserConfig::default(),
4577 keys_manager: &keys_manager,
4578 fee_estimator: &fee_estimator,
4579 chain_monitor: nodes[0].chain_monitor,
4580 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4582 channel_monitors: &mut node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4584 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
4587 let mut nodes_0_read = &nodes_0_serialized[..];
4588 let (_, nodes_0_deserialized_tmp) =
4589 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4590 default_config: UserConfig::default(),
4591 keys_manager: &keys_manager,
4592 fee_estimator: &fee_estimator,
4593 chain_monitor: nodes[0].chain_monitor,
4594 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4596 channel_monitors: &mut node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4598 nodes_0_deserialized = nodes_0_deserialized_tmp;
4599 assert!(nodes_0_read.is_empty());
4601 { // Channel close should result in a commitment tx and an HTLC tx
4602 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4603 assert_eq!(txn.len(), 2);
4604 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
4605 assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
4608 for monitor in node_0_monitors.drain(..) {
4609 assert!(nodes[0].chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor).is_ok());
4610 check_added_monitors!(nodes[0], 1);
4612 nodes[0].node = &nodes_0_deserialized;
4614 // nodes[1] and nodes[2] have no lost state with nodes[0]...
4615 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4616 reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4617 //... and we can even still claim the payment!
4618 claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage, 1_000_000);
4620 nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4621 let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4622 nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4623 nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
4624 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4625 assert_eq!(msg_events.len(), 1);
4626 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
4628 &ErrorAction::SendErrorMessage { ref msg } => {
4629 assert_eq!(msg.channel_id, channel_id);
4631 _ => panic!("Unexpected event!"),
4636 macro_rules! check_spendable_outputs {
4637 ($node: expr, $der_idx: expr, $keysinterface: expr, $chan_value: expr) => {
4639 let events = $node.chain_monitor.chain_monitor.get_and_clear_pending_events();
4640 let mut txn = Vec::new();
4641 for event in events {
4643 Event::SpendableOutputs { ref outputs } => {
4644 for outp in outputs {
4646 SpendableOutputDescriptor::StaticOutputRemotePayment { ref outpoint, ref output, ref key_derivation_params } => {
4648 previous_output: outpoint.clone(),
4649 script_sig: Script::new(),
4651 witness: Vec::new(),
4654 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4655 value: output.value,
4657 let mut spend_tx = Transaction {
4663 let secp_ctx = Secp256k1::new();
4664 let keys = $keysinterface.derive_channel_keys($chan_value, key_derivation_params.0, key_derivation_params.1);
4665 let remotepubkey = keys.pubkeys().payment_point;
4666 let witness_script = Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: remotepubkey}, Network::Testnet).script_pubkey();
4667 let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
4668 let remotesig = secp_ctx.sign(&sighash, &keys.inner.payment_key);
4669 spend_tx.input[0].witness.push(remotesig.serialize_der().to_vec());
4670 spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4671 spend_tx.input[0].witness.push(remotepubkey.serialize().to_vec());
4674 SpendableOutputDescriptor::DynamicOutputP2WSH { ref outpoint, ref per_commitment_point, ref to_self_delay, ref output, ref key_derivation_params, ref remote_revocation_pubkey } => {
4676 previous_output: outpoint.clone(),
4677 script_sig: Script::new(),
4678 sequence: *to_self_delay as u32,
4679 witness: Vec::new(),
4682 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4683 value: output.value,
4685 let mut spend_tx = Transaction {
4691 let secp_ctx = Secp256k1::new();
4692 let keys = $keysinterface.derive_channel_keys($chan_value, key_derivation_params.0, key_derivation_params.1);
4693 if let Ok(delayed_payment_key) = chan_utils::derive_private_key(&secp_ctx, &per_commitment_point, &keys.inner.delayed_payment_base_key) {
4695 let delayed_payment_pubkey = PublicKey::from_secret_key(&secp_ctx, &delayed_payment_key);
4696 let witness_script = chan_utils::get_revokeable_redeemscript(remote_revocation_pubkey, *to_self_delay, &delayed_payment_pubkey);
4697 let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
4698 let local_delayedsig = secp_ctx.sign(&sighash, &delayed_payment_key);
4699 spend_tx.input[0].witness.push(local_delayedsig.serialize_der().to_vec());
4700 spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4701 spend_tx.input[0].witness.push(vec!()); //MINIMALIF
4702 spend_tx.input[0].witness.push(witness_script.clone().into_bytes());
4706 SpendableOutputDescriptor::StaticOutput { ref outpoint, ref output } => {
4707 let secp_ctx = Secp256k1::new();
4709 previous_output: outpoint.clone(),
4710 script_sig: Script::new(),
4712 witness: Vec::new(),
4715 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4716 value: output.value,
4718 let mut spend_tx = Transaction {
4722 output: vec![outp.clone()],
4725 match ExtendedPrivKey::new_master(Network::Testnet, &$node.node_seed) {
4727 match master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx($der_idx).expect("key space exhausted")) {
4729 Err(_) => panic!("Your RNG is busted"),
4732 Err(_) => panic!("Your rng is busted"),
4735 let pubkey = ExtendedPubKey::from_private(&secp_ctx, &secret).public_key;
4736 let witness_script = Address::p2pkh(&pubkey, Network::Testnet).script_pubkey();
4737 let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
4738 let sig = secp_ctx.sign(&sighash, &secret.private_key.key);
4739 spend_tx.input[0].witness.push(sig.serialize_der().to_vec());
4740 spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4741 spend_tx.input[0].witness.push(pubkey.key.serialize().to_vec());
4747 _ => panic!("Unexpected event"),
4756 fn test_claim_sizeable_push_msat() {
4757 // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4758 let chanmon_cfgs = create_chanmon_cfgs(2);
4759 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4760 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4761 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4763 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4764 nodes[1].node.force_close_channel(&chan.2);
4765 check_closed_broadcast!(nodes[1], false);
4766 check_added_monitors!(nodes[1], 1);
4767 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4768 assert_eq!(node_txn.len(), 1);
4769 check_spends!(node_txn[0], chan.3);
4770 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
4772 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4773 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone()] }, 0);
4774 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4776 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4777 assert_eq!(spend_txn.len(), 1);
4778 check_spends!(spend_txn[0], node_txn[0]);
4782 fn test_claim_on_remote_sizeable_push_msat() {
4783 // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4784 // to_remote output is encumbered by a P2WPKH
4785 let chanmon_cfgs = create_chanmon_cfgs(2);
4786 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4787 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4788 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4790 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4791 nodes[0].node.force_close_channel(&chan.2);
4792 check_closed_broadcast!(nodes[0], false);
4793 check_added_monitors!(nodes[0], 1);
4795 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4796 assert_eq!(node_txn.len(), 1);
4797 check_spends!(node_txn[0], chan.3);
4798 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
4800 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4801 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone()] }, 0);
4802 check_closed_broadcast!(nodes[1], false);
4803 check_added_monitors!(nodes[1], 1);
4804 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4806 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4807 assert_eq!(spend_txn.len(), 2);
4808 assert_eq!(spend_txn[0], spend_txn[1]);
4809 check_spends!(spend_txn[0], node_txn[0]);
4813 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4814 // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4815 // to_remote output is encumbered by a P2WPKH
4817 let chanmon_cfgs = create_chanmon_cfgs(2);
4818 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4819 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4820 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4822 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::known(), InitFeatures::known());
4823 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4824 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4825 assert_eq!(revoked_local_txn[0].input.len(), 1);
4826 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4828 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4829 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4830 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 0);
4831 check_closed_broadcast!(nodes[1], false);
4832 check_added_monitors!(nodes[1], 1);
4834 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4835 let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4836 connect_block(&nodes[1], &Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4837 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4839 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4840 assert_eq!(spend_txn.len(), 3);
4841 assert_eq!(spend_txn[0], spend_txn[1]); // to_remote output on revoked remote commitment_tx
4842 check_spends!(spend_txn[0], revoked_local_txn[0]);
4843 check_spends!(spend_txn[2], node_txn[0]);
4847 fn test_static_spendable_outputs_preimage_tx() {
4848 let chanmon_cfgs = create_chanmon_cfgs(2);
4849 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4850 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4851 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4853 // Create some initial channels
4854 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4856 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4858 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4859 assert_eq!(commitment_tx[0].input.len(), 1);
4860 assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4862 // Settle A's commitment tx on B's chain
4863 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4864 assert!(nodes[1].node.claim_funds(payment_preimage, &None, 3_000_000));
4865 check_added_monitors!(nodes[1], 1);
4866 connect_block(&nodes[1], &Block { header, txdata: vec![commitment_tx[0].clone()] }, 1);
4867 check_added_monitors!(nodes[1], 1);
4868 let events = nodes[1].node.get_and_clear_pending_msg_events();
4870 MessageSendEvent::UpdateHTLCs { .. } => {},
4871 _ => panic!("Unexpected event"),
4874 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4875 _ => panic!("Unexepected event"),
4878 // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4879 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4880 assert_eq!(node_txn.len(), 3);
4881 check_spends!(node_txn[0], commitment_tx[0]);
4882 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4883 check_spends!(node_txn[1], chan_1.3);
4884 check_spends!(node_txn[2], node_txn[1]);
4886 let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4887 connect_block(&nodes[1], &Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4888 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4890 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4891 assert_eq!(spend_txn.len(), 1);
4892 check_spends!(spend_txn[0], node_txn[0]);
4896 fn test_static_spendable_outputs_timeout_tx() {
4897 let chanmon_cfgs = create_chanmon_cfgs(2);
4898 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4899 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4900 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4902 // Create some initial channels
4903 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4905 // Rebalance the network a bit by relaying one payment through all the channels ...
4906 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
4908 let (_, our_payment_hash) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
4910 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4911 assert_eq!(commitment_tx[0].input.len(), 1);
4912 assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4914 // Settle A's commitment tx on B' chain
4915 let header = BlockHeader { version: 0x2000_0000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
4916 connect_block(&nodes[1], &Block { header, txdata: vec![commitment_tx[0].clone()] }, 0);
4917 check_added_monitors!(nodes[1], 1);
4918 let events = nodes[1].node.get_and_clear_pending_msg_events();
4920 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4921 _ => panic!("Unexpected event"),
4924 // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
4925 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4926 assert_eq!(node_txn.len(), 3); // ChannelManager : 2 (local commitent tx + HTLC-timeout), ChannelMonitor: timeout tx
4927 check_spends!(node_txn[0], commitment_tx[0].clone());
4928 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4929 check_spends!(node_txn[1], chan_1.3.clone());
4930 check_spends!(node_txn[2], node_txn[1]);
4932 let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4933 connect_block(&nodes[1], &Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4934 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4935 expect_payment_failed!(nodes[1], our_payment_hash, true);
4937 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4938 assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote (*2), timeout_tx.output (*1)
4939 check_spends!(spend_txn[2], node_txn[0].clone());
4943 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
4944 let chanmon_cfgs = create_chanmon_cfgs(2);
4945 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4946 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4947 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4949 // Create some initial channels
4950 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4952 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4953 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4954 assert_eq!(revoked_local_txn[0].input.len(), 1);
4955 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4957 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4959 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4960 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 0);
4961 check_closed_broadcast!(nodes[1], false);
4962 check_added_monitors!(nodes[1], 1);
4964 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4965 assert_eq!(node_txn.len(), 2);
4966 assert_eq!(node_txn[0].input.len(), 2);
4967 check_spends!(node_txn[0], revoked_local_txn[0]);
4969 let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4970 connect_block(&nodes[1], &Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4971 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4973 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4974 assert_eq!(spend_txn.len(), 1);
4975 check_spends!(spend_txn[0], node_txn[0]);
4979 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
4980 let chanmon_cfgs = create_chanmon_cfgs(2);
4981 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4982 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4983 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4985 // Create some initial channels
4986 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4988 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4989 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4990 assert_eq!(revoked_local_txn[0].input.len(), 1);
4991 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4993 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4995 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4996 // A will generate HTLC-Timeout from revoked commitment tx
4997 connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4998 check_closed_broadcast!(nodes[0], false);
4999 check_added_monitors!(nodes[0], 1);
5001 let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5002 assert_eq!(revoked_htlc_txn.len(), 2);
5003 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
5004 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5005 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
5006 check_spends!(revoked_htlc_txn[1], chan_1.3);
5008 // B will generate justice tx from A's revoked commitment/HTLC tx
5009 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 0);
5010 check_closed_broadcast!(nodes[1], false);
5011 check_added_monitors!(nodes[1], 1);
5013 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5014 assert_eq!(node_txn.len(), 4); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-timeout, adjusted justice tx, ChannelManager: local commitment tx
5015 assert_eq!(node_txn[0].input.len(), 2);
5016 check_spends!(node_txn[0], revoked_local_txn[0]);
5017 assert_eq!(node_txn[1].input.len(), 1);
5018 check_spends!(node_txn[1], revoked_htlc_txn[0]);
5019 assert_eq!(node_txn[2].input.len(), 1);
5020 check_spends!(node_txn[2], revoked_local_txn[0]);
5021 check_spends!(node_txn[3], chan_1.3);
5023 let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5024 connect_block(&nodes[1], &Block { header: header_1, txdata: vec![node_txn[0].clone(), node_txn[2].clone()] }, 1);
5025 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
5027 // Check B's ChannelMonitor was able to generate the right spendable output descriptor
5028 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5029 assert_eq!(spend_txn.len(), 2);
5030 check_spends!(spend_txn[0], node_txn[0]);
5031 check_spends!(spend_txn[1], node_txn[2]);
5035 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
5036 let chanmon_cfgs = create_chanmon_cfgs(2);
5037 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5038 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5039 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5041 // Create some initial channels
5042 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5044 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5045 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5046 assert_eq!(revoked_local_txn[0].input.len(), 1);
5047 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5049 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
5051 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5052 // B will generate HTLC-Success from revoked commitment tx
5053 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5054 check_closed_broadcast!(nodes[1], false);
5055 check_added_monitors!(nodes[1], 1);
5056 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5058 assert_eq!(revoked_htlc_txn.len(), 2);
5059 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
5060 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5061 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
5063 // A will generate justice tx from B's revoked commitment/HTLC tx
5064 connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
5065 check_closed_broadcast!(nodes[0], false);
5066 check_added_monitors!(nodes[0], 1);
5068 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5069 assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
5070 assert_eq!(node_txn[1].input.len(), 1);
5071 check_spends!(node_txn[1], revoked_htlc_txn[0]);
5073 let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5074 connect_block(&nodes[0], &Block { header: header_1, txdata: vec![node_txn[0].clone(), node_txn[2].clone()] }, 1);
5075 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
5077 // Check A's ChannelMonitor was able to generate the right spendable output descriptor
5078 let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
5079 assert_eq!(spend_txn.len(), 5); // Duplicated SpendableOutput due to block rescan after revoked htlc output tracking
5080 assert_eq!(spend_txn[0], spend_txn[1]);
5081 assert_eq!(spend_txn[0], spend_txn[2]);
5082 check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
5083 check_spends!(spend_txn[3], node_txn[0]); // spending justice tx output from revoked local tx htlc received output
5084 check_spends!(spend_txn[4], node_txn[2]); // spending justice tx output on htlc success tx
5088 fn test_onchain_to_onchain_claim() {
5089 // Test that in case of channel closure, we detect the state of output and claim HTLC
5090 // on downstream peer's remote commitment tx.
5091 // First, have C claim an HTLC against its own latest commitment transaction.
5092 // Then, broadcast these to B, which should update the monitor downstream on the A<->B
5094 // Finally, check that B will claim the HTLC output if A's latest commitment transaction
5097 let chanmon_cfgs = create_chanmon_cfgs(3);
5098 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5099 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5100 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5102 // Create some initial channels
5103 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5104 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5106 // Rebalance the network a bit by relaying one payment through all the channels ...
5107 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
5108 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
5110 let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
5111 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
5112 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
5113 check_spends!(commitment_tx[0], chan_2.3);
5114 nodes[2].node.claim_funds(payment_preimage, &None, 3_000_000);
5115 check_added_monitors!(nodes[2], 1);
5116 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5117 assert!(updates.update_add_htlcs.is_empty());
5118 assert!(updates.update_fail_htlcs.is_empty());
5119 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5120 assert!(updates.update_fail_malformed_htlcs.is_empty());
5122 connect_block(&nodes[2], &Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
5123 check_closed_broadcast!(nodes[2], false);
5124 check_added_monitors!(nodes[2], 1);
5126 let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
5127 assert_eq!(c_txn.len(), 3);
5128 assert_eq!(c_txn[0], c_txn[2]);
5129 assert_eq!(commitment_tx[0], c_txn[1]);
5130 check_spends!(c_txn[1], chan_2.3);
5131 check_spends!(c_txn[2], c_txn[1]);
5132 assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
5133 assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5134 assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5135 assert_eq!(c_txn[0].lock_time, 0); // Success tx
5137 // 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
5138 connect_block(&nodes[1], &Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]}, 1);
5140 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5141 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-timeout tx
5142 assert_eq!(b_txn.len(), 3);
5143 check_spends!(b_txn[1], chan_2.3); // B local commitment tx, issued by ChannelManager
5144 check_spends!(b_txn[2], b_txn[1]); // HTLC-Timeout on B local commitment tx, issued by ChannelManager
5145 assert_eq!(b_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5146 assert!(b_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5147 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
5148 check_spends!(b_txn[0], c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor, * 2 due to block rescan
5149 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5150 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5151 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
5154 check_added_monitors!(nodes[1], 1);
5155 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5156 check_added_monitors!(nodes[1], 1);
5157 match msg_events[0] {
5158 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5159 _ => panic!("Unexpected event"),
5161 match msg_events[1] {
5162 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, .. } } => {
5163 assert!(update_add_htlcs.is_empty());
5164 assert!(update_fail_htlcs.is_empty());
5165 assert_eq!(update_fulfill_htlcs.len(), 1);
5166 assert!(update_fail_malformed_htlcs.is_empty());
5167 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
5169 _ => panic!("Unexpected event"),
5171 // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
5172 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5173 connect_block(&nodes[1], &Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
5174 let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5175 // ChannelMonitor: HTLC-Success tx, ChannelManager: local commitment tx + HTLC-Success tx
5176 assert_eq!(b_txn.len(), 3);
5177 check_spends!(b_txn[1], chan_1.3);
5178 check_spends!(b_txn[2], b_txn[1]);
5179 check_spends!(b_txn[0], commitment_tx[0]);
5180 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5181 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5182 assert_eq!(b_txn[0].lock_time, 0); // Success tx
5184 check_closed_broadcast!(nodes[1], false);
5185 check_added_monitors!(nodes[1], 1);
5189 fn test_duplicate_payment_hash_one_failure_one_success() {
5190 // Topology : A --> B --> C
5191 // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
5192 let chanmon_cfgs = create_chanmon_cfgs(3);
5193 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5194 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5195 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5197 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5198 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5200 let (our_payment_preimage, duplicate_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
5201 *nodes[0].network_payment_count.borrow_mut() -= 1;
5202 assert_eq!(route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000).1, duplicate_payment_hash);
5204 let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
5205 assert_eq!(commitment_txn[0].input.len(), 1);
5206 check_spends!(commitment_txn[0], chan_2.3);
5208 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5209 connect_block(&nodes[1], &Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
5210 check_closed_broadcast!(nodes[1], false);
5211 check_added_monitors!(nodes[1], 1);
5213 let htlc_timeout_tx;
5214 { // Extract one of the two HTLC-Timeout transaction
5215 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5216 // ChannelMonitor: timeout tx * 2, ChannelManager: local commitment tx + HTLC-timeout * 2
5217 assert_eq!(node_txn.len(), 5);
5218 check_spends!(node_txn[0], commitment_txn[0]);
5219 assert_eq!(node_txn[0].input.len(), 1);
5220 check_spends!(node_txn[1], commitment_txn[0]);
5221 assert_eq!(node_txn[1].input.len(), 1);
5222 assert_ne!(node_txn[0].input[0], node_txn[1].input[0]);
5223 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5224 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5225 check_spends!(node_txn[2], chan_2.3);
5226 check_spends!(node_txn[3], node_txn[2]);
5227 check_spends!(node_txn[4], node_txn[2]);
5228 htlc_timeout_tx = node_txn[1].clone();
5231 nodes[2].node.claim_funds(our_payment_preimage, &None, 900_000);
5232 connect_block(&nodes[2], &Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
5233 check_added_monitors!(nodes[2], 3);
5234 let events = nodes[2].node.get_and_clear_pending_msg_events();
5236 MessageSendEvent::UpdateHTLCs { .. } => {},
5237 _ => panic!("Unexpected event"),
5240 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5241 _ => panic!("Unexepected event"),
5243 let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5244 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)
5245 check_spends!(htlc_success_txn[2], chan_2.3);
5246 check_spends!(htlc_success_txn[3], htlc_success_txn[2]);
5247 check_spends!(htlc_success_txn[4], htlc_success_txn[2]);
5248 assert_eq!(htlc_success_txn[0], htlc_success_txn[3]);
5249 assert_eq!(htlc_success_txn[0].input.len(), 1);
5250 assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5251 assert_eq!(htlc_success_txn[1], htlc_success_txn[4]);
5252 assert_eq!(htlc_success_txn[1].input.len(), 1);
5253 assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5254 assert_ne!(htlc_success_txn[0].input[0], htlc_success_txn[1].input[0]);
5255 check_spends!(htlc_success_txn[0], commitment_txn[0]);
5256 check_spends!(htlc_success_txn[1], commitment_txn[0]);
5258 connect_block(&nodes[1], &Block { header, txdata: vec![htlc_timeout_tx] }, 200);
5259 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
5260 expect_pending_htlcs_forwardable!(nodes[1]);
5261 let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5262 assert!(htlc_updates.update_add_htlcs.is_empty());
5263 assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5264 assert_eq!(htlc_updates.update_fail_htlcs[0].htlc_id, 1);
5265 assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5266 assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5267 check_added_monitors!(nodes[1], 1);
5269 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
5270 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5272 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5273 let events = nodes[0].node.get_and_clear_pending_msg_events();
5274 assert_eq!(events.len(), 1);
5276 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. } } => {
5278 _ => { panic!("Unexpected event"); }
5281 expect_payment_failed!(nodes[0], duplicate_payment_hash, false);
5283 // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5284 connect_block(&nodes[1], &Block { header, txdata: vec![htlc_success_txn[0].clone()] }, 200);
5285 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5286 assert!(updates.update_add_htlcs.is_empty());
5287 assert!(updates.update_fail_htlcs.is_empty());
5288 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5289 assert_eq!(updates.update_fulfill_htlcs[0].htlc_id, 0);
5290 assert!(updates.update_fail_malformed_htlcs.is_empty());
5291 check_added_monitors!(nodes[1], 1);
5293 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
5294 commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5296 let events = nodes[0].node.get_and_clear_pending_events();
5298 Event::PaymentSent { ref payment_preimage } => {
5299 assert_eq!(*payment_preimage, our_payment_preimage);
5301 _ => panic!("Unexpected event"),
5306 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
5307 let chanmon_cfgs = create_chanmon_cfgs(2);
5308 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5309 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5310 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5312 // Create some initial channels
5313 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5315 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5316 let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5317 assert_eq!(local_txn[0].input.len(), 1);
5318 check_spends!(local_txn[0], chan_1.3);
5320 // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5321 nodes[1].node.claim_funds(payment_preimage, &None, 9_000_000);
5322 check_added_monitors!(nodes[1], 1);
5323 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5324 connect_block(&nodes[1], &Block { header, txdata: vec![local_txn[0].clone()] }, 1);
5325 check_added_monitors!(nodes[1], 1);
5326 let events = nodes[1].node.get_and_clear_pending_msg_events();
5328 MessageSendEvent::UpdateHTLCs { .. } => {},
5329 _ => panic!("Unexpected event"),
5332 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5333 _ => panic!("Unexepected event"),
5336 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5337 assert_eq!(node_txn[0].input.len(), 1);
5338 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5339 check_spends!(node_txn[0], local_txn[0]);
5340 vec![node_txn[0].clone(), node_txn[2].clone()]
5343 let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5344 connect_block(&nodes[1], &Block { header: header_201, txdata: node_txn.clone() }, 201);
5345 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 201, true, header_201.bitcoin_hash());
5347 // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5348 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5349 assert_eq!(spend_txn.len(), 2);
5350 check_spends!(spend_txn[0], node_txn[0]);
5351 check_spends!(spend_txn[1], node_txn[1]);
5354 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
5355 // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
5356 // unrevoked commitment transaction.
5357 // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
5358 // a remote RAA before they could be failed backwards (and combinations thereof).
5359 // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
5360 // use the same payment hashes.
5361 // Thus, we use a six-node network:
5366 // And test where C fails back to A/B when D announces its latest commitment transaction
5367 let chanmon_cfgs = create_chanmon_cfgs(6);
5368 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
5369 let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
5370 let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
5371 let logger = test_utils::TestLogger::new();
5373 create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5374 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5375 let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5376 create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
5377 create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
5379 // Rebalance and check output sanity...
5380 send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000, 500_000);
5381 send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000, 500_000);
5382 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
5384 let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
5386 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
5388 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
5389 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
5390 let our_node_id = &nodes[1].node.get_our_node_id();
5391 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();
5393 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
5395 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
5397 let (_, payment_hash_3) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5399 let (_, payment_hash_4) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5400 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();
5402 send_along_route_with_hash(&nodes[1], route.clone(), &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_3);
5404 send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_4);
5407 let (_, payment_hash_5) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5409 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();
5410 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
5413 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
5415 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();
5416 send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_6);
5418 // Double-check that six of the new HTLC were added
5419 // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
5420 // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
5421 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
5422 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
5424 // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
5425 // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
5426 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1, &None));
5427 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3, &None));
5428 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5, &None));
5429 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6, &None));
5430 check_added_monitors!(nodes[4], 0);
5431 expect_pending_htlcs_forwardable!(nodes[4]);
5432 check_added_monitors!(nodes[4], 1);
5434 let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
5435 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
5436 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
5437 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
5438 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
5439 commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
5441 // Fail 3rd below-dust and 7th above-dust HTLCs
5442 assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2, &None));
5443 assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4, &None));
5444 check_added_monitors!(nodes[5], 0);
5445 expect_pending_htlcs_forwardable!(nodes[5]);
5446 check_added_monitors!(nodes[5], 1);
5448 let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5449 nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5450 nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5451 commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5453 let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5455 expect_pending_htlcs_forwardable!(nodes[3]);
5456 check_added_monitors!(nodes[3], 1);
5457 let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5458 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5459 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5460 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5461 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5462 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5463 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5464 if deliver_last_raa {
5465 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5467 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5470 // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5471 // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5472 // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5473 // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5475 // We now broadcast the latest commitment transaction, which *should* result in failures for
5476 // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5477 // the non-broadcast above-dust HTLCs.
5479 // Alternatively, we may broadcast the previous commitment transaction, which should only
5480 // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5481 let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5483 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5484 if announce_latest {
5485 connect_block(&nodes[2], &Block { header, txdata: vec![ds_last_commitment_tx[0].clone()]}, 1);
5487 connect_block(&nodes[2], &Block { header, txdata: vec![ds_prev_commitment_tx[0].clone()]}, 1);
5489 connect_blocks(&nodes[2], ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
5490 check_closed_broadcast!(nodes[2], false);
5491 expect_pending_htlcs_forwardable!(nodes[2]);
5492 check_added_monitors!(nodes[2], 3);
5494 let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5495 assert_eq!(cs_msgs.len(), 2);
5496 let mut a_done = false;
5497 for msg in cs_msgs {
5499 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5500 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5501 // should be failed-backwards here.
5502 let target = if *node_id == nodes[0].node.get_our_node_id() {
5503 // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5504 for htlc in &updates.update_fail_htlcs {
5505 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 });
5507 assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5512 // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5513 for htlc in &updates.update_fail_htlcs {
5514 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5516 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5517 assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5520 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5521 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5522 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5523 if announce_latest {
5524 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5525 if *node_id == nodes[0].node.get_our_node_id() {
5526 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5529 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5531 _ => panic!("Unexpected event"),
5535 let as_events = nodes[0].node.get_and_clear_pending_events();
5536 assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
5537 let mut as_failds = HashSet::new();
5538 for event in as_events.iter() {
5539 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5540 assert!(as_failds.insert(*payment_hash));
5541 if *payment_hash != payment_hash_2 {
5542 assert_eq!(*rejected_by_dest, deliver_last_raa);
5544 assert!(!rejected_by_dest);
5546 } else { panic!("Unexpected event"); }
5548 assert!(as_failds.contains(&payment_hash_1));
5549 assert!(as_failds.contains(&payment_hash_2));
5550 if announce_latest {
5551 assert!(as_failds.contains(&payment_hash_3));
5552 assert!(as_failds.contains(&payment_hash_5));
5554 assert!(as_failds.contains(&payment_hash_6));
5556 let bs_events = nodes[1].node.get_and_clear_pending_events();
5557 assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
5558 let mut bs_failds = HashSet::new();
5559 for event in bs_events.iter() {
5560 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5561 assert!(bs_failds.insert(*payment_hash));
5562 if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5563 assert_eq!(*rejected_by_dest, deliver_last_raa);
5565 assert!(!rejected_by_dest);
5567 } else { panic!("Unexpected event"); }
5569 assert!(bs_failds.contains(&payment_hash_1));
5570 assert!(bs_failds.contains(&payment_hash_2));
5571 if announce_latest {
5572 assert!(bs_failds.contains(&payment_hash_4));
5574 assert!(bs_failds.contains(&payment_hash_5));
5576 // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5577 // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
5578 // to unknown-preimage-etc, B should have gotten 2. Thus, in the
5579 // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
5580 // PaymentFailureNetworkUpdates.
5581 let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
5582 assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5583 let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5584 assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5585 for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
5587 &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
5588 _ => panic!("Unexpected event"),
5594 fn test_fail_backwards_latest_remote_announce_a() {
5595 do_test_fail_backwards_unrevoked_remote_announce(false, true);
5599 fn test_fail_backwards_latest_remote_announce_b() {
5600 do_test_fail_backwards_unrevoked_remote_announce(true, true);
5604 fn test_fail_backwards_previous_remote_announce() {
5605 do_test_fail_backwards_unrevoked_remote_announce(false, false);
5606 // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5607 // tested for in test_commitment_revoked_fail_backward_exhaustive()
5611 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5612 let chanmon_cfgs = create_chanmon_cfgs(2);
5613 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5614 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5615 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5617 // Create some initial channels
5618 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5620 let (_, our_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5621 let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5622 assert_eq!(local_txn[0].input.len(), 1);
5623 check_spends!(local_txn[0], chan_1.3);
5625 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5626 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5627 connect_block(&nodes[0], &Block { header, txdata: vec![local_txn[0].clone()] }, 200);
5628 check_closed_broadcast!(nodes[0], false);
5629 check_added_monitors!(nodes[0], 1);
5631 let htlc_timeout = {
5632 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5633 assert_eq!(node_txn[0].input.len(), 1);
5634 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5635 check_spends!(node_txn[0], local_txn[0]);
5639 let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5640 connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] }, 201);
5641 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 201, true, header_201.bitcoin_hash());
5642 expect_payment_failed!(nodes[0], our_payment_hash, true);
5644 // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5645 let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
5646 assert_eq!(spend_txn.len(), 3);
5647 assert_eq!(spend_txn[0], spend_txn[1]);
5648 check_spends!(spend_txn[0], local_txn[0]);
5649 check_spends!(spend_txn[2], htlc_timeout);
5653 fn test_key_derivation_params() {
5654 // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with
5655 // a key manager rotation to test that key_derivation_params returned in DynamicOutputP2WSH
5656 // let us re-derive the channel key set to then derive a delayed_payment_key.
5658 let chanmon_cfgs = create_chanmon_cfgs(3);
5660 // We manually create the node configuration to backup the seed.
5661 let seed = [42; 32];
5662 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5663 let chain_monitor = test_utils::TestChainMonitor::new(&chanmon_cfgs[0].tx_broadcaster, &chanmon_cfgs[0].logger, &chanmon_cfgs[0].fee_estimator);
5664 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, node_seed: seed };
5665 let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5666 node_cfgs.remove(0);
5667 node_cfgs.insert(0, node);
5669 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5670 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5672 // Create some initial channels
5673 // Create a dummy channel to advance index by one and thus test re-derivation correctness
5675 let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5676 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5677 assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5679 let (_, our_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5680 let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5681 let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5682 assert_eq!(local_txn_1[0].input.len(), 1);
5683 check_spends!(local_txn_1[0], chan_1.3);
5685 // We check funding pubkey are unique
5686 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]));
5687 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]));
5688 if from_0_funding_key_0 == from_1_funding_key_0
5689 || from_0_funding_key_0 == from_1_funding_key_1
5690 || from_0_funding_key_1 == from_1_funding_key_0
5691 || from_0_funding_key_1 == from_1_funding_key_1 {
5692 panic!("Funding pubkeys aren't unique");
5695 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5696 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5697 connect_block(&nodes[0], &Block { header, txdata: vec![local_txn_1[0].clone()] }, 200);
5698 check_closed_broadcast!(nodes[0], false);
5699 check_added_monitors!(nodes[0], 1);
5701 let htlc_timeout = {
5702 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5703 assert_eq!(node_txn[0].input.len(), 1);
5704 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5705 check_spends!(node_txn[0], local_txn_1[0]);
5709 let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5710 connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] }, 201);
5711 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 201, true, header_201.bitcoin_hash());
5712 expect_payment_failed!(nodes[0], our_payment_hash, true);
5714 // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5715 let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5716 let spend_txn = check_spendable_outputs!(nodes[0], 1, new_keys_manager, 100000);
5717 assert_eq!(spend_txn.len(), 3);
5718 assert_eq!(spend_txn[0], spend_txn[1]);
5719 check_spends!(spend_txn[0], local_txn_1[0]);
5720 check_spends!(spend_txn[2], htlc_timeout);
5724 fn test_static_output_closing_tx() {
5725 let chanmon_cfgs = create_chanmon_cfgs(2);
5726 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5727 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5728 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5730 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5732 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
5733 let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5735 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5736 connect_block(&nodes[0], &Block { header, txdata: vec![closing_tx.clone()] }, 0);
5737 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 0, true, header.bitcoin_hash());
5739 let spend_txn = check_spendable_outputs!(nodes[0], 2, node_cfgs[0].keys_manager, 100000);
5740 assert_eq!(spend_txn.len(), 1);
5741 check_spends!(spend_txn[0], closing_tx);
5743 connect_block(&nodes[1], &Block { header, txdata: vec![closing_tx.clone()] }, 0);
5744 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 0, true, header.bitcoin_hash());
5746 let spend_txn = check_spendable_outputs!(nodes[1], 2, node_cfgs[1].keys_manager, 100000);
5747 assert_eq!(spend_txn.len(), 1);
5748 check_spends!(spend_txn[0], closing_tx);
5751 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5752 let chanmon_cfgs = create_chanmon_cfgs(2);
5753 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5754 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5755 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5756 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5758 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5760 // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5761 // present in B's local commitment transaction, but none of A's commitment transactions.
5762 assert!(nodes[1].node.claim_funds(our_payment_preimage, &None, if use_dust { 50_000 } else { 3_000_000 }));
5763 check_added_monitors!(nodes[1], 1);
5765 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5766 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5767 let events = nodes[0].node.get_and_clear_pending_events();
5768 assert_eq!(events.len(), 1);
5770 Event::PaymentSent { payment_preimage } => {
5771 assert_eq!(payment_preimage, our_payment_preimage);
5773 _ => panic!("Unexpected event"),
5776 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5777 check_added_monitors!(nodes[0], 1);
5778 let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5779 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5780 check_added_monitors!(nodes[1], 1);
5782 let mut block = Block {
5783 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5786 for i in 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + CHAN_CONFIRM_DEPTH + 1 {
5787 connect_block(&nodes[1], &block, i);
5788 block.header.prev_blockhash = block.bitcoin_hash();
5790 test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5791 check_closed_broadcast!(nodes[1], false);
5792 check_added_monitors!(nodes[1], 1);
5795 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5796 let chanmon_cfgs = create_chanmon_cfgs(2);
5797 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5798 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5799 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5800 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5801 let logger = test_utils::TestLogger::new();
5803 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
5804 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5805 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();
5806 nodes[0].node.send_payment(&route, payment_hash, &None).unwrap();
5807 check_added_monitors!(nodes[0], 1);
5809 let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5811 // As far as A is concerned, the HTLC is now present only in the latest remote commitment
5812 // transaction, however it is not in A's latest local commitment, so we can just broadcast that
5813 // to "time out" the HTLC.
5815 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5817 for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
5818 connect_block(&nodes[0], &Block { header, txdata: Vec::new()}, i);
5819 header.prev_blockhash = header.bitcoin_hash();
5821 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5822 check_closed_broadcast!(nodes[0], false);
5823 check_added_monitors!(nodes[0], 1);
5826 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
5827 let chanmon_cfgs = create_chanmon_cfgs(3);
5828 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5829 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5830 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5831 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5833 // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
5834 // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
5835 // Also optionally test that we *don't* fail the channel in case the commitment transaction was
5836 // actually revoked.
5837 let htlc_value = if use_dust { 50000 } else { 3000000 };
5838 let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
5839 assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash, &None));
5840 expect_pending_htlcs_forwardable!(nodes[1]);
5841 check_added_monitors!(nodes[1], 1);
5843 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5844 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
5845 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5846 check_added_monitors!(nodes[0], 1);
5847 let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5848 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5849 check_added_monitors!(nodes[1], 1);
5850 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
5851 check_added_monitors!(nodes[1], 1);
5852 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
5854 if check_revoke_no_close {
5855 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
5856 check_added_monitors!(nodes[0], 1);
5859 let mut block = Block {
5860 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5863 for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
5864 connect_block(&nodes[0], &block, i);
5865 block.header.prev_blockhash = block.bitcoin_hash();
5867 if !check_revoke_no_close {
5868 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5869 check_closed_broadcast!(nodes[0], false);
5870 check_added_monitors!(nodes[0], 1);
5872 expect_payment_failed!(nodes[0], our_payment_hash, true);
5876 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
5877 // There are only a few cases to test here:
5878 // * its not really normative behavior, but we test that below-dust HTLCs "included" in
5879 // broadcastable commitment transactions result in channel closure,
5880 // * its included in an unrevoked-but-previous remote commitment transaction,
5881 // * its included in the latest remote or local commitment transactions.
5882 // We test each of the three possible commitment transactions individually and use both dust and
5884 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
5885 // assume they are handled the same across all six cases, as both outbound and inbound failures are
5886 // tested for at least one of the cases in other tests.
5888 fn htlc_claim_single_commitment_only_a() {
5889 do_htlc_claim_local_commitment_only(true);
5890 do_htlc_claim_local_commitment_only(false);
5892 do_htlc_claim_current_remote_commitment_only(true);
5893 do_htlc_claim_current_remote_commitment_only(false);
5897 fn htlc_claim_single_commitment_only_b() {
5898 do_htlc_claim_previous_remote_commitment_only(true, false);
5899 do_htlc_claim_previous_remote_commitment_only(false, false);
5900 do_htlc_claim_previous_remote_commitment_only(true, true);
5901 do_htlc_claim_previous_remote_commitment_only(false, true);
5904 fn run_onion_failure_test<F1,F2>(_name: &str, test_case: u8, nodes: &Vec<Node>, route: &Route, payment_hash: &PaymentHash, callback_msg: F1, callback_node: F2, expected_retryable: bool, expected_error_code: Option<u16>, expected_channel_update: Option<HTLCFailChannelUpdate>)
5905 where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
5908 run_onion_failure_test_with_fail_intercept(_name, test_case, nodes, route, payment_hash, callback_msg, |_|{}, callback_node, expected_retryable, expected_error_code, expected_channel_update);
5912 // 0: node1 fails backward
5913 // 1: final node fails backward
5914 // 2: payment completed but the user rejects the payment
5915 // 3: final node fails backward (but tamper onion payloads from node0)
5916 // 100: trigger error in the intermediate node and tamper returning fail_htlc
5917 // 200: trigger error in the final node and tamper returning fail_htlc
5918 fn run_onion_failure_test_with_fail_intercept<F1,F2,F3>(_name: &str, test_case: u8, nodes: &Vec<Node>, route: &Route, payment_hash: &PaymentHash, mut callback_msg: F1, mut callback_fail: F2, mut callback_node: F3, expected_retryable: bool, expected_error_code: Option<u16>, expected_channel_update: Option<HTLCFailChannelUpdate>)
5919 where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
5920 F2: for <'a> FnMut(&'a mut msgs::UpdateFailHTLC),
5924 // reset block height
5926 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5929 for ix in 0..nodes.len() {
5930 connect_block(&nodes[ix], &block, 1);
5933 macro_rules! expect_event {
5934 ($node: expr, $event_type: path) => {{
5935 let events = $node.node.get_and_clear_pending_events();
5936 assert_eq!(events.len(), 1);
5938 $event_type { .. } => {},
5939 _ => panic!("Unexpected event"),
5944 macro_rules! expect_htlc_forward {
5946 expect_event!($node, Event::PendingHTLCsForwardable);
5947 $node.node.process_pending_htlc_forwards();
5951 // 0 ~~> 2 send payment
5952 nodes[0].node.send_payment(&route, payment_hash.clone(), &None).unwrap();
5953 check_added_monitors!(nodes[0], 1);
5954 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5955 // temper update_add (0 => 1)
5956 let mut update_add_0 = update_0.update_add_htlcs[0].clone();
5957 if test_case == 0 || test_case == 3 || test_case == 100 {
5958 callback_msg(&mut update_add_0);
5961 // 0 => 1 update_add & CS
5962 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0);
5963 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
5965 let update_1_0 = match test_case {
5966 0|100 => { // intermediate node failure; fail backward to 0
5967 let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5968 assert!(update_1_0.update_fail_htlcs.len()+update_1_0.update_fail_malformed_htlcs.len()==1 && (update_1_0.update_fail_htlcs.len()==1 || update_1_0.update_fail_malformed_htlcs.len()==1));
5971 1|2|3|200 => { // final node failure; forwarding to 2
5972 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
5974 if test_case != 200 {
5977 expect_htlc_forward!(&nodes[1]);
5979 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
5980 check_added_monitors!(&nodes[1], 1);
5981 assert_eq!(update_1.update_add_htlcs.len(), 1);
5982 // tamper update_add (1 => 2)
5983 let mut update_add_1 = update_1.update_add_htlcs[0].clone();
5984 if test_case != 3 && test_case != 200 {
5985 callback_msg(&mut update_add_1);
5989 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1);
5990 commitment_signed_dance!(nodes[2], nodes[1], update_1.commitment_signed, false, true);
5992 if test_case == 2 || test_case == 200 {
5993 expect_htlc_forward!(&nodes[2]);
5994 expect_event!(&nodes[2], Event::PaymentReceived);
5996 expect_pending_htlcs_forwardable!(nodes[2]);
5999 let update_2_1 = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6000 if test_case == 2 || test_case == 200 {
6001 check_added_monitors!(&nodes[2], 1);
6003 assert!(update_2_1.update_fail_htlcs.len() == 1);
6005 let mut fail_msg = update_2_1.update_fail_htlcs[0].clone();
6006 if test_case == 200 {
6007 callback_fail(&mut fail_msg);
6011 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &fail_msg);
6012 commitment_signed_dance!(nodes[1], nodes[2], update_2_1.commitment_signed, true);
6014 // backward fail on 1
6015 let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6016 assert!(update_1_0.update_fail_htlcs.len() == 1);
6019 _ => unreachable!(),
6022 // 1 => 0 commitment_signed_dance
6023 if update_1_0.update_fail_htlcs.len() > 0 {
6024 let mut fail_msg = update_1_0.update_fail_htlcs[0].clone();
6025 if test_case == 100 {
6026 callback_fail(&mut fail_msg);
6028 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
6030 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_1_0.update_fail_malformed_htlcs[0]);
6033 commitment_signed_dance!(nodes[0], nodes[1], update_1_0.commitment_signed, false, true);
6035 let events = nodes[0].node.get_and_clear_pending_events();
6036 assert_eq!(events.len(), 1);
6037 if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code, error_data: _ } = &events[0] {
6038 assert_eq!(*rejected_by_dest, !expected_retryable);
6039 assert_eq!(*error_code, expected_error_code);
6041 panic!("Uexpected event");
6044 let events = nodes[0].node.get_and_clear_pending_msg_events();
6045 if expected_channel_update.is_some() {
6046 assert_eq!(events.len(), 1);
6048 MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
6050 &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {
6051 if let HTLCFailChannelUpdate::ChannelUpdateMessage { .. } = expected_channel_update.unwrap() {} else {
6052 panic!("channel_update not found!");
6055 &HTLCFailChannelUpdate::ChannelClosed { ref short_channel_id, ref is_permanent } => {
6056 if let HTLCFailChannelUpdate::ChannelClosed { short_channel_id: ref expected_short_channel_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
6057 assert!(*short_channel_id == *expected_short_channel_id);
6058 assert!(*is_permanent == *expected_is_permanent);
6060 panic!("Unexpected message event");
6063 &HTLCFailChannelUpdate::NodeFailure { ref node_id, ref is_permanent } => {
6064 if let HTLCFailChannelUpdate::NodeFailure { node_id: ref expected_node_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
6065 assert!(*node_id == *expected_node_id);
6066 assert!(*is_permanent == *expected_is_permanent);
6068 panic!("Unexpected message event");
6073 _ => panic!("Unexpected message event"),
6076 assert_eq!(events.len(), 0);
6080 impl msgs::ChannelUpdate {
6081 fn dummy() -> msgs::ChannelUpdate {
6082 use bitcoin::secp256k1::ffi::Signature as FFISignature;
6083 use bitcoin::secp256k1::Signature;
6084 msgs::ChannelUpdate {
6085 signature: Signature::from(FFISignature::new()),
6086 contents: msgs::UnsignedChannelUpdate {
6087 chain_hash: BlockHash::hash(&vec![0u8][..]),
6088 short_channel_id: 0,
6091 cltv_expiry_delta: 0,
6092 htlc_minimum_msat: 0,
6093 htlc_maximum_msat: OptionalField::Absent,
6095 fee_proportional_millionths: 0,
6096 excess_data: vec![],
6102 struct BogusOnionHopData {
6105 impl BogusOnionHopData {
6106 fn new(orig: msgs::OnionHopData) -> Self {
6107 Self { data: orig.encode() }
6110 impl Writeable for BogusOnionHopData {
6111 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6112 writer.write_all(&self.data[..])
6117 fn test_onion_failure() {
6118 use ln::msgs::ChannelUpdate;
6119 use ln::channelmanager::CLTV_FAR_FAR_AWAY;
6120 use bitcoin::secp256k1;
6122 const BADONION: u16 = 0x8000;
6123 const PERM: u16 = 0x4000;
6124 const NODE: u16 = 0x2000;
6125 const UPDATE: u16 = 0x1000;
6127 let chanmon_cfgs = create_chanmon_cfgs(3);
6128 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6129 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6130 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6131 for node in nodes.iter() {
6132 *node.keys_manager.override_session_priv.lock().unwrap() = Some(SecretKey::from_slice(&[3; 32]).unwrap());
6134 let channels = [create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()), create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known())];
6135 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
6136 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6137 let logger = test_utils::TestLogger::new();
6138 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(), 40000, TEST_FINAL_CLTV, &logger).unwrap();
6140 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 40000, 40_000);
6142 // intermediate node failure
6143 run_onion_failure_test("invalid_realm", 0, &nodes, &route, &payment_hash, |msg| {
6144 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6145 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
6146 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6147 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height).unwrap();
6148 let mut new_payloads = Vec::new();
6149 for payload in onion_payloads.drain(..) {
6150 new_payloads.push(BogusOnionHopData::new(payload));
6152 // break the first (non-final) hop payload by swapping the realm (0) byte for a byte
6153 // describing a length-1 TLV payload, which is obviously bogus.
6154 new_payloads[0].data[0] = 1;
6155 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
6156 }, ||{}, true, Some(PERM|22), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));//XXX incremented channels idx here
6158 // final node failure
6159 run_onion_failure_test("invalid_realm", 3, &nodes, &route, &payment_hash, |msg| {
6160 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6161 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
6162 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6163 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height).unwrap();
6164 let mut new_payloads = Vec::new();
6165 for payload in onion_payloads.drain(..) {
6166 new_payloads.push(BogusOnionHopData::new(payload));
6168 // break the last-hop payload by swapping the realm (0) byte for a byte describing a
6169 // length-1 TLV payload, which is obviously bogus.
6170 new_payloads[1].data[0] = 1;
6171 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
6172 }, ||{}, false, Some(PERM|22), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
6174 // the following three with run_onion_failure_test_with_fail_intercept() test only the origin node
6175 // receiving simulated fail messages
6176 // intermediate node failure
6177 run_onion_failure_test_with_fail_intercept("temporary_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
6179 msg.amount_msat -= 1;
6181 // and tamper returning error message
6182 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6183 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6184 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], NODE|2, &[0;0]);
6185 }, ||{}, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: false}));
6187 // final node failure
6188 run_onion_failure_test_with_fail_intercept("temporary_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
6189 // and tamper returning error message
6190 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6191 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6192 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], NODE|2, &[0;0]);
6194 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
6195 }, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: false}));
6197 // intermediate node failure
6198 run_onion_failure_test_with_fail_intercept("permanent_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
6199 msg.amount_msat -= 1;
6201 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6202 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6203 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|2, &[0;0]);
6204 }, ||{}, true, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: true}));
6206 // final node failure
6207 run_onion_failure_test_with_fail_intercept("permanent_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
6208 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6209 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6210 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|2, &[0;0]);
6212 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
6213 }, false, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: true}));
6215 // intermediate node failure
6216 run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
6217 msg.amount_msat -= 1;
6219 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6220 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6221 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|3, &[0;0]);
6223 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
6224 }, true, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: true}));
6226 // final node failure
6227 run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
6228 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6229 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6230 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|3, &[0;0]);
6232 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
6233 }, false, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: true}));
6235 run_onion_failure_test("invalid_onion_version", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.version = 1; }, ||{}, true,
6236 Some(BADONION|PERM|4), None);
6238 run_onion_failure_test("invalid_onion_hmac", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.hmac = [3; 32]; }, ||{}, true,
6239 Some(BADONION|PERM|5), None);
6241 run_onion_failure_test("invalid_onion_key", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.public_key = Err(secp256k1::Error::InvalidPublicKey);}, ||{}, true,
6242 Some(BADONION|PERM|6), None);
6244 run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
6245 msg.amount_msat -= 1;
6247 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6248 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6249 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], UPDATE|7, &ChannelUpdate::dummy().encode_with_len()[..]);
6250 }, ||{}, true, Some(UPDATE|7), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
6252 run_onion_failure_test_with_fail_intercept("permanent_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
6253 msg.amount_msat -= 1;
6255 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6256 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6257 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|8, &[0;0]);
6258 // short_channel_id from the processing node
6259 }, ||{}, true, Some(PERM|8), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
6261 run_onion_failure_test_with_fail_intercept("required_channel_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
6262 msg.amount_msat -= 1;
6264 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6265 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6266 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|9, &[0;0]);
6267 // short_channel_id from the processing node
6268 }, ||{}, true, Some(PERM|9), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
6270 let mut bogus_route = route.clone();
6271 bogus_route.paths[0][1].short_channel_id -= 1;
6272 run_onion_failure_test("unknown_next_peer", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(PERM|10),
6273 Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: bogus_route.paths[0][1].short_channel_id, is_permanent:true}));
6275 let amt_to_forward = nodes[1].node.channel_state.lock().unwrap().by_id.get(&channels[1].2).unwrap().get_their_htlc_minimum_msat() - 1;
6276 let mut bogus_route = route.clone();
6277 let route_len = bogus_route.paths[0].len();
6278 bogus_route.paths[0][route_len-1].fee_msat = amt_to_forward;
6279 run_onion_failure_test("amount_below_minimum", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(UPDATE|11), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
6281 //TODO: with new config API, we will be able to generate both valid and
6282 //invalid channel_update cases.
6283 run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, |msg| {
6284 msg.amount_msat -= 1;
6285 }, || {}, true, Some(UPDATE|12), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
6287 run_onion_failure_test("incorrect_cltv_expiry", 0, &nodes, &route, &payment_hash, |msg| {
6288 // need to violate: cltv_expiry - cltv_expiry_delta >= outgoing_cltv_value
6289 msg.cltv_expiry -= 1;
6290 }, || {}, true, Some(UPDATE|13), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
6292 run_onion_failure_test("expiry_too_soon", 0, &nodes, &route, &payment_hash, |msg| {
6293 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
6295 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
6299 connect_block(&nodes[1], &block, height);
6300 }, ||{}, true, Some(UPDATE|14), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
6302 run_onion_failure_test("unknown_payment_hash", 2, &nodes, &route, &payment_hash, |_| {}, || {
6303 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
6304 }, false, Some(PERM|15), None);
6306 run_onion_failure_test("final_expiry_too_soon", 1, &nodes, &route, &payment_hash, |msg| {
6307 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
6309 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
6313 connect_block(&nodes[2], &block, height);
6314 }, || {}, true, Some(17), None);
6316 run_onion_failure_test("final_incorrect_cltv_expiry", 1, &nodes, &route, &payment_hash, |_| {}, || {
6317 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
6318 for f in pending_forwards.iter_mut() {
6320 &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
6321 forward_info.outgoing_cltv_value += 1,
6326 }, true, Some(18), None);
6328 run_onion_failure_test("final_incorrect_htlc_amount", 1, &nodes, &route, &payment_hash, |_| {}, || {
6329 // violate amt_to_forward > msg.amount_msat
6330 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
6331 for f in pending_forwards.iter_mut() {
6333 &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
6334 forward_info.amt_to_forward -= 1,
6339 }, true, Some(19), None);
6341 run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, |_| {}, || {
6342 // disconnect event to the channel between nodes[1] ~ nodes[2]
6343 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
6344 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6345 }, true, Some(UPDATE|20), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
6346 reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
6348 run_onion_failure_test("expiry_too_far", 0, &nodes, &route, &payment_hash, |msg| {
6349 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6350 let mut route = route.clone();
6352 route.paths[0][1].cltv_expiry_delta += CLTV_FAR_FAR_AWAY + route.paths[0][0].cltv_expiry_delta + 1;
6353 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6354 let (onion_payloads, _, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, height).unwrap();
6355 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
6356 msg.cltv_expiry = htlc_cltv;
6357 msg.onion_routing_packet = onion_packet;
6358 }, ||{}, true, Some(21), None);
6363 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
6364 let chanmon_cfgs = create_chanmon_cfgs(2);
6365 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6366 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6367 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6368 //Force duplicate channel ids
6369 for node in nodes.iter() {
6370 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
6373 // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
6374 let channel_value_satoshis=10000;
6375 let push_msat=10001;
6376 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6377 let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6378 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6380 //Create a second channel with a channel_id collision
6381 assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6385 fn bolt2_open_channel_sending_node_checks_part2() {
6386 let chanmon_cfgs = create_chanmon_cfgs(2);
6387 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6388 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6389 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6391 // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
6392 let channel_value_satoshis=2^24;
6393 let push_msat=10001;
6394 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6396 // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
6397 let channel_value_satoshis=10000;
6398 // Test when push_msat is equal to 1000 * funding_satoshis.
6399 let push_msat=1000*channel_value_satoshis+1;
6400 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6402 // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
6403 let channel_value_satoshis=10000;
6404 let push_msat=10001;
6405 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
6406 let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6407 assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
6409 // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
6410 // 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
6411 assert!(node0_to_1_send_open_channel.channel_flags<=1);
6413 // 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.
6414 assert!(BREAKDOWN_TIMEOUT>0);
6415 assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
6417 // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
6418 let chain_hash=genesis_block(Network::Testnet).header.bitcoin_hash();
6419 assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
6421 // 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.
6422 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
6423 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
6424 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
6425 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
6426 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
6429 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
6430 // 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.
6431 //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.
6434 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
6435 //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
6436 let chanmon_cfgs = create_chanmon_cfgs(2);
6437 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6438 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6439 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6440 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6442 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6443 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6444 let logger = test_utils::TestLogger::new();
6445 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();
6446 route.paths[0][0].fee_msat = 100;
6448 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6449 assert!(regex::Regex::new(r"Cannot send less than their minimum HTLC value \(\d+\)").unwrap().is_match(err)));
6450 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6451 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
6455 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
6456 //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6457 let chanmon_cfgs = create_chanmon_cfgs(2);
6458 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6459 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6460 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6461 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6462 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6464 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6465 let logger = test_utils::TestLogger::new();
6466 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();
6467 route.paths[0][0].fee_msat = 0;
6468 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6469 assert_eq!(err, "Cannot send 0-msat HTLC"));
6471 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6472 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
6476 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
6477 //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6478 let chanmon_cfgs = create_chanmon_cfgs(2);
6479 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6480 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6481 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6482 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6484 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6485 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6486 let logger = test_utils::TestLogger::new();
6487 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();
6488 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6489 check_added_monitors!(nodes[0], 1);
6490 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6491 updates.update_add_htlcs[0].amount_msat = 0;
6493 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6494 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
6495 check_closed_broadcast!(nodes[1], true).unwrap();
6496 check_added_monitors!(nodes[1], 1);
6500 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6501 //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6502 //It is enforced when constructing a route.
6503 let chanmon_cfgs = create_chanmon_cfgs(2);
6504 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6505 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6506 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6507 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 0, InitFeatures::known(), InitFeatures::known());
6508 let logger = test_utils::TestLogger::new();
6510 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6512 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6513 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();
6514 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::RouteError { ref err },
6515 assert_eq!(err, &"Channel CLTV overflowed?"));
6519 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6520 //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.
6521 //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6522 //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
6523 let chanmon_cfgs = create_chanmon_cfgs(2);
6524 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6525 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6526 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6527 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6528 let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().their_max_accepted_htlcs as u64;
6530 let logger = test_utils::TestLogger::new();
6531 for i in 0..max_accepted_htlcs {
6532 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6533 let payment_event = {
6534 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6535 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();
6536 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6537 check_added_monitors!(nodes[0], 1);
6539 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6540 assert_eq!(events.len(), 1);
6541 if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6542 assert_eq!(htlcs[0].htlc_id, i);
6546 SendEvent::from_event(events.remove(0))
6548 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6549 check_added_monitors!(nodes[1], 0);
6550 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6552 expect_pending_htlcs_forwardable!(nodes[1]);
6553 expect_payment_received!(nodes[1], our_payment_hash, 100000);
6555 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6556 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6557 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6558 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6559 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
6561 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6562 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
6566 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6567 //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.
6568 let chanmon_cfgs = create_chanmon_cfgs(2);
6569 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6570 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6571 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6572 let channel_value = 100000;
6573 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::known(), InitFeatures::known());
6574 let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).their_max_htlc_value_in_flight_msat;
6576 send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight, max_in_flight);
6578 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6579 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6580 let logger = test_utils::TestLogger::new();
6581 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();
6582 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6583 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)));
6585 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6586 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);
6588 send_payment(&nodes[0], &[&nodes[1]], max_in_flight, max_in_flight);
6591 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6593 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6594 //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
6595 let chanmon_cfgs = create_chanmon_cfgs(2);
6596 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6597 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6598 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6599 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6600 let htlc_minimum_msat: u64;
6602 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
6603 let channel = chan_lock.by_id.get(&chan.2).unwrap();
6604 htlc_minimum_msat = channel.get_our_htlc_minimum_msat();
6607 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6608 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6609 let logger = test_utils::TestLogger::new();
6610 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();
6611 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6612 check_added_monitors!(nodes[0], 1);
6613 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6614 updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6615 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6616 assert!(nodes[1].node.list_channels().is_empty());
6617 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6618 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()));
6619 check_added_monitors!(nodes[1], 1);
6623 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6624 //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
6625 let chanmon_cfgs = create_chanmon_cfgs(2);
6626 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6627 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6628 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6629 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6630 let logger = test_utils::TestLogger::new();
6632 let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6633 let channel_reserve = chan_stat.channel_reserve_msat;
6634 let feerate = get_feerate!(nodes[0], chan.2);
6635 // The 2* and +1 are for the fee spike reserve.
6636 let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1);
6638 let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6639 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6640 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6641 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();
6642 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6643 check_added_monitors!(nodes[0], 1);
6644 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6646 // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6647 // at this time channel-initiatee receivers are not required to enforce that senders
6648 // respect the fee_spike_reserve.
6649 updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
6650 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6652 assert!(nodes[1].node.list_channels().is_empty());
6653 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6654 assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
6655 check_added_monitors!(nodes[1], 1);
6659 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
6660 //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
6661 //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
6662 let chanmon_cfgs = create_chanmon_cfgs(2);
6663 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6664 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6665 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6666 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6667 let logger = test_utils::TestLogger::new();
6669 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6670 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
6672 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6673 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();
6675 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
6676 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
6677 let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &None, cur_height).unwrap();
6678 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
6680 let mut msg = msgs::UpdateAddHTLC {
6684 payment_hash: our_payment_hash,
6685 cltv_expiry: htlc_cltv,
6686 onion_routing_packet: onion_packet.clone(),
6689 for i in 0..super::channel::OUR_MAX_HTLCS {
6690 msg.htlc_id = i as u64;
6691 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6693 msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
6694 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6696 assert!(nodes[1].node.list_channels().is_empty());
6697 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6698 assert!(regex::Regex::new(r"Remote tried to push more than our max accepted HTLCs \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6699 check_added_monitors!(nodes[1], 1);
6703 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
6704 //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
6705 let chanmon_cfgs = create_chanmon_cfgs(2);
6706 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6707 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6708 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6709 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6710 let logger = test_utils::TestLogger::new();
6712 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6713 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6714 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();
6715 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6716 check_added_monitors!(nodes[0], 1);
6717 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6718 updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).their_max_htlc_value_in_flight_msat + 1;
6719 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6721 assert!(nodes[1].node.list_channels().is_empty());
6722 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6723 assert!(regex::Regex::new("Remote HTLC add would put them over our max HTLC value").unwrap().is_match(err_msg.data.as_str()));
6724 check_added_monitors!(nodes[1], 1);
6728 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6729 //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6730 let chanmon_cfgs = create_chanmon_cfgs(2);
6731 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6732 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6733 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6734 let logger = test_utils::TestLogger::new();
6736 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6737 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6738 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6739 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();
6740 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6741 check_added_monitors!(nodes[0], 1);
6742 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6743 updates.update_add_htlcs[0].cltv_expiry = 500000000;
6744 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6746 assert!(nodes[1].node.list_channels().is_empty());
6747 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6748 assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6749 check_added_monitors!(nodes[1], 1);
6753 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6754 //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6755 // We test this by first testing that that repeated HTLCs pass commitment signature checks
6756 // after disconnect and that non-sequential htlc_ids result in a channel failure.
6757 let chanmon_cfgs = create_chanmon_cfgs(2);
6758 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6759 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6760 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6761 let logger = test_utils::TestLogger::new();
6763 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6764 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6765 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6766 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();
6767 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6768 check_added_monitors!(nodes[0], 1);
6769 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6770 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6772 //Disconnect and Reconnect
6773 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6774 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6775 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6776 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6777 assert_eq!(reestablish_1.len(), 1);
6778 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6779 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6780 assert_eq!(reestablish_2.len(), 1);
6781 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6782 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6783 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6784 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6787 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6788 assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6789 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6790 check_added_monitors!(nodes[1], 1);
6791 let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6793 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6795 assert!(nodes[1].node.list_channels().is_empty());
6796 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6797 assert!(regex::Regex::new(r"Remote skipped HTLC ID \(skipped ID: \d+\)").unwrap().is_match(err_msg.data.as_str()));
6798 check_added_monitors!(nodes[1], 1);
6802 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6803 //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.
6805 let chanmon_cfgs = create_chanmon_cfgs(2);
6806 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6807 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6808 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6809 let logger = test_utils::TestLogger::new();
6810 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6811 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6812 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6813 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();
6814 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6816 check_added_monitors!(nodes[0], 1);
6817 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6818 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6820 let update_msg = msgs::UpdateFulfillHTLC{
6823 payment_preimage: our_payment_preimage,
6826 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6828 assert!(nodes[0].node.list_channels().is_empty());
6829 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6830 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()));
6831 check_added_monitors!(nodes[0], 1);
6835 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6836 //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.
6838 let chanmon_cfgs = create_chanmon_cfgs(2);
6839 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6840 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6841 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6842 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6843 let logger = test_utils::TestLogger::new();
6845 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6846 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6847 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();
6848 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6849 check_added_monitors!(nodes[0], 1);
6850 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6851 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6853 let update_msg = msgs::UpdateFailHTLC{
6856 reason: msgs::OnionErrorPacket { data: Vec::new()},
6859 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6861 assert!(nodes[0].node.list_channels().is_empty());
6862 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6863 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()));
6864 check_added_monitors!(nodes[0], 1);
6868 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6869 //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.
6871 let chanmon_cfgs = create_chanmon_cfgs(2);
6872 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6873 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6874 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6875 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6876 let logger = test_utils::TestLogger::new();
6878 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6879 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6880 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();
6881 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6882 check_added_monitors!(nodes[0], 1);
6883 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6884 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6886 let update_msg = msgs::UpdateFailMalformedHTLC{
6889 sha256_of_onion: [1; 32],
6890 failure_code: 0x8000,
6893 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6895 assert!(nodes[0].node.list_channels().is_empty());
6896 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6897 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()));
6898 check_added_monitors!(nodes[0], 1);
6902 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
6903 //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
6905 let chanmon_cfgs = create_chanmon_cfgs(2);
6906 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6907 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6908 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6909 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6911 let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6913 nodes[1].node.claim_funds(our_payment_preimage, &None, 100_000);
6914 check_added_monitors!(nodes[1], 1);
6916 let events = nodes[1].node.get_and_clear_pending_msg_events();
6917 assert_eq!(events.len(), 1);
6918 let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6920 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, .. } } => {
6921 assert!(update_add_htlcs.is_empty());
6922 assert_eq!(update_fulfill_htlcs.len(), 1);
6923 assert!(update_fail_htlcs.is_empty());
6924 assert!(update_fail_malformed_htlcs.is_empty());
6925 assert!(update_fee.is_none());
6926 update_fulfill_htlcs[0].clone()
6928 _ => panic!("Unexpected event"),
6932 update_fulfill_msg.htlc_id = 1;
6934 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6936 assert!(nodes[0].node.list_channels().is_empty());
6937 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6938 assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
6939 check_added_monitors!(nodes[0], 1);
6943 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
6944 //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.
6946 let chanmon_cfgs = create_chanmon_cfgs(2);
6947 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6948 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6949 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6950 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6952 let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6954 nodes[1].node.claim_funds(our_payment_preimage, &None, 100_000);
6955 check_added_monitors!(nodes[1], 1);
6957 let events = nodes[1].node.get_and_clear_pending_msg_events();
6958 assert_eq!(events.len(), 1);
6959 let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6961 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, .. } } => {
6962 assert!(update_add_htlcs.is_empty());
6963 assert_eq!(update_fulfill_htlcs.len(), 1);
6964 assert!(update_fail_htlcs.is_empty());
6965 assert!(update_fail_malformed_htlcs.is_empty());
6966 assert!(update_fee.is_none());
6967 update_fulfill_htlcs[0].clone()
6969 _ => panic!("Unexpected event"),
6973 update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
6975 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6977 assert!(nodes[0].node.list_channels().is_empty());
6978 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6979 assert!(regex::Regex::new(r"Remote tried to fulfill HTLC \(\d+\) with an incorrect preimage").unwrap().is_match(err_msg.data.as_str()));
6980 check_added_monitors!(nodes[0], 1);
6984 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
6985 //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.
6987 let chanmon_cfgs = create_chanmon_cfgs(2);
6988 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6989 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6990 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6991 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6992 let logger = test_utils::TestLogger::new();
6994 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6995 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6996 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();
6997 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6998 check_added_monitors!(nodes[0], 1);
7000 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7001 updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7003 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7004 check_added_monitors!(nodes[1], 0);
7005 commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
7007 let events = nodes[1].node.get_and_clear_pending_msg_events();
7009 let mut update_msg: msgs::UpdateFailMalformedHTLC = {
7011 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, .. } } => {
7012 assert!(update_add_htlcs.is_empty());
7013 assert!(update_fulfill_htlcs.is_empty());
7014 assert!(update_fail_htlcs.is_empty());
7015 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7016 assert!(update_fee.is_none());
7017 update_fail_malformed_htlcs[0].clone()
7019 _ => panic!("Unexpected event"),
7022 update_msg.failure_code &= !0x8000;
7023 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7025 assert!(nodes[0].node.list_channels().is_empty());
7026 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7027 assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
7028 check_added_monitors!(nodes[0], 1);
7032 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
7033 //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
7034 // * 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.
7036 let chanmon_cfgs = create_chanmon_cfgs(3);
7037 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7038 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7039 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7040 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7041 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7042 let logger = test_utils::TestLogger::new();
7044 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
7047 let mut payment_event = {
7048 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7049 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();
7050 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
7051 check_added_monitors!(nodes[0], 1);
7052 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7053 assert_eq!(events.len(), 1);
7054 SendEvent::from_event(events.remove(0))
7056 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7057 check_added_monitors!(nodes[1], 0);
7058 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7059 expect_pending_htlcs_forwardable!(nodes[1]);
7060 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
7061 assert_eq!(events_2.len(), 1);
7062 check_added_monitors!(nodes[1], 1);
7063 payment_event = SendEvent::from_event(events_2.remove(0));
7064 assert_eq!(payment_event.msgs.len(), 1);
7067 payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7068 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
7069 check_added_monitors!(nodes[2], 0);
7070 commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
7072 let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
7073 assert_eq!(events_3.len(), 1);
7074 let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
7076 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 } } => {
7077 assert!(update_add_htlcs.is_empty());
7078 assert!(update_fulfill_htlcs.is_empty());
7079 assert!(update_fail_htlcs.is_empty());
7080 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7081 assert!(update_fee.is_none());
7082 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
7084 _ => panic!("Unexpected event"),
7088 nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
7090 check_added_monitors!(nodes[1], 0);
7091 commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
7092 expect_pending_htlcs_forwardable!(nodes[1]);
7093 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
7094 assert_eq!(events_4.len(), 1);
7096 //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
7098 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, .. } } => {
7099 assert!(update_add_htlcs.is_empty());
7100 assert!(update_fulfill_htlcs.is_empty());
7101 assert_eq!(update_fail_htlcs.len(), 1);
7102 assert!(update_fail_malformed_htlcs.is_empty());
7103 assert!(update_fee.is_none());
7105 _ => panic!("Unexpected event"),
7108 check_added_monitors!(nodes[1], 1);
7111 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
7112 // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
7113 // 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
7114 // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
7116 let chanmon_cfgs = create_chanmon_cfgs(2);
7117 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7118 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7119 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7120 let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7122 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
7124 // We route 2 dust-HTLCs between A and B
7125 let (_, payment_hash_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7126 let (_, payment_hash_2) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7127 route_payment(&nodes[0], &[&nodes[1]], 1000000);
7129 // Cache one local commitment tx as previous
7130 let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7132 // Fail one HTLC to prune it in the will-be-latest-local commitment tx
7133 assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2, &None));
7134 check_added_monitors!(nodes[1], 0);
7135 expect_pending_htlcs_forwardable!(nodes[1]);
7136 check_added_monitors!(nodes[1], 1);
7138 let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7139 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
7140 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
7141 check_added_monitors!(nodes[0], 1);
7143 // Cache one local commitment tx as lastest
7144 let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7146 let events = nodes[0].node.get_and_clear_pending_msg_events();
7148 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
7149 assert_eq!(node_id, nodes[1].node.get_our_node_id());
7151 _ => panic!("Unexpected event"),
7154 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
7155 assert_eq!(node_id, nodes[1].node.get_our_node_id());
7157 _ => panic!("Unexpected event"),
7160 assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
7161 // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
7162 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7164 if announce_latest {
7165 connect_block(&nodes[0], &Block { header, txdata: vec![as_last_commitment_tx[0].clone()]}, 1);
7167 connect_block(&nodes[0], &Block { header, txdata: vec![as_prev_commitment_tx[0].clone()]}, 1);
7170 check_closed_broadcast!(nodes[0], false);
7171 check_added_monitors!(nodes[0], 1);
7173 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7174 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
7175 let events = nodes[0].node.get_and_clear_pending_events();
7176 // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
7177 assert_eq!(events.len(), 2);
7178 let mut first_failed = false;
7179 for event in events {
7181 Event::PaymentFailed { payment_hash, .. } => {
7182 if payment_hash == payment_hash_1 {
7183 assert!(!first_failed);
7184 first_failed = true;
7186 assert_eq!(payment_hash, payment_hash_2);
7189 _ => panic!("Unexpected event"),
7195 fn test_failure_delay_dust_htlc_local_commitment() {
7196 do_test_failure_delay_dust_htlc_local_commitment(true);
7197 do_test_failure_delay_dust_htlc_local_commitment(false);
7201 fn test_no_failure_dust_htlc_local_commitment() {
7202 // Transaction filters for failing back dust htlc based on local commitment txn infos has been
7203 // prone to error, we test here that a dummy transaction don't fail them.
7205 let chanmon_cfgs = create_chanmon_cfgs(2);
7206 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7207 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7208 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7209 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7212 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
7214 let as_dust_limit = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
7215 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
7217 // We route 2 dust-HTLCs between A and B
7218 let (preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7219 let (preimage_2, _) = route_payment(&nodes[1], &[&nodes[0]], as_dust_limit*1000);
7221 // Build a dummy invalid transaction trying to spend a commitment tx
7223 previous_output: BitcoinOutPoint { txid: chan.3.txid(), vout: 0 },
7224 script_sig: Script::new(),
7226 witness: Vec::new(),
7230 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
7234 let dummy_tx = Transaction {
7241 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7242 nodes[0].chain_monitor.chain_monitor.block_connected(&header, &[(0, &dummy_tx)], 1);
7243 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7244 assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
7245 // We broadcast a few more block to check everything is all right
7246 connect_blocks(&nodes[0], 20, 1, true, header.bitcoin_hash());
7247 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7248 assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
7250 claim_payment(&nodes[0], &vec!(&nodes[1])[..], preimage_1, bs_dust_limit*1000);
7251 claim_payment(&nodes[1], &vec!(&nodes[0])[..], preimage_2, as_dust_limit*1000);
7254 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
7255 // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
7256 // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
7257 // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
7258 // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
7259 // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
7260 // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
7262 let chanmon_cfgs = create_chanmon_cfgs(3);
7263 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7264 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7265 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7266 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7268 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
7270 let (_payment_preimage_1, dust_hash) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7271 let (_payment_preimage_2, non_dust_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7273 let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7274 let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
7276 // We revoked bs_commitment_tx
7278 let (payment_preimage_3, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7279 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 1_000_000);
7282 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7283 let mut timeout_tx = Vec::new();
7285 // We fail dust-HTLC 1 by broadcast of local commitment tx
7286 connect_block(&nodes[0], &Block { header, txdata: vec![as_commitment_tx[0].clone()]}, 1);
7287 check_closed_broadcast!(nodes[0], false);
7288 check_added_monitors!(nodes[0], 1);
7289 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7290 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
7291 let parent_hash = connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
7292 expect_payment_failed!(nodes[0], dust_hash, true);
7293 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7294 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
7295 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7296 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7297 connect_block(&nodes[0], &Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
7298 let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7299 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
7300 expect_payment_failed!(nodes[0], non_dust_hash, true);
7302 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
7303 connect_block(&nodes[0], &Block { header, txdata: vec![bs_commitment_tx[0].clone()]}, 1);
7304 check_closed_broadcast!(nodes[0], false);
7305 check_added_monitors!(nodes[0], 1);
7306 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7307 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
7308 let parent_hash = connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
7309 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7311 expect_payment_failed!(nodes[0], dust_hash, true);
7312 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7313 // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
7314 connect_block(&nodes[0], &Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
7315 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7316 let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7317 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
7318 expect_payment_failed!(nodes[0], non_dust_hash, true);
7320 // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
7322 let events = nodes[0].node.get_and_clear_pending_events();
7323 assert_eq!(events.len(), 2);
7326 Event::PaymentFailed { payment_hash, .. } => {
7327 if payment_hash == dust_hash { first = true; }
7328 else { first = false; }
7330 _ => panic!("Unexpected event"),
7333 Event::PaymentFailed { payment_hash, .. } => {
7334 if first { assert_eq!(payment_hash, non_dust_hash); }
7335 else { assert_eq!(payment_hash, dust_hash); }
7337 _ => panic!("Unexpected event"),
7344 fn test_sweep_outbound_htlc_failure_update() {
7345 do_test_sweep_outbound_htlc_failure_update(false, true);
7346 do_test_sweep_outbound_htlc_failure_update(false, false);
7347 do_test_sweep_outbound_htlc_failure_update(true, false);
7351 fn test_upfront_shutdown_script() {
7352 // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
7353 // enforce it at shutdown message
7355 let mut config = UserConfig::default();
7356 config.channel_options.announced_channel = true;
7357 config.peer_channel_config_limits.force_announced_channel_preference = false;
7358 config.channel_options.commit_upfront_shutdown_pubkey = false;
7359 let user_cfgs = [None, Some(config), None];
7360 let chanmon_cfgs = create_chanmon_cfgs(3);
7361 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7362 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7363 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7365 // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
7366 let flags = InitFeatures::known();
7367 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7368 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7369 let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7370 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7371 // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that we disconnect peer
7372 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
7373 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()));
7374 check_added_monitors!(nodes[2], 1);
7376 // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
7377 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7378 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7379 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7380 // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
7381 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
7382 let events = nodes[2].node.get_and_clear_pending_msg_events();
7383 assert_eq!(events.len(), 1);
7385 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7386 _ => panic!("Unexpected event"),
7389 // We test that if case of peer non-signaling we don't enforce committed script at channel opening
7390 let flags_no = InitFeatures::known().clear_upfront_shutdown_script();
7391 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
7392 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7393 let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
7394 node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7395 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_1_shutdown);
7396 let events = nodes[1].node.get_and_clear_pending_msg_events();
7397 assert_eq!(events.len(), 1);
7399 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7400 _ => panic!("Unexpected event"),
7403 // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7404 // channel smoothly, opt-out is from channel initiator here
7405 let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
7406 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7407 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7408 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7409 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
7410 let events = nodes[0].node.get_and_clear_pending_msg_events();
7411 assert_eq!(events.len(), 1);
7413 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7414 _ => panic!("Unexpected event"),
7417 //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7418 //// channel smoothly
7419 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
7420 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7421 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7422 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7423 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
7424 let events = nodes[0].node.get_and_clear_pending_msg_events();
7425 assert_eq!(events.len(), 2);
7427 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7428 _ => panic!("Unexpected event"),
7431 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7432 _ => panic!("Unexpected event"),
7437 fn test_user_configurable_csv_delay() {
7438 // We test our channel constructors yield errors when we pass them absurd csv delay
7440 let mut low_our_to_self_config = UserConfig::default();
7441 low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
7442 let mut high_their_to_self_config = UserConfig::default();
7443 high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
7444 let user_cfgs = [Some(high_their_to_self_config.clone()), None];
7445 let chanmon_cfgs = create_chanmon_cfgs(2);
7446 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7447 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
7448 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7450 // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
7451 let keys_manager: Arc<KeysInterface<ChanKeySigner = EnforcingChannelKeys>> = Arc::new(test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet));
7452 if let Err(error) = Channel::new_outbound(&&test_utils::TestFeeEstimator { sat_per_kw: 253 }, &keys_manager, nodes[1].node.get_our_node_id(), 1000000, 1000000, 0, &low_our_to_self_config) {
7454 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())); },
7455 _ => panic!("Unexpected event"),
7457 } else { assert!(false) }
7459 // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
7460 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7461 let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7462 open_channel.to_self_delay = 200;
7463 if let Err(error) = Channel::new_from_req(&&test_utils::TestFeeEstimator { sat_per_kw: 253 }, &keys_manager, nodes[1].node.get_our_node_id(), InitFeatures::known(), &open_channel, 0, &low_our_to_self_config) {
7465 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())); },
7466 _ => panic!("Unexpected event"),
7468 } else { assert!(false); }
7470 // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
7471 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7472 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()));
7473 let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7474 accept_channel.to_self_delay = 200;
7475 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7476 if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
7478 &ErrorAction::SendErrorMessage { ref msg } => {
7479 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()));
7481 _ => { assert!(false); }
7483 } else { assert!(false); }
7485 // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
7486 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7487 let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7488 open_channel.to_self_delay = 200;
7489 if let Err(error) = Channel::new_from_req(&&test_utils::TestFeeEstimator { sat_per_kw: 253 }, &keys_manager, nodes[1].node.get_our_node_id(), InitFeatures::known(), &open_channel, 0, &high_their_to_self_config) {
7491 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())); },
7492 _ => panic!("Unexpected event"),
7494 } else { assert!(false); }
7498 fn test_data_loss_protect() {
7499 // We want to be sure that :
7500 // * we don't broadcast our Local Commitment Tx in case of fallen behind
7501 // * we close channel in case of detecting other being fallen behind
7502 // * we are able to claim our own outputs thanks to to_remote being static
7510 let chanmon_cfgs = create_chanmon_cfgs(2);
7511 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7512 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7513 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7515 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7517 // Cache node A state before any channel update
7518 let previous_node_state = nodes[0].node.encode();
7519 let mut previous_chain_monitor_state = test_utils::TestVecWriter(Vec::new());
7520 nodes[0].chain_monitor.chain_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut previous_chain_monitor_state).unwrap();
7522 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
7523 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
7525 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7526 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7528 // Restore node A from previous state
7529 logger = test_utils::TestLogger::with_id(format!("node {}", 0));
7530 let mut chain_monitor = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut ::std::io::Cursor::new(previous_chain_monitor_state.0)).unwrap().1;
7531 chain_source = test_utils::TestChainSource::new(Network::Testnet);
7532 tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())};
7533 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
7534 keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
7535 monitor = test_utils::TestChainMonitor::new(&tx_broadcaster, &logger, &fee_estimator);
7537 let mut channel_monitors = HashMap::new();
7538 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chain_monitor);
7539 <(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 {
7540 keys_manager: &keys_manager,
7541 fee_estimator: &fee_estimator,
7542 chain_monitor: &monitor,
7544 tx_broadcaster: &tx_broadcaster,
7545 default_config: UserConfig::default(),
7546 channel_monitors: &mut channel_monitors,
7549 nodes[0].node = &node_state_0;
7550 assert!(monitor.watch_channel(OutPoint { txid: chan.3.txid(), index: 0 }, chain_monitor).is_ok());
7551 nodes[0].chain_monitor = &monitor;
7552 nodes[0].chain_source = &chain_source;
7554 check_added_monitors!(nodes[0], 1);
7556 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7557 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7559 let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7561 // Check we don't broadcast any transactions following learning of per_commitment_point from B
7562 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
7563 check_added_monitors!(nodes[0], 1);
7566 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7567 assert_eq!(node_txn.len(), 0);
7570 let mut reestablish_1 = Vec::with_capacity(1);
7571 for msg in nodes[0].node.get_and_clear_pending_msg_events() {
7572 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
7573 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7574 reestablish_1.push(msg.clone());
7575 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
7576 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
7578 &ErrorAction::SendErrorMessage { ref msg } => {
7579 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");
7581 _ => panic!("Unexpected event!"),
7584 panic!("Unexpected event")
7588 // Check we close channel detecting A is fallen-behind
7589 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7590 assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
7591 check_added_monitors!(nodes[1], 1);
7594 // Check A is able to claim to_remote output
7595 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7596 assert_eq!(node_txn.len(), 1);
7597 check_spends!(node_txn[0], chan.3);
7598 assert_eq!(node_txn[0].output.len(), 2);
7599 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
7600 connect_block(&nodes[0], &Block { header, txdata: vec![node_txn[0].clone()]}, 0);
7601 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 0, true, header.bitcoin_hash());
7602 let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
7603 assert_eq!(spend_txn.len(), 1);
7604 check_spends!(spend_txn[0], node_txn[0]);
7608 fn test_check_htlc_underpaying() {
7609 // Send payment through A -> B but A is maliciously
7610 // sending a probe payment (i.e less than expected value0
7611 // to B, B should refuse payment.
7613 let chanmon_cfgs = create_chanmon_cfgs(2);
7614 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7615 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7616 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7618 // Create some initial channels
7619 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7621 let (payment_preimage, payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 10_000);
7623 // Node 3 is expecting payment of 100_000 but receive 10_000,
7624 // fail htlc like we didn't know the preimage.
7625 nodes[1].node.claim_funds(payment_preimage, &None, 100_000);
7626 nodes[1].node.process_pending_htlc_forwards();
7628 let events = nodes[1].node.get_and_clear_pending_msg_events();
7629 assert_eq!(events.len(), 1);
7630 let (update_fail_htlc, commitment_signed) = match events[0] {
7631 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 } } => {
7632 assert!(update_add_htlcs.is_empty());
7633 assert!(update_fulfill_htlcs.is_empty());
7634 assert_eq!(update_fail_htlcs.len(), 1);
7635 assert!(update_fail_malformed_htlcs.is_empty());
7636 assert!(update_fee.is_none());
7637 (update_fail_htlcs[0].clone(), commitment_signed)
7639 _ => panic!("Unexpected event"),
7641 check_added_monitors!(nodes[1], 1);
7643 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
7644 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
7646 // 10_000 msat as u64, followed by a height of 99 as u32
7647 let mut expected_failure_data = byte_utils::be64_to_array(10_000).to_vec();
7648 expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(99));
7649 expect_payment_failed!(nodes[0], payment_hash, true, 0x4000|15, &expected_failure_data[..]);
7650 nodes[1].node.get_and_clear_pending_events();
7654 fn test_announce_disable_channels() {
7655 // Create 2 channels between A and B. Disconnect B. Call timer_chan_freshness_every_min and check for generated
7656 // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
7658 let chanmon_cfgs = create_chanmon_cfgs(2);
7659 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7660 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7661 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7663 let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7664 let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7665 let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7668 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7669 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7671 nodes[0].node.timer_chan_freshness_every_min(); // dirty -> stagged
7672 nodes[0].node.timer_chan_freshness_every_min(); // staged -> fresh
7673 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7674 assert_eq!(msg_events.len(), 3);
7675 for e in msg_events {
7677 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7678 let short_id = msg.contents.short_channel_id;
7679 // Check generated channel_update match list in PendingChannelUpdate
7680 if short_id != short_id_1 && short_id != short_id_2 && short_id != short_id_3 {
7681 panic!("Generated ChannelUpdate for wrong chan!");
7684 _ => panic!("Unexpected event"),
7688 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7689 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7690 assert_eq!(reestablish_1.len(), 3);
7691 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7692 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7693 assert_eq!(reestablish_2.len(), 3);
7695 // Reestablish chan_1
7696 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7697 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7698 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7699 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7700 // Reestablish chan_2
7701 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
7702 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7703 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
7704 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7705 // Reestablish chan_3
7706 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
7707 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7708 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
7709 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7711 nodes[0].node.timer_chan_freshness_every_min();
7712 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7716 fn test_bump_penalty_txn_on_revoked_commitment() {
7717 // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
7718 // we're able to claim outputs on revoked commitment transaction before timelocks expiration
7720 let chanmon_cfgs = create_chanmon_cfgs(2);
7721 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7722 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7723 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7725 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7726 let logger = test_utils::TestLogger::new();
7729 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7730 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
7731 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();
7732 send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
7734 let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
7735 // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7736 assert_eq!(revoked_txn[0].output.len(), 4);
7737 assert_eq!(revoked_txn[0].input.len(), 1);
7738 assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
7739 let revoked_txid = revoked_txn[0].txid();
7741 let mut penalty_sum = 0;
7742 for outp in revoked_txn[0].output.iter() {
7743 if outp.script_pubkey.is_v0_p2wsh() {
7744 penalty_sum += outp.value;
7748 // Connect blocks to change height_timer range to see if we use right soonest_timelock
7749 let header_114 = connect_blocks(&nodes[1], 114, 0, false, Default::default());
7751 // Actually revoke tx by claiming a HTLC
7752 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
7753 let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7754 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_txn[0].clone()] }, 115);
7755 check_added_monitors!(nodes[1], 1);
7757 // One or more justice tx should have been broadcast, check it
7761 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7762 assert_eq!(node_txn.len(), 3); // justice tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout (broadcasted from ChannelManager)
7763 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7764 assert_eq!(node_txn[0].output.len(), 1);
7765 check_spends!(node_txn[0], revoked_txn[0]);
7766 let fee_1 = penalty_sum - node_txn[0].output[0].value;
7767 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
7768 penalty_1 = node_txn[0].txid();
7772 // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
7773 let header = connect_blocks(&nodes[1], 3, 115, true, header.bitcoin_hash());
7774 let mut penalty_2 = penalty_1;
7775 let mut feerate_2 = 0;
7777 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7778 assert_eq!(node_txn.len(), 1);
7779 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7780 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7781 assert_eq!(node_txn[0].output.len(), 1);
7782 check_spends!(node_txn[0], revoked_txn[0]);
7783 penalty_2 = node_txn[0].txid();
7784 // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7785 assert_ne!(penalty_2, penalty_1);
7786 let fee_2 = penalty_sum - node_txn[0].output[0].value;
7787 feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7788 // Verify 25% bump heuristic
7789 assert!(feerate_2 * 100 >= feerate_1 * 125);
7793 assert_ne!(feerate_2, 0);
7795 // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
7796 connect_blocks(&nodes[1], 3, 118, true, header);
7798 let mut feerate_3 = 0;
7800 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7801 assert_eq!(node_txn.len(), 1);
7802 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7803 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7804 assert_eq!(node_txn[0].output.len(), 1);
7805 check_spends!(node_txn[0], revoked_txn[0]);
7806 penalty_3 = node_txn[0].txid();
7807 // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7808 assert_ne!(penalty_3, penalty_2);
7809 let fee_3 = penalty_sum - node_txn[0].output[0].value;
7810 feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
7811 // Verify 25% bump heuristic
7812 assert!(feerate_3 * 100 >= feerate_2 * 125);
7816 assert_ne!(feerate_3, 0);
7818 nodes[1].node.get_and_clear_pending_events();
7819 nodes[1].node.get_and_clear_pending_msg_events();
7823 fn test_bump_penalty_txn_on_revoked_htlcs() {
7824 // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
7825 // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
7827 let chanmon_cfgs = create_chanmon_cfgs(2);
7828 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7829 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7830 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7832 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7833 // Lock HTLC in both directions
7834 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3_000_000).0;
7835 route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7837 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7838 assert_eq!(revoked_local_txn[0].input.len(), 1);
7839 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7841 // Revoke local commitment tx
7842 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
7844 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7845 // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
7846 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
7847 check_closed_broadcast!(nodes[1], false);
7848 check_added_monitors!(nodes[1], 1);
7850 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7851 assert_eq!(revoked_htlc_txn.len(), 4);
7852 if revoked_htlc_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7853 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7854 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7855 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7856 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7857 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7858 } else if revoked_htlc_txn[1].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7859 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7860 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7861 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7862 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7863 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7866 // Broadcast set of revoked txn on A
7867 let header_128 = connect_blocks(&nodes[0], 128, 0, true, header.bitcoin_hash());
7868 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
7870 let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7871 connect_block(&nodes[0], &Block { header: header_129, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone(), revoked_htlc_txn[1].clone()] }, 129);
7876 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7877 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
7878 // Verify claim tx are spending revoked HTLC txn
7879 assert_eq!(node_txn[3].input.len(), 2);
7880 assert_eq!(node_txn[3].output.len(), 1);
7881 check_spends!(node_txn[3], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7882 first = node_txn[3].txid();
7883 // Store both feerates for later comparison
7884 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[3].output[0].value;
7885 feerate_1 = fee_1 * 1000 / node_txn[3].get_weight() as u64;
7886 penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
7890 // Connect three more block to see if bumped penalty are issued for HTLC txn
7891 let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7892 connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn }, 130);
7894 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7895 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
7897 check_spends!(node_txn[0], revoked_local_txn[0]);
7898 check_spends!(node_txn[1], revoked_local_txn[0]);
7903 // Few more blocks to confirm penalty txn
7904 let header_135 = connect_blocks(&nodes[0], 5, 130, true, header_130.bitcoin_hash());
7905 assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
7906 let header_144 = connect_blocks(&nodes[0], 9, 135, true, header_135);
7908 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7909 assert_eq!(node_txn.len(), 1);
7911 assert_eq!(node_txn[0].input.len(), 2);
7912 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7913 // Verify bumped tx is different and 25% bump heuristic
7914 assert_ne!(first, node_txn[0].txid());
7915 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[0].output[0].value;
7916 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7917 assert!(feerate_2 * 100 > feerate_1 * 125);
7918 let txn = vec![node_txn[0].clone()];
7922 // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
7923 let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7924 connect_block(&nodes[0], &Block { header: header_145, txdata: node_txn }, 145);
7925 connect_blocks(&nodes[0], 20, 145, true, header_145.bitcoin_hash());
7927 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7928 // We verify than no new transaction has been broadcast because previously
7929 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
7930 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
7931 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
7932 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
7933 // up bumped justice generation.
7934 assert_eq!(node_txn.len(), 0);
7937 check_closed_broadcast!(nodes[0], false);
7938 check_added_monitors!(nodes[0], 1);
7942 fn test_bump_penalty_txn_on_remote_commitment() {
7943 // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
7944 // we're able to claim outputs on remote commitment transaction before timelocks expiration
7947 // Provide preimage for one
7948 // Check aggregation
7950 let chanmon_cfgs = create_chanmon_cfgs(2);
7951 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7952 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7953 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7955 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7956 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7957 route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
7959 // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7960 let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
7961 assert_eq!(remote_txn[0].output.len(), 4);
7962 assert_eq!(remote_txn[0].input.len(), 1);
7963 assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
7965 // Claim a HTLC without revocation (provide B monitor with preimage)
7966 nodes[1].node.claim_funds(payment_preimage, &None, 3_000_000);
7967 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7968 connect_block(&nodes[1], &Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
7969 check_added_monitors!(nodes[1], 2);
7971 // One or more claim tx should have been broadcast, check it
7974 let feerate_timeout;
7975 let feerate_preimage;
7977 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7978 assert_eq!(node_txn.len(), 5); // 2 * claim tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout + local HTLC-success (broadcasted from ChannelManager)
7979 assert_eq!(node_txn[0].input.len(), 1);
7980 assert_eq!(node_txn[1].input.len(), 1);
7981 check_spends!(node_txn[0], remote_txn[0]);
7982 check_spends!(node_txn[1], remote_txn[0]);
7983 check_spends!(node_txn[2], chan.3);
7984 check_spends!(node_txn[3], node_txn[2]);
7985 check_spends!(node_txn[4], node_txn[2]);
7986 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7987 timeout = node_txn[0].txid();
7988 let index = node_txn[0].input[0].previous_output.vout;
7989 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7990 feerate_timeout = fee * 1000 / node_txn[0].get_weight() as u64;
7992 preimage = node_txn[1].txid();
7993 let index = node_txn[1].input[0].previous_output.vout;
7994 let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7995 feerate_preimage = fee * 1000 / node_txn[1].get_weight() as u64;
7997 timeout = node_txn[1].txid();
7998 let index = node_txn[1].input[0].previous_output.vout;
7999 let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8000 feerate_timeout = fee * 1000 / node_txn[1].get_weight() as u64;
8002 preimage = node_txn[0].txid();
8003 let index = node_txn[0].input[0].previous_output.vout;
8004 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8005 feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
8009 assert_ne!(feerate_timeout, 0);
8010 assert_ne!(feerate_preimage, 0);
8012 // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
8013 connect_blocks(&nodes[1], 15, 1, true, header.bitcoin_hash());
8015 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8016 assert_eq!(node_txn.len(), 2);
8017 assert_eq!(node_txn[0].input.len(), 1);
8018 assert_eq!(node_txn[1].input.len(), 1);
8019 check_spends!(node_txn[0], remote_txn[0]);
8020 check_spends!(node_txn[1], remote_txn[0]);
8021 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
8022 let index = node_txn[0].input[0].previous_output.vout;
8023 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8024 let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
8025 assert!(new_feerate * 100 > feerate_timeout * 125);
8026 assert_ne!(timeout, node_txn[0].txid());
8028 let index = node_txn[1].input[0].previous_output.vout;
8029 let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8030 let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
8031 assert!(new_feerate * 100 > feerate_preimage * 125);
8032 assert_ne!(preimage, node_txn[1].txid());
8034 let index = node_txn[1].input[0].previous_output.vout;
8035 let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8036 let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
8037 assert!(new_feerate * 100 > feerate_timeout * 125);
8038 assert_ne!(timeout, node_txn[1].txid());
8040 let index = node_txn[0].input[0].previous_output.vout;
8041 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8042 let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
8043 assert!(new_feerate * 100 > feerate_preimage * 125);
8044 assert_ne!(preimage, node_txn[0].txid());
8049 nodes[1].node.get_and_clear_pending_events();
8050 nodes[1].node.get_and_clear_pending_msg_events();
8054 fn test_set_outpoints_partial_claiming() {
8055 // - remote party claim tx, new bump tx
8056 // - disconnect remote claiming tx, new bump
8057 // - disconnect tx, see no tx anymore
8058 let chanmon_cfgs = create_chanmon_cfgs(2);
8059 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8060 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8061 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8063 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8064 let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
8065 let payment_preimage_2 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
8067 // Remote commitment txn with 4 outputs: to_local, to_remote, 2 outgoing HTLC
8068 let remote_txn = get_local_commitment_txn!(nodes[1], chan.2);
8069 assert_eq!(remote_txn.len(), 3);
8070 assert_eq!(remote_txn[0].output.len(), 4);
8071 assert_eq!(remote_txn[0].input.len(), 1);
8072 assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
8073 check_spends!(remote_txn[1], remote_txn[0]);
8074 check_spends!(remote_txn[2], remote_txn[0]);
8076 // Connect blocks on node A to advance height towards TEST_FINAL_CLTV
8077 let prev_header_100 = connect_blocks(&nodes[1], 100, 0, false, Default::default());
8078 // Provide node A with both preimage
8079 nodes[0].node.claim_funds(payment_preimage_1, &None, 3_000_000);
8080 nodes[0].node.claim_funds(payment_preimage_2, &None, 3_000_000);
8081 check_added_monitors!(nodes[0], 2);
8082 nodes[0].node.get_and_clear_pending_events();
8083 nodes[0].node.get_and_clear_pending_msg_events();
8085 // Connect blocks on node A commitment transaction
8086 let header = BlockHeader { version: 0x20000000, prev_blockhash: prev_header_100, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8087 connect_block(&nodes[0], &Block { header, txdata: vec![remote_txn[0].clone()] }, 101);
8088 check_closed_broadcast!(nodes[0], false);
8089 check_added_monitors!(nodes[0], 1);
8090 // Verify node A broadcast tx claiming both HTLCs
8092 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8093 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-Success*2
8094 assert_eq!(node_txn.len(), 4);
8095 check_spends!(node_txn[0], remote_txn[0]);
8096 check_spends!(node_txn[1], chan.3);
8097 check_spends!(node_txn[2], node_txn[1]);
8098 check_spends!(node_txn[3], node_txn[1]);
8099 assert_eq!(node_txn[0].input.len(), 2);
8103 // Connect blocks on node B
8104 connect_blocks(&nodes[1], 135, 0, false, Default::default());
8105 check_closed_broadcast!(nodes[1], false);
8106 check_added_monitors!(nodes[1], 1);
8107 // Verify node B broadcast 2 HTLC-timeout txn
8108 let partial_claim_tx = {
8109 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8110 assert_eq!(node_txn.len(), 3);
8111 check_spends!(node_txn[1], node_txn[0]);
8112 check_spends!(node_txn[2], node_txn[0]);
8113 assert_eq!(node_txn[1].input.len(), 1);
8114 assert_eq!(node_txn[2].input.len(), 1);
8118 // Broadcast partial claim on node A, should regenerate a claiming tx with HTLC dropped
8119 let header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8120 connect_block(&nodes[0], &Block { header, txdata: vec![partial_claim_tx.clone()] }, 102);
8122 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8123 assert_eq!(node_txn.len(), 1);
8124 check_spends!(node_txn[0], remote_txn[0]);
8125 assert_eq!(node_txn[0].input.len(), 1); //dropped HTLC
8128 nodes[0].node.get_and_clear_pending_msg_events();
8130 // Disconnect last block on node A, should regenerate a claiming tx with HTLC dropped
8131 disconnect_block(&nodes[0], &header, 102);
8133 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8134 assert_eq!(node_txn.len(), 1);
8135 check_spends!(node_txn[0], remote_txn[0]);
8136 assert_eq!(node_txn[0].input.len(), 2); //resurrected HTLC
8140 //// Disconnect one more block and then reconnect multiple no transaction should be generated
8141 disconnect_block(&nodes[0], &header, 101);
8142 connect_blocks(&nodes[1], 15, 101, false, prev_header_100);
8144 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8145 assert_eq!(node_txn.len(), 0);
8151 fn test_counterparty_raa_skip_no_crash() {
8152 // Previously, if our counterparty sent two RAAs in a row without us having provided a
8153 // commitment transaction, we would have happily carried on and provided them the next
8154 // commitment transaction based on one RAA forward. This would probably eventually have led to
8155 // channel closure, but it would not have resulted in funds loss. Still, our
8156 // EnforcingChannelKeys would have paniced as it doesn't like jumps into the future. Here, we
8157 // check simply that the channel is closed in response to such an RAA, but don't check whether
8158 // we decide to punish our counterparty for revoking their funds (as we don't currently
8160 let chanmon_cfgs = create_chanmon_cfgs(2);
8161 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8162 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8163 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8164 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
8166 let mut guard = nodes[0].node.channel_state.lock().unwrap();
8167 let local_keys = &guard.by_id.get_mut(&channel_id).unwrap().local_keys;
8168 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
8169 let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
8170 &SecretKey::from_slice(&local_keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
8171 let per_commitment_secret = local_keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER);
8173 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
8174 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
8175 assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
8176 check_added_monitors!(nodes[1], 1);
8180 fn test_bump_txn_sanitize_tracking_maps() {
8181 // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
8182 // verify we clean then right after expiration of ANTI_REORG_DELAY.
8184 let chanmon_cfgs = create_chanmon_cfgs(2);
8185 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8186 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8187 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8189 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8190 // Lock HTLC in both directions
8191 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8192 route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
8194 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8195 assert_eq!(revoked_local_txn[0].input.len(), 1);
8196 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8198 // Revoke local commitment tx
8199 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 9_000_000);
8201 // Broadcast set of revoked txn on A
8202 let header_128 = connect_blocks(&nodes[0], 128, 0, false, Default::default());
8203 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8205 let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8206 connect_block(&nodes[0], &Block { header: header_129, txdata: vec![revoked_local_txn[0].clone()] }, 129);
8207 check_closed_broadcast!(nodes[0], false);
8208 check_added_monitors!(nodes[0], 1);
8210 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8211 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
8212 check_spends!(node_txn[0], revoked_local_txn[0]);
8213 check_spends!(node_txn[1], revoked_local_txn[0]);
8214 check_spends!(node_txn[2], revoked_local_txn[0]);
8215 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
8219 let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8220 connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn }, 130);
8221 connect_blocks(&nodes[0], 5, 130, false, header_130.bitcoin_hash());
8223 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.lock().unwrap();
8224 if let Some(monitor) = monitors.get(&OutPoint { txid: chan.3.txid(), index: 0 }) {
8225 assert!(monitor.onchain_tx_handler.pending_claim_requests.is_empty());
8226 assert!(monitor.onchain_tx_handler.claimable_outpoints.is_empty());
8232 fn test_override_channel_config() {
8233 let chanmon_cfgs = create_chanmon_cfgs(2);
8234 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8235 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8236 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8238 // Node0 initiates a channel to node1 using the override config.
8239 let mut override_config = UserConfig::default();
8240 override_config.own_channel_config.our_to_self_delay = 200;
8242 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
8244 // Assert the channel created by node0 is using the override config.
8245 let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8246 assert_eq!(res.channel_flags, 0);
8247 assert_eq!(res.to_self_delay, 200);
8251 fn test_override_0msat_htlc_minimum() {
8252 let mut zero_config = UserConfig::default();
8253 zero_config.own_channel_config.our_htlc_minimum_msat = 0;
8254 let chanmon_cfgs = create_chanmon_cfgs(2);
8255 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8256 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
8257 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8259 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
8260 let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8261 assert_eq!(res.htlc_minimum_msat, 1);
8263 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &res);
8264 let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8265 assert_eq!(res.htlc_minimum_msat, 1);
8269 fn test_simple_payment_secret() {
8270 // Simple test of sending a payment with a payment_secret present. This does not use any AMP
8271 // features, however.
8272 let chanmon_cfgs = create_chanmon_cfgs(3);
8273 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8274 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8275 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8277 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8278 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
8279 let logger = test_utils::TestLogger::new();
8281 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(&nodes[0]);
8282 let payment_secret = PaymentSecret([0xdb; 32]);
8283 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8284 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();
8285 send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2]]], 100000, payment_hash, Some(payment_secret.clone()));
8286 // Claiming with all the correct values but the wrong secret should result in nothing...
8287 assert_eq!(nodes[2].node.claim_funds(payment_preimage, &None, 100_000), false);
8288 assert_eq!(nodes[2].node.claim_funds(payment_preimage, &Some(PaymentSecret([42; 32])), 100_000), false);
8289 // ...but with the right secret we should be able to claim all the way back
8290 claim_payment_along_route_with_secret(&nodes[0], &[&[&nodes[1], &nodes[2]]], false, payment_preimage, Some(payment_secret.clone()), 100_000);
8294 fn test_simple_mpp() {
8295 // Simple test of sending a multi-path payment.
8296 let chanmon_cfgs = create_chanmon_cfgs(4);
8297 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8298 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8299 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8301 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8302 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8303 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8304 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8305 let logger = test_utils::TestLogger::new();
8307 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(&nodes[0]);
8308 let payment_secret = PaymentSecret([0xdb; 32]);
8309 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8310 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();
8311 let path = route.paths[0].clone();
8312 route.paths.push(path);
8313 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8314 route.paths[0][0].short_channel_id = chan_1_id;
8315 route.paths[0][1].short_channel_id = chan_3_id;
8316 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8317 route.paths[1][0].short_channel_id = chan_2_id;
8318 route.paths[1][1].short_channel_id = chan_4_id;
8319 send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, Some(payment_secret.clone()));
8320 // Claiming with all the correct values but the wrong secret should result in nothing...
8321 assert_eq!(nodes[3].node.claim_funds(payment_preimage, &None, 200_000), false);
8322 assert_eq!(nodes[3].node.claim_funds(payment_preimage, &Some(PaymentSecret([42; 32])), 200_000), false);
8323 // ...but with the right secret we should be able to claim all the way back
8324 claim_payment_along_route_with_secret(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage, Some(payment_secret), 200_000);
8328 fn test_update_err_monitor_lockdown() {
8329 // Our monitor will lock update of local commitment transaction if a broadcastion condition
8330 // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
8331 // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateErr.
8333 // This scenario may happen in a watchtower setup, where watchtower process a block height
8334 // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
8335 // commitment at same time.
8337 let chanmon_cfgs = create_chanmon_cfgs(2);
8338 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8339 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8340 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8342 // Create some initial channel
8343 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8344 let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8346 // Rebalance the network to generate htlc in the two directions
8347 send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000, 10_000_000);
8349 // Route a HTLC from node 0 to node 1 (but don't settle)
8350 let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8352 // Copy ChainMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
8353 let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
8355 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.lock().unwrap();
8356 let monitor = monitors.get(&outpoint).unwrap();
8357 let mut w = test_utils::TestVecWriter(Vec::new());
8358 monitor.write_for_disk(&mut w).unwrap();
8359 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingChannelKeys>)>::read(
8360 &mut ::std::io::Cursor::new(&w.0)).unwrap().1;
8361 assert!(new_monitor == *monitor);
8362 let watchtower = test_utils::TestChainMonitor::new(&chanmon_cfgs[0].tx_broadcaster, &logger, &chanmon_cfgs[0].fee_estimator);
8363 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8366 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8367 watchtower.chain_monitor.block_connected(&header, &[], 200);
8369 // Try to update ChannelMonitor
8370 assert!(nodes[1].node.claim_funds(preimage, &None, 9_000_000));
8371 check_added_monitors!(nodes[1], 1);
8372 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8373 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8374 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8375 if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8376 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8377 if let Err(_) = watchtower.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8378 if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8379 } else { assert!(false); }
8380 } else { assert!(false); };
8381 // Our local monitor is in-sync and hasn't processed yet timeout
8382 check_added_monitors!(nodes[0], 1);
8383 let events = nodes[0].node.get_and_clear_pending_events();
8384 assert_eq!(events.len(), 1);