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.
5 use chain::transaction::OutPoint;
6 use chain::chaininterface::{ChainListener, ChainWatchInterfaceUtil};
7 use chain::keysinterface::{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, BREAKDOWN_TIMEOUT};
10 use ln::channelmonitor::{ChannelMonitor, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ManyChannelMonitor, ANTI_REORG_DELAY};
11 use ln::channel::{Channel, ChannelError};
13 use ln::router::{Route, RouteHop};
14 use ln::features::{ChannelFeatures, InitFeatures};
16 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler,HTLCFailChannelUpdate, ErrorAction};
17 use util::enforcing_trait_impls::EnforcingChannelKeys;
19 use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
20 use util::errors::APIError;
21 use util::ser::{Writeable, ReadableArgs};
22 use util::config::UserConfig;
23 use util::logger::Logger;
25 use bitcoin::util::hash::BitcoinHash;
26 use bitcoin_hashes::sha256d::Hash as Sha256dHash;
27 use bitcoin::util::bip143;
28 use bitcoin::util::address::Address;
29 use bitcoin::util::bip32::{ChildNumber, ExtendedPubKey, ExtendedPrivKey};
30 use bitcoin::blockdata::block::{Block, BlockHeader};
31 use bitcoin::blockdata::transaction::{Transaction, TxOut, TxIn, SigHashType, OutPoint as BitcoinOutPoint};
32 use bitcoin::blockdata::script::{Builder, Script};
33 use bitcoin::blockdata::opcodes;
34 use bitcoin::blockdata::constants::genesis_block;
35 use bitcoin::network::constants::Network;
37 use bitcoin_hashes::sha256::Hash as Sha256;
38 use bitcoin_hashes::Hash;
40 use secp256k1::{Secp256k1, Message};
41 use secp256k1::key::{PublicKey,SecretKey};
43 use std::collections::{BTreeSet, HashMap, HashSet};
44 use std::default::Default;
45 use std::sync::{Arc, Mutex};
46 use std::sync::atomic::Ordering;
49 use rand::{thread_rng, Rng};
51 use ln::functional_test_utils::*;
54 fn test_insane_channel_opens() {
55 // Stand up a network of 2 nodes
56 let nodes = create_network(2, &[None, None]);
58 // Instantiate channel parameters where we push the maximum msats given our
60 let channel_value_sat = 31337; // same as funding satoshis
61 let channel_reserve_satoshis = Channel::<EnforcingChannelKeys>::get_our_channel_reserve_satoshis(channel_value_sat);
62 let push_msat = (channel_value_sat - channel_reserve_satoshis) * 1000;
64 // Have node0 initiate a channel to node1 with aforementioned parameters
65 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_sat, push_msat, 42).unwrap();
67 // Extract the channel open message from node0 to node1
68 let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
70 // Test helper that asserts we get the correct error string given a mutator
71 // that supposedly makes the channel open message insane
72 let insane_open_helper = |expected_error_str: &str, message_mutator: fn(msgs::OpenChannel) -> msgs::OpenChannel| {
73 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::supported(), &message_mutator(open_channel_message.clone()));
74 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
75 assert_eq!(msg_events.len(), 1);
76 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
78 &ErrorAction::SendErrorMessage { .. } => {
79 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), expected_error_str.to_string(), 1);
81 _ => panic!("unexpected event!"),
83 } else { assert!(false); }
86 use ln::channel::MAX_FUNDING_SATOSHIS;
87 use ln::channelmanager::MAX_LOCAL_BREAKDOWN_TIMEOUT;
89 // Test all mutations that would make the channel open message insane
90 insane_open_helper("funding value > 2^24", |mut msg| { msg.funding_satoshis = MAX_FUNDING_SATOSHIS; msg });
92 insane_open_helper("Bogus channel_reserve_satoshis", |mut msg| { msg.channel_reserve_satoshis = msg.funding_satoshis + 1; msg });
94 insane_open_helper("push_msat larger than funding value", |mut msg| { msg.push_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 + 1; msg });
96 insane_open_helper("Peer never wants payout outputs?", |mut msg| { msg.dust_limit_satoshis = msg.funding_satoshis + 1 ; msg });
98 insane_open_helper("Bogus; channel reserve is less than dust limit", |mut msg| { msg.dust_limit_satoshis = msg.channel_reserve_satoshis + 1; msg });
100 insane_open_helper("Minimum htlc value is full channel value", |mut msg| { msg.htlc_minimum_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000; msg });
102 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 });
104 insane_open_helper("0 max_accpted_htlcs makes for a useless channel", |mut msg| { msg.max_accepted_htlcs = 0; msg });
106 insane_open_helper("max_accpted_htlcs > 483", |mut msg| { msg.max_accepted_htlcs = 484; msg });
110 fn test_async_inbound_update_fee() {
111 let mut nodes = create_network(2, &[None, None]);
112 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
113 let channel_id = chan.2;
116 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
120 // send (1) commitment_signed -.
121 // <- update_add_htlc/commitment_signed
122 // send (2) RAA (awaiting remote revoke) -.
123 // (1) commitment_signed is delivered ->
124 // .- send (3) RAA (awaiting remote revoke)
125 // (2) RAA is delivered ->
126 // .- send (4) commitment_signed
127 // <- (3) RAA is delivered
128 // send (5) commitment_signed -.
129 // <- (4) commitment_signed is delivered
131 // (5) commitment_signed is delivered ->
133 // (6) RAA is delivered ->
135 // First nodes[0] generates an update_fee
136 nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
137 check_added_monitors!(nodes[0], 1);
139 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
140 assert_eq!(events_0.len(), 1);
141 let (update_msg, commitment_signed) = match events_0[0] { // (1)
142 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
143 (update_fee.as_ref(), commitment_signed)
145 _ => panic!("Unexpected event"),
148 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
150 // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
151 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
152 nodes[1].node.send_payment(nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV).unwrap(), our_payment_hash).unwrap();
153 check_added_monitors!(nodes[1], 1);
155 let payment_event = {
156 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
157 assert_eq!(events_1.len(), 1);
158 SendEvent::from_event(events_1.remove(0))
160 assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
161 assert_eq!(payment_event.msgs.len(), 1);
163 // ...now when the messages get delivered everyone should be happy
164 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
165 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
166 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
167 // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
168 check_added_monitors!(nodes[0], 1);
170 // deliver(1), generate (3):
171 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
172 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
173 // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
174 check_added_monitors!(nodes[1], 1);
176 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack); // deliver (2)
177 let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
178 assert!(bs_update.update_add_htlcs.is_empty()); // (4)
179 assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
180 assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
181 assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
182 assert!(bs_update.update_fee.is_none()); // (4)
183 check_added_monitors!(nodes[1], 1);
185 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack); // deliver (3)
186 let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
187 assert!(as_update.update_add_htlcs.is_empty()); // (5)
188 assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
189 assert!(as_update.update_fail_htlcs.is_empty()); // (5)
190 assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
191 assert!(as_update.update_fee.is_none()); // (5)
192 check_added_monitors!(nodes[0], 1);
194 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed); // deliver (4)
195 let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
196 // only (6) so get_event_msg's assert(len == 1) passes
197 check_added_monitors!(nodes[0], 1);
199 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed); // deliver (5)
200 let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
201 check_added_monitors!(nodes[1], 1);
203 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
204 check_added_monitors!(nodes[0], 1);
206 let events_2 = nodes[0].node.get_and_clear_pending_events();
207 assert_eq!(events_2.len(), 1);
209 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
210 _ => panic!("Unexpected event"),
213 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke); // deliver (6)
214 check_added_monitors!(nodes[1], 1);
218 fn test_update_fee_unordered_raa() {
219 // Just the intro to the previous test followed by an out-of-order RAA (which caused a
220 // crash in an earlier version of the update_fee patch)
221 let mut nodes = create_network(2, &[None, None]);
222 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
223 let channel_id = chan.2;
226 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
228 // First nodes[0] generates an update_fee
229 nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
230 check_added_monitors!(nodes[0], 1);
232 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
233 assert_eq!(events_0.len(), 1);
234 let update_msg = match events_0[0] { // (1)
235 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
238 _ => panic!("Unexpected event"),
241 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
243 // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
244 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
245 nodes[1].node.send_payment(nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV).unwrap(), our_payment_hash).unwrap();
246 check_added_monitors!(nodes[1], 1);
248 let payment_event = {
249 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
250 assert_eq!(events_1.len(), 1);
251 SendEvent::from_event(events_1.remove(0))
253 assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
254 assert_eq!(payment_event.msgs.len(), 1);
256 // ...now when the messages get delivered everyone should be happy
257 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
258 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
259 let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
260 // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
261 check_added_monitors!(nodes[0], 1);
263 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg); // deliver (2)
264 check_added_monitors!(nodes[1], 1);
266 // We can't continue, sadly, because our (1) now has a bogus signature
270 fn test_multi_flight_update_fee() {
271 let nodes = create_network(2, &[None, None]);
272 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
273 let channel_id = chan.2;
276 // update_fee/commitment_signed ->
277 // .- send (1) RAA and (2) commitment_signed
278 // update_fee (never committed) ->
280 // We have to manually generate the above update_fee, it is allowed by the protocol but we
281 // don't track which updates correspond to which revoke_and_ack responses so we're in
282 // AwaitingRAA mode and will not generate the update_fee yet.
283 // <- (1) RAA delivered
284 // (3) is generated and send (4) CS -.
285 // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
286 // know the per_commitment_point to use for it.
287 // <- (2) commitment_signed delivered
289 // B should send no response here
290 // (4) commitment_signed delivered ->
291 // <- RAA/commitment_signed delivered
294 // First nodes[0] generates an update_fee
295 let initial_feerate = get_feerate!(nodes[0], channel_id);
296 nodes[0].node.update_fee(channel_id, initial_feerate + 20).unwrap();
297 check_added_monitors!(nodes[0], 1);
299 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
300 assert_eq!(events_0.len(), 1);
301 let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
302 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
303 (update_fee.as_ref().unwrap(), commitment_signed)
305 _ => panic!("Unexpected event"),
308 // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
309 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1);
310 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1);
311 let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
312 check_added_monitors!(nodes[1], 1);
314 // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
316 nodes[0].node.update_fee(channel_id, initial_feerate + 40).unwrap();
317 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
318 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
320 // Create the (3) update_fee message that nodes[0] will generate before it does...
321 let mut update_msg_2 = msgs::UpdateFee {
322 channel_id: update_msg_1.channel_id.clone(),
323 feerate_per_kw: (initial_feerate + 30) as u32,
326 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
328 update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
330 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
332 // Deliver (1), generating (3) and (4)
333 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg);
334 let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
335 check_added_monitors!(nodes[0], 1);
336 assert!(as_second_update.update_add_htlcs.is_empty());
337 assert!(as_second_update.update_fulfill_htlcs.is_empty());
338 assert!(as_second_update.update_fail_htlcs.is_empty());
339 assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
340 // Check that the update_fee newly generated matches what we delivered:
341 assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
342 assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
344 // Deliver (2) commitment_signed
345 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
346 let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
347 check_added_monitors!(nodes[0], 1);
348 // No commitment_signed so get_event_msg's assert(len == 1) passes
350 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg);
351 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
352 check_added_monitors!(nodes[1], 1);
355 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
356 let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
357 check_added_monitors!(nodes[1], 1);
359 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
360 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
361 check_added_monitors!(nodes[0], 1);
363 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment);
364 let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
365 // No commitment_signed so get_event_msg's assert(len == 1) passes
366 check_added_monitors!(nodes[0], 1);
368 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke);
369 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
370 check_added_monitors!(nodes[1], 1);
374 fn test_update_fee_vanilla() {
375 let nodes = create_network(2, &[None, None]);
376 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
377 let channel_id = chan.2;
379 let feerate = get_feerate!(nodes[0], channel_id);
380 nodes[0].node.update_fee(channel_id, feerate+25).unwrap();
381 check_added_monitors!(nodes[0], 1);
383 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
384 assert_eq!(events_0.len(), 1);
385 let (update_msg, commitment_signed) = match events_0[0] {
386 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 } } => {
387 (update_fee.as_ref(), commitment_signed)
389 _ => panic!("Unexpected event"),
391 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
393 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
394 let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
395 check_added_monitors!(nodes[1], 1);
397 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
398 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
399 check_added_monitors!(nodes[0], 1);
401 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
402 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
403 // No commitment_signed so get_event_msg's assert(len == 1) passes
404 check_added_monitors!(nodes[0], 1);
406 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
407 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
408 check_added_monitors!(nodes[1], 1);
412 fn test_update_fee_that_funder_cannot_afford() {
413 let nodes = create_network(2, &[None, None]);
414 let channel_value = 1888;
415 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000, InitFeatures::supported(), InitFeatures::supported());
416 let channel_id = chan.2;
419 nodes[0].node.update_fee(channel_id, feerate).unwrap();
420 check_added_monitors!(nodes[0], 1);
421 let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
423 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap());
425 commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
427 //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
428 //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
430 let mut chan_lock = nodes[1].node.channel_state.lock().unwrap();
431 let chan = chan_lock.by_id.get_mut(&channel_id).unwrap();
433 //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
434 let num_htlcs = chan.channel_monitor().get_latest_local_commitment_txn()[0].output.len() - 2;
435 let total_fee: u64 = feerate * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
436 let mut actual_fee = chan.channel_monitor().get_latest_local_commitment_txn()[0].output.iter().fold(0, |acc, output| acc + output.value);
437 actual_fee = channel_value - actual_fee;
438 assert_eq!(total_fee, actual_fee);
441 //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
442 //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
443 nodes[0].node.update_fee(channel_id, feerate+2).unwrap();
444 check_added_monitors!(nodes[0], 1);
446 let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
448 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap());
450 //While producing the commitment_signed response after handling a received update_fee request the
451 //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
452 //Should produce and error.
453 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed);
454 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Funding remote cannot afford proposed new fee".to_string(), 1);
456 //clear the message we could not handle
457 nodes[1].node.get_and_clear_pending_msg_events();
461 fn test_update_fee_with_fundee_update_add_htlc() {
462 let mut nodes = create_network(2, &[None, None]);
463 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
464 let channel_id = chan.2;
467 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
469 let feerate = get_feerate!(nodes[0], channel_id);
470 nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
471 check_added_monitors!(nodes[0], 1);
473 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
474 assert_eq!(events_0.len(), 1);
475 let (update_msg, commitment_signed) = match events_0[0] {
476 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 } } => {
477 (update_fee.as_ref(), commitment_signed)
479 _ => panic!("Unexpected event"),
481 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
482 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
483 let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
484 check_added_monitors!(nodes[1], 1);
486 let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 800000, TEST_FINAL_CLTV).unwrap();
488 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[1]);
490 // nothing happens since node[1] is in AwaitingRemoteRevoke
491 nodes[1].node.send_payment(route, our_payment_hash).unwrap();
493 let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
494 assert_eq!(added_monitors.len(), 0);
495 added_monitors.clear();
497 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
498 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
499 // node[1] has nothing to do
501 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
502 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
503 check_added_monitors!(nodes[0], 1);
505 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
506 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
507 // No commitment_signed so get_event_msg's assert(len == 1) passes
508 check_added_monitors!(nodes[0], 1);
509 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
510 check_added_monitors!(nodes[1], 1);
511 // AwaitingRemoteRevoke ends here
513 let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
514 assert_eq!(commitment_update.update_add_htlcs.len(), 1);
515 assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
516 assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
517 assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
518 assert_eq!(commitment_update.update_fee.is_none(), true);
520 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]);
521 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
522 check_added_monitors!(nodes[0], 1);
523 let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
525 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke);
526 check_added_monitors!(nodes[1], 1);
527 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
529 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
530 check_added_monitors!(nodes[1], 1);
531 let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
532 // No commitment_signed so get_event_msg's assert(len == 1) passes
534 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke);
535 check_added_monitors!(nodes[0], 1);
536 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
538 expect_pending_htlcs_forwardable!(nodes[0]);
540 let events = nodes[0].node.get_and_clear_pending_events();
541 assert_eq!(events.len(), 1);
543 Event::PaymentReceived { .. } => { },
544 _ => panic!("Unexpected event"),
547 claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage, 800_000);
549 send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000, 800_000);
550 send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000, 800_000);
551 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
555 fn test_update_fee() {
556 let nodes = create_network(2, &[None, None]);
557 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
558 let channel_id = chan.2;
561 // (1) update_fee/commitment_signed ->
562 // <- (2) revoke_and_ack
563 // .- send (3) commitment_signed
564 // (4) update_fee/commitment_signed ->
565 // .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
566 // <- (3) commitment_signed delivered
567 // send (6) revoke_and_ack -.
568 // <- (5) deliver revoke_and_ack
569 // (6) deliver revoke_and_ack ->
570 // .- send (7) commitment_signed in response to (4)
571 // <- (7) deliver commitment_signed
574 // Create and deliver (1)...
575 let feerate = get_feerate!(nodes[0], channel_id);
576 nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
577 check_added_monitors!(nodes[0], 1);
579 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
580 assert_eq!(events_0.len(), 1);
581 let (update_msg, commitment_signed) = match events_0[0] {
582 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 } } => {
583 (update_fee.as_ref(), commitment_signed)
585 _ => panic!("Unexpected event"),
587 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
589 // Generate (2) and (3):
590 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
591 let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
592 check_added_monitors!(nodes[1], 1);
595 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
596 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
597 check_added_monitors!(nodes[0], 1);
599 // Create and deliver (4)...
600 nodes[0].node.update_fee(channel_id, feerate+30).unwrap();
601 check_added_monitors!(nodes[0], 1);
602 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
603 assert_eq!(events_0.len(), 1);
604 let (update_msg, commitment_signed) = match events_0[0] {
605 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 } } => {
606 (update_fee.as_ref(), commitment_signed)
608 _ => panic!("Unexpected event"),
611 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
612 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
613 check_added_monitors!(nodes[1], 1);
615 let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
616 // No commitment_signed so get_event_msg's assert(len == 1) passes
618 // Handle (3), creating (6):
619 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0);
620 check_added_monitors!(nodes[0], 1);
621 let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
622 // No commitment_signed so get_event_msg's assert(len == 1) passes
625 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
626 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
627 check_added_monitors!(nodes[0], 1);
629 // Deliver (6), creating (7):
630 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0);
631 let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
632 assert!(commitment_update.update_add_htlcs.is_empty());
633 assert!(commitment_update.update_fulfill_htlcs.is_empty());
634 assert!(commitment_update.update_fail_htlcs.is_empty());
635 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
636 assert!(commitment_update.update_fee.is_none());
637 check_added_monitors!(nodes[1], 1);
640 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
641 check_added_monitors!(nodes[0], 1);
642 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
643 // No commitment_signed so get_event_msg's assert(len == 1) passes
645 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
646 check_added_monitors!(nodes[1], 1);
647 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
649 assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
650 assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
651 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
655 fn pre_funding_lock_shutdown_test() {
656 // Test sending a shutdown prior to funding_locked after funding generation
657 let nodes = create_network(2, &[None, None]);
658 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0, InitFeatures::supported(), InitFeatures::supported());
659 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
660 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![tx.clone()]}, 1);
661 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![tx.clone()]}, 1);
663 nodes[0].node.close_channel(&OutPoint::new(tx.txid(), 0).to_channel_id()).unwrap();
664 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
665 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
666 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
667 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
669 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
670 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
671 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
672 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
673 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
674 assert!(node_0_none.is_none());
676 assert!(nodes[0].node.list_channels().is_empty());
677 assert!(nodes[1].node.list_channels().is_empty());
681 fn updates_shutdown_wait() {
682 // Test sending a shutdown with outstanding updates pending
683 let mut nodes = create_network(3, &[None, None, None]);
684 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
685 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
686 let route_1 = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
687 let route_2 = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
689 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
691 nodes[0].node.close_channel(&chan_1.2).unwrap();
692 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
693 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
694 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
695 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
697 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
698 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
700 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
701 if let Err(APIError::ChannelUnavailable {..}) = nodes[0].node.send_payment(route_1, payment_hash) {}
702 else { panic!("New sends should fail!") };
703 if let Err(APIError::ChannelUnavailable {..}) = nodes[1].node.send_payment(route_2, payment_hash) {}
704 else { panic!("New sends should fail!") };
706 assert!(nodes[2].node.claim_funds(our_payment_preimage, 100_000));
707 check_added_monitors!(nodes[2], 1);
708 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
709 assert!(updates.update_add_htlcs.is_empty());
710 assert!(updates.update_fail_htlcs.is_empty());
711 assert!(updates.update_fail_malformed_htlcs.is_empty());
712 assert!(updates.update_fee.is_none());
713 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
714 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
715 check_added_monitors!(nodes[1], 1);
716 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
717 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
719 assert!(updates_2.update_add_htlcs.is_empty());
720 assert!(updates_2.update_fail_htlcs.is_empty());
721 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
722 assert!(updates_2.update_fee.is_none());
723 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
724 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
725 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
727 let events = nodes[0].node.get_and_clear_pending_events();
728 assert_eq!(events.len(), 1);
730 Event::PaymentSent { ref payment_preimage } => {
731 assert_eq!(our_payment_preimage, *payment_preimage);
733 _ => panic!("Unexpected event"),
736 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
737 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
738 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
739 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
740 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
741 assert!(node_0_none.is_none());
743 assert!(nodes[0].node.list_channels().is_empty());
745 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
746 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
747 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
748 assert!(nodes[1].node.list_channels().is_empty());
749 assert!(nodes[2].node.list_channels().is_empty());
753 fn htlc_fail_async_shutdown() {
754 // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
755 let mut nodes = create_network(3, &[None, None, None]);
756 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
757 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
759 let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
760 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
761 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
762 check_added_monitors!(nodes[0], 1);
763 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
764 assert_eq!(updates.update_add_htlcs.len(), 1);
765 assert!(updates.update_fulfill_htlcs.is_empty());
766 assert!(updates.update_fail_htlcs.is_empty());
767 assert!(updates.update_fail_malformed_htlcs.is_empty());
768 assert!(updates.update_fee.is_none());
770 nodes[1].node.close_channel(&chan_1.2).unwrap();
771 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
772 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
773 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
775 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
776 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
777 check_added_monitors!(nodes[1], 1);
778 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
779 commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
781 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
782 assert!(updates_2.update_add_htlcs.is_empty());
783 assert!(updates_2.update_fulfill_htlcs.is_empty());
784 assert_eq!(updates_2.update_fail_htlcs.len(), 1);
785 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
786 assert!(updates_2.update_fee.is_none());
788 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
789 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
791 let events = nodes[0].node.get_and_clear_pending_events();
792 assert_eq!(events.len(), 1);
794 Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } => {
795 assert_eq!(our_payment_hash, *payment_hash);
796 assert!(!rejected_by_dest);
798 _ => panic!("Unexpected event"),
801 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
802 assert_eq!(msg_events.len(), 2);
803 let node_0_closing_signed = match msg_events[0] {
804 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
805 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
808 _ => panic!("Unexpected event"),
810 match msg_events[1] {
811 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
812 assert_eq!(msg.contents.short_channel_id, chan_1.0.contents.short_channel_id);
814 _ => panic!("Unexpected event"),
817 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
818 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
819 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
820 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
821 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
822 assert!(node_0_none.is_none());
824 assert!(nodes[0].node.list_channels().is_empty());
826 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
827 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
828 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
829 assert!(nodes[1].node.list_channels().is_empty());
830 assert!(nodes[2].node.list_channels().is_empty());
833 fn do_test_shutdown_rebroadcast(recv_count: u8) {
834 // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
835 // messages delivered prior to disconnect
836 let nodes = create_network(3, &[None, None, None]);
837 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
838 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
840 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
842 nodes[1].node.close_channel(&chan_1.2).unwrap();
843 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
845 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
846 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
848 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
852 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
853 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
855 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
856 let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
857 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
858 let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
860 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
861 let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
862 assert!(node_1_shutdown == node_1_2nd_shutdown);
864 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
865 let node_0_2nd_shutdown = if recv_count > 0 {
866 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
867 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
870 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
871 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
872 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
874 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_2nd_shutdown);
876 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
877 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
879 assert!(nodes[2].node.claim_funds(our_payment_preimage, 100_000));
880 check_added_monitors!(nodes[2], 1);
881 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
882 assert!(updates.update_add_htlcs.is_empty());
883 assert!(updates.update_fail_htlcs.is_empty());
884 assert!(updates.update_fail_malformed_htlcs.is_empty());
885 assert!(updates.update_fee.is_none());
886 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
887 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
888 check_added_monitors!(nodes[1], 1);
889 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
890 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
892 assert!(updates_2.update_add_htlcs.is_empty());
893 assert!(updates_2.update_fail_htlcs.is_empty());
894 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
895 assert!(updates_2.update_fee.is_none());
896 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
897 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
898 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
900 let events = nodes[0].node.get_and_clear_pending_events();
901 assert_eq!(events.len(), 1);
903 Event::PaymentSent { ref payment_preimage } => {
904 assert_eq!(our_payment_preimage, *payment_preimage);
906 _ => panic!("Unexpected event"),
909 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
911 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
912 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
913 assert!(node_1_closing_signed.is_some());
916 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
917 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
919 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
920 let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
921 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
923 // If all closing_signeds weren't delivered we can just resume where we left off...
924 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
926 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
927 let node_0_3rd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
928 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
930 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
931 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
932 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
934 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_3rd_shutdown);
935 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
937 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_3rd_shutdown);
938 let node_0_2nd_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
939 assert!(node_0_closing_signed == node_0_2nd_closing_signed);
941 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
942 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
943 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
944 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
945 assert!(node_0_none.is_none());
947 // If one node, however, received + responded with an identical closing_signed we end
948 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
949 // There isn't really anything better we can do simply, but in the future we might
950 // explore storing a set of recently-closed channels that got disconnected during
951 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
952 // give our counterparty enough time to (potentially) broadcast a cooperative closing
954 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
956 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
957 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
958 assert_eq!(msg_events.len(), 1);
959 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
961 &ErrorAction::SendErrorMessage { ref msg } => {
962 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msg);
963 assert_eq!(msg.channel_id, chan_1.2);
965 _ => panic!("Unexpected event!"),
967 } else { panic!("Needed SendErrorMessage close"); }
969 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
970 // checks it, but in this case nodes[0] didn't ever get a chance to receive a
971 // closing_signed so we do it ourselves
972 check_closed_broadcast!(nodes[0], false);
975 assert!(nodes[0].node.list_channels().is_empty());
977 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
978 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
979 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
980 assert!(nodes[1].node.list_channels().is_empty());
981 assert!(nodes[2].node.list_channels().is_empty());
985 fn test_shutdown_rebroadcast() {
986 do_test_shutdown_rebroadcast(0);
987 do_test_shutdown_rebroadcast(1);
988 do_test_shutdown_rebroadcast(2);
992 fn fake_network_test() {
993 // Simple test which builds a network of ChannelManagers, connects them to each other, and
994 // tests that payments get routed and transactions broadcast in semi-reasonable ways.
995 let nodes = create_network(4, &[None, None, None, None]);
997 // Create some initial channels
998 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
999 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
1000 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
1002 // Rebalance the network a bit by relaying one payment through all the channels...
1003 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1004 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1005 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1006 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1008 // Send some more payments
1009 send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000, 1_000_000);
1010 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000, 1_000_000);
1011 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000, 1_000_000);
1013 // Test failure packets
1014 let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
1015 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
1017 // Add a new channel that skips 3
1018 let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::supported(), InitFeatures::supported());
1020 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000, 1_000_000);
1021 send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000, 1_000_000);
1022 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1023 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1024 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1025 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1026 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1028 // Do some rebalance loop payments, simultaneously
1029 let mut hops = Vec::with_capacity(3);
1030 hops.push(RouteHop {
1031 pubkey: nodes[2].node.get_our_node_id(),
1032 short_channel_id: chan_2.0.contents.short_channel_id,
1034 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
1036 hops.push(RouteHop {
1037 pubkey: nodes[3].node.get_our_node_id(),
1038 short_channel_id: chan_3.0.contents.short_channel_id,
1040 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
1042 hops.push(RouteHop {
1043 pubkey: nodes[1].node.get_our_node_id(),
1044 short_channel_id: chan_4.0.contents.short_channel_id,
1046 cltv_expiry_delta: TEST_FINAL_CLTV,
1048 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;
1049 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;
1050 let payment_preimage_1 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
1052 let mut hops = Vec::with_capacity(3);
1053 hops.push(RouteHop {
1054 pubkey: nodes[3].node.get_our_node_id(),
1055 short_channel_id: chan_4.0.contents.short_channel_id,
1057 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
1059 hops.push(RouteHop {
1060 pubkey: nodes[2].node.get_our_node_id(),
1061 short_channel_id: chan_3.0.contents.short_channel_id,
1063 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
1065 hops.push(RouteHop {
1066 pubkey: nodes[1].node.get_our_node_id(),
1067 short_channel_id: chan_2.0.contents.short_channel_id,
1069 cltv_expiry_delta: TEST_FINAL_CLTV,
1071 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;
1072 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;
1073 let payment_hash_2 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1075 // Claim the rebalances...
1076 fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1077 claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1, 1_000_000);
1079 // Add a duplicate new channel from 2 to 4
1080 let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::supported(), InitFeatures::supported());
1082 // Send some payments across both channels
1083 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1084 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1085 let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1088 route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
1089 let events = nodes[0].node.get_and_clear_pending_msg_events();
1090 assert_eq!(events.len(), 0);
1091 nodes[0].logger.assert_log("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);
1093 //TODO: Test that routes work again here as we've been notified that the channel is full
1095 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3, 3_000_000);
1096 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4, 3_000_000);
1097 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5, 3_000_000);
1099 // Close down the channels...
1100 close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1101 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1102 close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1103 close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1104 close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
1108 fn holding_cell_htlc_counting() {
1109 // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1110 // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1111 // commitment dance rounds.
1112 let mut nodes = create_network(3, &[None, None, None]);
1113 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1114 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
1116 let mut payments = Vec::new();
1117 for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1118 let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
1119 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1120 nodes[1].node.send_payment(route, payment_hash).unwrap();
1121 payments.push((payment_preimage, payment_hash));
1123 check_added_monitors!(nodes[1], 1);
1125 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1126 assert_eq!(events.len(), 1);
1127 let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1128 assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1130 // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1131 // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1133 let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
1134 let (_, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
1135 if let APIError::ChannelUnavailable { err } = nodes[1].node.send_payment(route, payment_hash_1).unwrap_err() {
1136 assert_eq!(err, "Cannot push more than their max accepted HTLCs");
1137 } else { panic!("Unexpected event"); }
1138 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1139 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1141 // This should also be true if we try to forward a payment.
1142 let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
1143 let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
1144 nodes[0].node.send_payment(route, payment_hash_2).unwrap();
1145 check_added_monitors!(nodes[0], 1);
1147 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1148 assert_eq!(events.len(), 1);
1149 let payment_event = SendEvent::from_event(events.pop().unwrap());
1150 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1152 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1153 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1154 // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1155 // fails), the second will process the resulting failure and fail the HTLC backward.
1156 expect_pending_htlcs_forwardable!(nodes[1]);
1157 expect_pending_htlcs_forwardable!(nodes[1]);
1158 check_added_monitors!(nodes[1], 1);
1160 let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1161 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1162 commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1164 let events = nodes[0].node.get_and_clear_pending_msg_events();
1165 assert_eq!(events.len(), 1);
1167 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
1168 assert_eq!(msg.contents.short_channel_id, chan_2.0.contents.short_channel_id);
1170 _ => panic!("Unexpected event"),
1173 let events = nodes[0].node.get_and_clear_pending_events();
1174 assert_eq!(events.len(), 1);
1176 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
1177 assert_eq!(payment_hash, payment_hash_2);
1178 assert!(!rejected_by_dest);
1180 _ => panic!("Unexpected event"),
1183 // Now forward all the pending HTLCs and claim them back
1184 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1185 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1186 check_added_monitors!(nodes[2], 1);
1188 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1189 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1190 check_added_monitors!(nodes[1], 1);
1191 let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1193 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1194 check_added_monitors!(nodes[1], 1);
1195 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1197 for ref update in as_updates.update_add_htlcs.iter() {
1198 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1200 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1201 check_added_monitors!(nodes[2], 1);
1202 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1203 check_added_monitors!(nodes[2], 1);
1204 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1206 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1207 check_added_monitors!(nodes[1], 1);
1208 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1209 check_added_monitors!(nodes[1], 1);
1210 let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1212 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1213 check_added_monitors!(nodes[2], 1);
1215 expect_pending_htlcs_forwardable!(nodes[2]);
1217 let events = nodes[2].node.get_and_clear_pending_events();
1218 assert_eq!(events.len(), payments.len());
1219 for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1221 &Event::PaymentReceived { ref payment_hash, .. } => {
1222 assert_eq!(*payment_hash, *hash);
1224 _ => panic!("Unexpected event"),
1228 for (preimage, _) in payments.drain(..) {
1229 claim_payment(&nodes[1], &[&nodes[2]], preimage, 100_000);
1232 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000, 1_000_000);
1236 fn duplicate_htlc_test() {
1237 // Test that we accept duplicate payment_hash HTLCs across the network and that
1238 // claiming/failing them are all separate and don't affect each other
1239 let mut nodes = create_network(6, &[None, None, None, None, None, None]);
1241 // Create some initial channels to route via 3 to 4/5 from 0/1/2
1242 create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::supported(), InitFeatures::supported());
1243 create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::supported(), InitFeatures::supported());
1244 create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
1245 create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::supported(), InitFeatures::supported());
1246 create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::supported(), InitFeatures::supported());
1248 let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1250 *nodes[0].network_payment_count.borrow_mut() -= 1;
1251 assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1253 *nodes[0].network_payment_count.borrow_mut() -= 1;
1254 assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1256 claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage, 1_000_000);
1257 fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1258 claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage, 1_000_000);
1262 fn test_duplicate_htlc_different_direction_onchain() {
1263 // Test that ChannelMonitor doesn't generate 2 preimage txn
1264 // when we have 2 HTLCs with same preimage that go across a node
1265 // in opposite directions.
1266 let nodes = create_network(2, &[None, None]);
1268 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1271 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
1273 let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1275 let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 800_000, TEST_FINAL_CLTV).unwrap();
1276 send_along_route_with_hash(&nodes[1], route, &vec!(&nodes[0])[..], 800_000, payment_hash);
1278 // Provide preimage to node 0 by claiming payment
1279 nodes[0].node.claim_funds(payment_preimage, 800_000);
1280 check_added_monitors!(nodes[0], 1);
1282 // Broadcast node 1 commitment txn
1283 let remote_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
1285 assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1286 let mut has_both_htlcs = 0; // check htlcs match ones committed
1287 for outp in remote_txn[0].output.iter() {
1288 if outp.value == 800_000 / 1000 {
1289 has_both_htlcs += 1;
1290 } else if outp.value == 900_000 / 1000 {
1291 has_both_htlcs += 1;
1294 assert_eq!(has_both_htlcs, 2);
1296 let header = BlockHeader { version: 0x2000_0000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1297 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
1299 // Check we only broadcast 1 timeout tx
1300 let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1301 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()) };
1302 assert_eq!(claim_txn.len(), 7);
1303 check_spends!(claim_txn[2], chan_1.3);
1304 check_spends!(claim_txn[3], claim_txn[2]);
1305 assert_eq!(claim_txn[0], claim_txn[5]);
1306 assert_eq!(claim_txn[1], claim_txn[6]);
1307 assert_eq!(htlc_pair.0.input.len(), 1);
1308 assert_eq!(htlc_pair.0.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1309 check_spends!(htlc_pair.0, remote_txn[0].clone());
1310 assert_eq!(htlc_pair.1.input.len(), 1);
1311 assert_eq!(htlc_pair.1.input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1312 check_spends!(htlc_pair.1, remote_txn[0].clone());
1314 let events = nodes[0].node.get_and_clear_pending_msg_events();
1315 assert_eq!(events.len(), 2);
1318 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1319 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, .. } } => {
1320 assert!(update_add_htlcs.is_empty());
1321 assert!(update_fail_htlcs.is_empty());
1322 assert_eq!(update_fulfill_htlcs.len(), 1);
1323 assert!(update_fail_malformed_htlcs.is_empty());
1324 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1326 _ => panic!("Unexpected event"),
1331 fn do_channel_reserve_test(test_recv: bool) {
1333 let mut nodes = create_network(3, &[None, None, None]);
1334 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1900, 1001, InitFeatures::supported(), InitFeatures::supported());
1335 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1900, 1001, InitFeatures::supported(), InitFeatures::supported());
1337 let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1338 let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1340 let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1341 let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1343 macro_rules! get_route_and_payment_hash {
1344 ($recv_value: expr) => {{
1345 let route = nodes[0].router.get_route(&nodes.last().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV).unwrap();
1346 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1347 (route, payment_hash, payment_preimage)
1351 macro_rules! expect_forward {
1353 let mut events = $node.node.get_and_clear_pending_msg_events();
1354 assert_eq!(events.len(), 1);
1355 check_added_monitors!($node, 1);
1356 let payment_event = SendEvent::from_event(events.remove(0));
1361 let feemsat = 239; // somehow we know?
1362 let total_fee_msat = (nodes.len() - 2) as u64 * 239;
1364 let recv_value_0 = stat01.their_max_htlc_value_in_flight_msat - total_fee_msat;
1366 // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1368 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_0 + 1);
1369 assert!(route.hops.iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1370 let err = nodes[0].node.send_payment(route, our_payment_hash).err().unwrap();
1372 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight our peer will accept"),
1373 _ => panic!("Unknown error variants"),
1375 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1376 nodes[0].logger.assert_log("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);
1379 let mut htlc_id = 0;
1380 // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1381 // nodes[0]'s wealth
1383 let amt_msat = recv_value_0 + total_fee_msat;
1384 if stat01.value_to_self_msat - amt_msat < stat01.channel_reserve_msat {
1387 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0, recv_value_0);
1390 let (stat01_, stat11_, stat12_, stat22_) = (
1391 get_channel_value_stat!(nodes[0], chan_1.2),
1392 get_channel_value_stat!(nodes[1], chan_1.2),
1393 get_channel_value_stat!(nodes[1], chan_2.2),
1394 get_channel_value_stat!(nodes[2], chan_2.2),
1397 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1398 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1399 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1400 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1401 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1405 let recv_value = stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat;
1406 // attempt to get channel_reserve violation
1407 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value + 1);
1408 let err = nodes[0].node.send_payment(route.clone(), our_payment_hash).err().unwrap();
1410 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over their reserve value"),
1411 _ => panic!("Unknown error variants"),
1413 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1414 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over their reserve value".to_string(), 1);
1417 // adding pending output
1418 let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat)/2;
1419 let amt_msat_1 = recv_value_1 + total_fee_msat;
1421 let (route_1, our_payment_hash_1, our_payment_preimage_1) = get_route_and_payment_hash!(recv_value_1);
1422 let payment_event_1 = {
1423 nodes[0].node.send_payment(route_1, our_payment_hash_1).unwrap();
1424 check_added_monitors!(nodes[0], 1);
1426 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1427 assert_eq!(events.len(), 1);
1428 SendEvent::from_event(events.remove(0))
1430 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1432 // channel reserve test with htlc pending output > 0
1433 let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat;
1435 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
1436 match nodes[0].node.send_payment(route, our_payment_hash).err().unwrap() {
1437 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over their reserve value"),
1438 _ => panic!("Unknown error variants"),
1440 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1441 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over their reserve value".to_string(), 2);
1445 // test channel_reserve test on nodes[1] side
1446 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
1448 // Need to manually create update_add_htlc message to go around the channel reserve check in send_htlc()
1449 let secp_ctx = Secp256k1::new();
1450 let session_priv = SecretKey::from_slice(&{
1451 let mut session_key = [0; 32];
1452 let mut rng = thread_rng();
1453 rng.fill_bytes(&mut session_key);
1455 }).expect("RNG is bad!");
1457 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1458 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route, &session_priv).unwrap();
1459 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
1460 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
1461 let msg = msgs::UpdateAddHTLC {
1462 channel_id: chan_1.2,
1464 amount_msat: htlc_msat,
1465 payment_hash: our_payment_hash,
1466 cltv_expiry: htlc_cltv,
1467 onion_routing_packet: onion_packet,
1471 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1472 // If we send a garbage message, the channel should get closed, making the rest of this test case fail.
1473 assert_eq!(nodes[1].node.list_channels().len(), 1);
1474 assert_eq!(nodes[1].node.list_channels().len(), 1);
1475 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1476 assert_eq!(err_msg.data, "Remote HTLC add would put them over their reserve value");
1481 // split the rest to test holding cell
1482 let recv_value_21 = recv_value_2/2;
1483 let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat;
1485 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
1486 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), stat.channel_reserve_msat);
1489 // now see if they go through on both sides
1490 let (route_21, our_payment_hash_21, our_payment_preimage_21) = get_route_and_payment_hash!(recv_value_21);
1491 // but this will stuck in the holding cell
1492 nodes[0].node.send_payment(route_21, our_payment_hash_21).unwrap();
1493 check_added_monitors!(nodes[0], 0);
1494 let events = nodes[0].node.get_and_clear_pending_events();
1495 assert_eq!(events.len(), 0);
1497 // test with outbound holding cell amount > 0
1499 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_22+1);
1500 match nodes[0].node.send_payment(route, our_payment_hash).err().unwrap() {
1501 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over their reserve value"),
1502 _ => panic!("Unknown error variants"),
1504 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1505 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over their reserve value".to_string(), 3);
1508 let (route_22, our_payment_hash_22, our_payment_preimage_22) = get_route_and_payment_hash!(recv_value_22);
1509 // this will also stuck in the holding cell
1510 nodes[0].node.send_payment(route_22, our_payment_hash_22).unwrap();
1511 check_added_monitors!(nodes[0], 0);
1512 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1513 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1515 // flush the pending htlc
1516 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
1517 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1518 check_added_monitors!(nodes[1], 1);
1520 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
1521 check_added_monitors!(nodes[0], 1);
1522 let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1524 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
1525 let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1526 // No commitment_signed so get_event_msg's assert(len == 1) passes
1527 check_added_monitors!(nodes[0], 1);
1529 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
1530 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1531 check_added_monitors!(nodes[1], 1);
1533 expect_pending_htlcs_forwardable!(nodes[1]);
1535 let ref payment_event_11 = expect_forward!(nodes[1]);
1536 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
1537 commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
1539 expect_pending_htlcs_forwardable!(nodes[2]);
1540 expect_payment_received!(nodes[2], our_payment_hash_1, recv_value_1);
1542 // flush the htlcs in the holding cell
1543 assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
1544 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
1545 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
1546 commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
1547 expect_pending_htlcs_forwardable!(nodes[1]);
1549 let ref payment_event_3 = expect_forward!(nodes[1]);
1550 assert_eq!(payment_event_3.msgs.len(), 2);
1551 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
1552 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
1554 commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
1555 expect_pending_htlcs_forwardable!(nodes[2]);
1557 let events = nodes[2].node.get_and_clear_pending_events();
1558 assert_eq!(events.len(), 2);
1560 Event::PaymentReceived { ref payment_hash, amt } => {
1561 assert_eq!(our_payment_hash_21, *payment_hash);
1562 assert_eq!(recv_value_21, amt);
1564 _ => panic!("Unexpected event"),
1567 Event::PaymentReceived { ref payment_hash, amt } => {
1568 assert_eq!(our_payment_hash_22, *payment_hash);
1569 assert_eq!(recv_value_22, amt);
1571 _ => panic!("Unexpected event"),
1574 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1, recv_value_1);
1575 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21, recv_value_21);
1576 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22, recv_value_22);
1578 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);
1579 let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
1580 assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
1581 assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat);
1583 let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
1584 assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22);
1588 fn channel_reserve_test() {
1589 do_channel_reserve_test(false);
1590 do_channel_reserve_test(true);
1594 fn channel_reserve_in_flight_removes() {
1595 // In cases where one side claims an HTLC, it thinks it has additional available funds that it
1596 // can send to its counterparty, but due to update ordering, the other side may not yet have
1597 // considered those HTLCs fully removed.
1598 // This tests that we don't count HTLCs which will not be included in the next remote
1599 // commitment transaction towards the reserve value (as it implies no commitment transaction
1600 // will be generated which violates the remote reserve value).
1601 // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
1603 // * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
1604 // you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
1605 // you only consider the value of the first HTLC, it may not),
1606 // * start routing a third HTLC from A to B,
1607 // * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
1608 // the other claim in its holding cell, as it immediately goes into AwaitingRAA),
1609 // * deliver the first fulfill from B
1610 // * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
1612 // * deliver A's response CS and RAA.
1613 // This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
1614 // removed it fully. B now has the push_msat plus the first two HTLCs in value.
1615 // * Now B happily sends another HTLC, potentially violating its reserve value from A's point
1616 // of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
1617 let mut nodes = create_network(2, &[None, None]);
1618 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1620 let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
1621 // Route the first two HTLCs.
1622 let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
1623 let (payment_preimage_2, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
1625 // Start routing the third HTLC (this is just used to get everyone in the right state).
1626 let (payment_preimage_3, payment_hash_3) = get_payment_preimage_hash!(nodes[0]);
1628 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
1629 nodes[0].node.send_payment(route, payment_hash_3).unwrap();
1630 check_added_monitors!(nodes[0], 1);
1631 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1632 assert_eq!(events.len(), 1);
1633 SendEvent::from_event(events.remove(0))
1636 // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
1637 // initial fulfill/CS.
1638 assert!(nodes[1].node.claim_funds(payment_preimage_1, b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000));
1639 check_added_monitors!(nodes[1], 1);
1640 let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1642 // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
1643 // remove the second HTLC when we send the HTLC back from B to A.
1644 assert!(nodes[1].node.claim_funds(payment_preimage_2, 20000));
1645 check_added_monitors!(nodes[1], 1);
1646 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1648 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
1649 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
1650 check_added_monitors!(nodes[0], 1);
1651 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1652 expect_payment_sent!(nodes[0], payment_preimage_1);
1654 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
1655 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
1656 check_added_monitors!(nodes[1], 1);
1657 // B is already AwaitingRAA, so cant generate a CS here
1658 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1660 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1661 check_added_monitors!(nodes[1], 1);
1662 let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1664 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1665 check_added_monitors!(nodes[0], 1);
1666 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1668 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1669 check_added_monitors!(nodes[1], 1);
1670 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1672 // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
1673 // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
1674 // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
1675 // can no longer broadcast a commitment transaction with it and B has the preimage so can go
1676 // on-chain as necessary).
1677 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
1678 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
1679 check_added_monitors!(nodes[0], 1);
1680 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1681 expect_payment_sent!(nodes[0], payment_preimage_2);
1683 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1684 check_added_monitors!(nodes[1], 1);
1685 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1687 expect_pending_htlcs_forwardable!(nodes[1]);
1688 expect_payment_received!(nodes[1], payment_hash_3, 100000);
1690 // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
1691 // resolve the second HTLC from A's point of view.
1692 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1693 check_added_monitors!(nodes[0], 1);
1694 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1696 // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
1697 // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
1698 let (payment_preimage_4, payment_hash_4) = get_payment_preimage_hash!(nodes[1]);
1700 let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &[], 10000, TEST_FINAL_CLTV).unwrap();
1701 nodes[1].node.send_payment(route, payment_hash_4).unwrap();
1702 check_added_monitors!(nodes[1], 1);
1703 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1704 assert_eq!(events.len(), 1);
1705 SendEvent::from_event(events.remove(0))
1708 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
1709 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
1710 check_added_monitors!(nodes[0], 1);
1711 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1713 // Now just resolve all the outstanding messages/HTLCs for completeness...
1715 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1716 check_added_monitors!(nodes[1], 1);
1717 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1719 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1720 check_added_monitors!(nodes[1], 1);
1722 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1723 check_added_monitors!(nodes[0], 1);
1724 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1726 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1727 check_added_monitors!(nodes[1], 1);
1728 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1730 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1731 check_added_monitors!(nodes[0], 1);
1733 expect_pending_htlcs_forwardable!(nodes[0]);
1734 expect_payment_received!(nodes[0], payment_hash_4, 10000);
1736 claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4, 10_000);
1737 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3, 100_000);
1741 fn channel_monitor_network_test() {
1742 // Simple test which builds a network of ChannelManagers, connects them to each other, and
1743 // tests that ChannelMonitor is able to recover from various states.
1744 let nodes = create_network(5, &[None, None, None, None, None]);
1746 // Create some initial channels
1747 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1748 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
1749 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
1750 let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::supported(), InitFeatures::supported());
1752 // Rebalance the network a bit by relaying one payment through all the channels...
1753 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1754 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1755 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1756 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1758 // Simple case with no pending HTLCs:
1759 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
1761 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
1762 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1763 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
1764 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
1766 get_announce_close_broadcast_events(&nodes, 0, 1);
1767 assert_eq!(nodes[0].node.list_channels().len(), 0);
1768 assert_eq!(nodes[1].node.list_channels().len(), 1);
1770 // One pending HTLC is discarded by the force-close:
1771 let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
1773 // Simple case of one pending HTLC to HTLC-Timeout
1774 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
1776 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
1777 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1778 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
1779 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
1781 get_announce_close_broadcast_events(&nodes, 1, 2);
1782 assert_eq!(nodes[1].node.list_channels().len(), 0);
1783 assert_eq!(nodes[2].node.list_channels().len(), 1);
1785 macro_rules! claim_funds {
1786 ($node: expr, $prev_node: expr, $preimage: expr, $amount: expr) => {
1788 assert!($node.node.claim_funds($preimage, $amount));
1789 check_added_monitors!($node, 1);
1791 let events = $node.node.get_and_clear_pending_msg_events();
1792 assert_eq!(events.len(), 1);
1794 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
1795 assert!(update_add_htlcs.is_empty());
1796 assert!(update_fail_htlcs.is_empty());
1797 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
1799 _ => panic!("Unexpected event"),
1805 // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
1806 // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
1807 nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
1808 let node2_commitment_txid;
1810 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
1811 node2_commitment_txid = node_txn[0].txid();
1813 // Claim the payment on nodes[3], giving it knowledge of the preimage
1814 claim_funds!(nodes[3], nodes[2], payment_preimage_1, 3_000_000);
1816 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1817 nodes[3].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 1);
1819 check_preimage_claim(&nodes[3], &node_txn);
1821 get_announce_close_broadcast_events(&nodes, 2, 3);
1822 assert_eq!(nodes[2].node.list_channels().len(), 0);
1823 assert_eq!(nodes[3].node.list_channels().len(), 1);
1825 { // Cheat and reset nodes[4]'s height to 1
1826 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1827 nodes[4].block_notifier.block_connected(&Block { header, txdata: vec![] }, 1);
1830 assert_eq!(nodes[3].node.latest_block_height.load(Ordering::Acquire), 1);
1831 assert_eq!(nodes[4].node.latest_block_height.load(Ordering::Acquire), 1);
1832 // One pending HTLC to time out:
1833 let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
1834 // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
1838 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1839 nodes[3].block_notifier.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
1840 for i in 3..TEST_FINAL_CLTV + 2 + LATENCY_GRACE_PERIOD_BLOCKS + 1 {
1841 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1842 nodes[3].block_notifier.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
1845 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
1847 let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
1848 node_txn.retain(|tx| {
1849 if tx.input[0].previous_output.txid == node2_commitment_txid {
1855 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
1857 // Claim the payment on nodes[4], giving it knowledge of the preimage
1858 claim_funds!(nodes[4], nodes[3], payment_preimage_2, 3_000_000);
1860 header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1862 nodes[4].block_notifier.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
1863 for i in 3..TEST_FINAL_CLTV + 2 - CLTV_CLAIM_BUFFER + 1 {
1864 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1865 nodes[4].block_notifier.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
1868 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
1870 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1871 nodes[4].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, TEST_FINAL_CLTV - 5);
1873 check_preimage_claim(&nodes[4], &node_txn);
1875 get_announce_close_broadcast_events(&nodes, 3, 4);
1876 assert_eq!(nodes[3].node.list_channels().len(), 0);
1877 assert_eq!(nodes[4].node.list_channels().len(), 0);
1881 fn test_justice_tx() {
1882 // Test justice txn built on revoked HTLC-Success tx, against both sides
1883 let mut alice_config = UserConfig::default();
1884 alice_config.channel_options.announced_channel = true;
1885 alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
1886 alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
1887 let mut bob_config = UserConfig::default();
1888 bob_config.channel_options.announced_channel = true;
1889 bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
1890 bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
1891 let cfgs = [Some(alice_config), Some(bob_config)];
1892 let nodes = create_network(2, &cfgs);
1893 // Create some new channels:
1894 let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1896 // A pending HTLC which will be revoked:
1897 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
1898 // Get the will-be-revoked local txn from nodes[0]
1899 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.iter_mut().next().unwrap().1.channel_monitor().get_latest_local_commitment_txn();
1900 assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
1901 assert_eq!(revoked_local_txn[0].input.len(), 1);
1902 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
1903 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
1904 assert_eq!(revoked_local_txn[1].input.len(), 1);
1905 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
1906 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
1907 // Revoke the old state
1908 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 3_000_000);
1911 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1912 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
1914 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
1915 assert_eq!(node_txn.len(), 3);
1916 assert_eq!(node_txn.pop().unwrap(), node_txn[0]); // An outpoint registration will result in a 2nd block_connected
1917 assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
1919 check_spends!(node_txn[0], revoked_local_txn[0].clone());
1920 node_txn.swap_remove(0);
1921 node_txn.truncate(1);
1923 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
1925 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
1926 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
1927 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1928 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
1929 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
1931 get_announce_close_broadcast_events(&nodes, 0, 1);
1933 assert_eq!(nodes[0].node.list_channels().len(), 0);
1934 assert_eq!(nodes[1].node.list_channels().len(), 0);
1936 // We test justice_tx build by A on B's revoked HTLC-Success tx
1937 // Create some new channels:
1938 let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1940 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
1944 // A pending HTLC which will be revoked:
1945 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
1946 // Get the will-be-revoked local txn from B
1947 let revoked_local_txn = nodes[1].node.channel_state.lock().unwrap().by_id.iter_mut().next().unwrap().1.channel_monitor().get_latest_local_commitment_txn();
1948 assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
1949 assert_eq!(revoked_local_txn[0].input.len(), 1);
1950 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
1951 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
1952 // Revoke the old state
1953 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4, 3_000_000);
1955 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1956 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
1958 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
1959 assert_eq!(node_txn.len(), 3);
1960 assert_eq!(node_txn.pop().unwrap(), node_txn[0]); // An outpoint registration will result in a 2nd block_connected
1961 assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
1963 check_spends!(node_txn[0], revoked_local_txn[0].clone());
1964 node_txn.swap_remove(0);
1966 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
1968 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
1969 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
1970 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1971 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
1972 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
1974 get_announce_close_broadcast_events(&nodes, 0, 1);
1975 assert_eq!(nodes[0].node.list_channels().len(), 0);
1976 assert_eq!(nodes[1].node.list_channels().len(), 0);
1980 fn revoked_output_claim() {
1981 // Simple test to ensure a node will claim a revoked output when a stale remote commitment
1982 // transaction is broadcast by its counterparty
1983 let nodes = create_network(2, &[None, None]);
1984 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1985 // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
1986 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
1987 assert_eq!(revoked_local_txn.len(), 1);
1988 // Only output is the full channel value back to nodes[0]:
1989 assert_eq!(revoked_local_txn[0].output.len(), 1);
1990 // Send a payment through, updating everyone's latest commitment txn
1991 send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000, 5_000_000);
1993 // Inform nodes[1] that nodes[0] broadcast a stale tx
1994 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1995 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
1996 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
1997 assert_eq!(node_txn.len(), 3); // nodes[1] will broadcast justice tx twice, and its own local state once
1999 assert_eq!(node_txn[0], node_txn[2]);
2001 check_spends!(node_txn[0], revoked_local_txn[0].clone());
2002 check_spends!(node_txn[1], chan_1.3.clone());
2004 // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2005 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2006 get_announce_close_broadcast_events(&nodes, 0, 1);
2010 fn claim_htlc_outputs_shared_tx() {
2011 // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2012 let nodes = create_network(2, &[None, None]);
2014 // Create some new channel:
2015 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2017 // Rebalance the network to generate htlc in the two directions
2018 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2019 // 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
2020 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2021 let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2023 // Get the will-be-revoked local txn from node[0]
2024 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
2025 assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2026 assert_eq!(revoked_local_txn[0].input.len(), 1);
2027 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2028 assert_eq!(revoked_local_txn[1].input.len(), 1);
2029 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2030 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2031 check_spends!(revoked_local_txn[1], revoked_local_txn[0].clone());
2033 //Revoke the old state
2034 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2037 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2038 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2039 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2040 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2042 let events = nodes[1].node.get_and_clear_pending_events();
2043 assert_eq!(events.len(), 1);
2045 Event::PaymentFailed { payment_hash, .. } => {
2046 assert_eq!(payment_hash, payment_hash_2);
2048 _ => panic!("Unexpected event"),
2051 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2052 assert_eq!(node_txn.len(), 4);
2054 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2055 check_spends!(node_txn[0], revoked_local_txn[0].clone());
2057 assert_eq!(node_txn[0], node_txn[3]); // justice tx is duplicated due to block re-scanning
2059 let mut witness_lens = BTreeSet::new();
2060 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2061 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2062 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2063 assert_eq!(witness_lens.len(), 3);
2064 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2065 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2066 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2068 // Next nodes[1] broadcasts its current local tx state:
2069 assert_eq!(node_txn[1].input.len(), 1);
2070 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2072 assert_eq!(node_txn[2].input.len(), 1);
2073 let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
2074 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2075 assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
2076 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2077 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
2079 get_announce_close_broadcast_events(&nodes, 0, 1);
2080 assert_eq!(nodes[0].node.list_channels().len(), 0);
2081 assert_eq!(nodes[1].node.list_channels().len(), 0);
2085 fn claim_htlc_outputs_single_tx() {
2086 // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2087 let nodes = create_network(2, &[None, None]);
2089 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2091 // Rebalance the network to generate htlc in the two directions
2092 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2093 // 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
2094 // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2095 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2096 let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2098 // Get the will-be-revoked local txn from node[0]
2099 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
2101 //Revoke the old state
2102 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2105 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2106 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2107 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2108 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
2110 let events = nodes[1].node.get_and_clear_pending_events();
2111 assert_eq!(events.len(), 1);
2113 Event::PaymentFailed { payment_hash, .. } => {
2114 assert_eq!(payment_hash, payment_hash_2);
2116 _ => panic!("Unexpected event"),
2119 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2120 assert_eq!(node_txn.len(), 29); // ChannelManager : 2, ChannelMontitor: 8 (1 standard revoked output, 2 revocation htlc tx, 1 local commitment tx + 1 htlc timeout tx) * 2 (block-rescan) + 5 * (1 local commitment tx + 1 htlc timeout tx)
2122 assert_eq!(node_txn[0], node_txn[7]);
2123 assert_eq!(node_txn[1], node_txn[8]);
2124 assert_eq!(node_txn[2], node_txn[9]);
2125 assert_eq!(node_txn[3], node_txn[10]);
2126 assert_eq!(node_txn[4], node_txn[11]);
2127 assert_eq!(node_txn[3], node_txn[5]); //local commitment tx + htlc timeout tx broadcasted by ChannelManger
2128 assert_eq!(node_txn[4], node_txn[6]);
2130 assert_eq!(node_txn[0].input.len(), 1);
2131 assert_eq!(node_txn[1].input.len(), 1);
2132 assert_eq!(node_txn[2].input.len(), 1);
2134 fn get_txout(out_point: &BitcoinOutPoint, tx: &Transaction) -> Option<TxOut> {
2135 if out_point.txid == tx.txid() {
2136 tx.output.get(out_point.vout as usize).cloned()
2141 node_txn[0].verify(|out|get_txout(out, &revoked_local_txn[0])).unwrap();
2142 node_txn[1].verify(|out|get_txout(out, &revoked_local_txn[0])).unwrap();
2143 node_txn[2].verify(|out|get_txout(out, &revoked_local_txn[0])).unwrap();
2145 let mut witness_lens = BTreeSet::new();
2146 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2147 witness_lens.insert(node_txn[1].input[0].witness.last().unwrap().len());
2148 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2149 assert_eq!(witness_lens.len(), 3);
2150 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2151 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2152 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2154 assert_eq!(node_txn[3].input.len(), 1);
2155 check_spends!(node_txn[3], chan_1.3.clone());
2157 assert_eq!(node_txn[4].input.len(), 1);
2158 let witness_script = node_txn[4].input[0].witness.last().unwrap();
2159 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2160 assert_eq!(node_txn[4].input[0].previous_output.txid, node_txn[3].txid());
2161 assert_ne!(node_txn[4].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2162 assert_ne!(node_txn[4].input[0].previous_output.txid, node_txn[1].input[0].previous_output.txid);
2164 get_announce_close_broadcast_events(&nodes, 0, 1);
2165 assert_eq!(nodes[0].node.list_channels().len(), 0);
2166 assert_eq!(nodes[1].node.list_channels().len(), 0);
2170 fn test_htlc_on_chain_success() {
2171 // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2172 // ChainWatchInterface and pass the preimage backward accordingly. So here we test that ChannelManager is
2173 // broadcasting the right event to other nodes in payment path.
2174 // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2175 // A --------------------> B ----------------------> C (preimage)
2176 // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2177 // commitment transaction was broadcast.
2178 // Then, B should learn the preimage from said transactions, attempting to claim backwards
2180 // B should be able to claim via preimage if A then broadcasts its local tx.
2181 // Finally, when A sees B's latest local commitment transaction it should be able to claim
2182 // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2183 // PaymentSent event).
2185 let nodes = create_network(3, &[None, None, None]);
2187 // Create some initial channels
2188 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2189 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2191 // Rebalance the network a bit by relaying one payment through all the channels...
2192 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2193 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2195 let (our_payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2196 let (our_payment_preimage_2, _payment_hash_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2197 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2199 // Broadcast legit commitment tx from C on B's chain
2200 // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2201 let commitment_tx = nodes[2].node.channel_state.lock().unwrap().by_id.get_mut(&chan_2.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
2202 assert_eq!(commitment_tx.len(), 1);
2203 check_spends!(commitment_tx[0], chan_2.3.clone());
2204 nodes[2].node.claim_funds(our_payment_preimage, 3_000_000);
2205 nodes[2].node.claim_funds(our_payment_preimage_2, 3_000_000);
2206 check_added_monitors!(nodes[2], 2);
2207 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2208 assert!(updates.update_add_htlcs.is_empty());
2209 assert!(updates.update_fail_htlcs.is_empty());
2210 assert!(updates.update_fail_malformed_htlcs.is_empty());
2211 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2213 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2214 check_closed_broadcast!(nodes[2], false);
2215 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx, 2*htlc-success tx), ChannelMonitor : 4 (2*2 * HTLC-Success tx)
2216 assert_eq!(node_txn.len(), 7);
2217 assert_eq!(node_txn[0], node_txn[3]);
2218 assert_eq!(node_txn[1], node_txn[4]);
2219 assert_eq!(node_txn[0], node_txn[5]);
2220 assert_eq!(node_txn[1], node_txn[6]);
2221 assert_eq!(node_txn[2], commitment_tx[0]);
2222 check_spends!(node_txn[0], commitment_tx[0].clone());
2223 check_spends!(node_txn[1], commitment_tx[0].clone());
2224 assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2225 assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2226 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2227 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2228 assert_eq!(node_txn[0].lock_time, 0);
2229 assert_eq!(node_txn[1].lock_time, 0);
2231 // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2232 nodes[1].block_notifier.block_connected(&Block { header, txdata: node_txn}, 1);
2233 let events = nodes[1].node.get_and_clear_pending_msg_events();
2235 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
2236 assert_eq!(added_monitors.len(), 2);
2237 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2238 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2239 added_monitors.clear();
2241 assert_eq!(events.len(), 2);
2243 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2244 _ => panic!("Unexpected event"),
2247 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, .. } } => {
2248 assert!(update_add_htlcs.is_empty());
2249 assert!(update_fail_htlcs.is_empty());
2250 assert_eq!(update_fulfill_htlcs.len(), 1);
2251 assert!(update_fail_malformed_htlcs.is_empty());
2252 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2254 _ => panic!("Unexpected event"),
2256 macro_rules! check_tx_local_broadcast {
2257 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2258 // ChannelManager : 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor : 2 (timeout tx) * 2 (block-rescan)
2259 let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2260 assert_eq!(node_txn.len(), 7);
2261 assert_eq!(node_txn[0], node_txn[5]);
2262 assert_eq!(node_txn[1], node_txn[6]);
2263 check_spends!(node_txn[0], $commitment_tx.clone());
2264 check_spends!(node_txn[1], $commitment_tx.clone());
2265 assert_ne!(node_txn[0].lock_time, 0);
2266 assert_ne!(node_txn[1].lock_time, 0);
2268 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2269 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2270 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2271 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2273 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2274 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2275 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2276 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2278 check_spends!(node_txn[2], $chan_tx.clone());
2279 check_spends!(node_txn[3], node_txn[2].clone());
2280 check_spends!(node_txn[4], node_txn[2].clone());
2281 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), 71);
2282 assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2283 assert_eq!(node_txn[4].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2284 assert!(node_txn[3].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2285 assert!(node_txn[4].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2286 assert_ne!(node_txn[3].lock_time, 0);
2287 assert_ne!(node_txn[4].lock_time, 0);
2291 // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2292 // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2293 // timeout-claim of the output that nodes[2] just claimed via success.
2294 check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2296 // Broadcast legit commitment tx from A on B's chain
2297 // Broadcast preimage tx by B on offered output from A commitment tx on A's chain
2298 let commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
2299 check_spends!(commitment_tx[0], chan_1.3.clone());
2300 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2301 check_closed_broadcast!(nodes[1], false);
2302 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx + 2*HTLC-Success), ChannelMonitor : 1 (HTLC-Success) * 2 (block-rescan)
2303 assert_eq!(node_txn.len(), 5);
2304 assert_eq!(node_txn[0], node_txn[4]);
2305 check_spends!(node_txn[0], commitment_tx[0].clone());
2306 assert_eq!(node_txn[0].input.len(), 2);
2307 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2308 assert_eq!(node_txn[0].input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2309 assert_eq!(node_txn[0].lock_time, 0);
2310 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2311 check_spends!(node_txn[1], chan_1.3.clone());
2312 assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2313 check_spends!(node_txn[2], node_txn[1]);
2314 check_spends!(node_txn[3], node_txn[1]);
2315 // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2316 // we already checked the same situation with A.
2318 // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2319 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone(), node_txn[0].clone()] }, 1);
2320 check_closed_broadcast!(nodes[0], false);
2321 let events = nodes[0].node.get_and_clear_pending_events();
2322 assert_eq!(events.len(), 2);
2323 let mut first_claimed = false;
2324 for event in events {
2326 Event::PaymentSent { payment_preimage } => {
2327 if payment_preimage == our_payment_preimage {
2328 assert!(!first_claimed);
2329 first_claimed = true;
2331 assert_eq!(payment_preimage, our_payment_preimage_2);
2334 _ => panic!("Unexpected event"),
2337 check_tx_local_broadcast!(nodes[0], true, commitment_tx[0], chan_1.3);
2341 fn test_htlc_on_chain_timeout() {
2342 // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2343 // ChainWatchInterface and timeout the HTLC backward accordingly. So here we test that ChannelManager is
2344 // broadcasting the right event to other nodes in payment path.
2345 // A ------------------> B ----------------------> C (timeout)
2346 // B's commitment tx C's commitment tx
2348 // B's HTLC timeout tx B's timeout tx
2350 let nodes = create_network(3, &[None, None, None]);
2352 // Create some intial channels
2353 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2354 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2356 // Rebalance the network a bit by relaying one payment thorugh all the channels...
2357 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2358 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2360 let (_payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2361 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2363 // Broadcast legit commitment tx from C on B's chain
2364 let commitment_tx = nodes[2].node.channel_state.lock().unwrap().by_id.get_mut(&chan_2.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
2365 check_spends!(commitment_tx[0], chan_2.3.clone());
2366 nodes[2].node.fail_htlc_backwards(&payment_hash);
2367 check_added_monitors!(nodes[2], 0);
2368 expect_pending_htlcs_forwardable!(nodes[2]);
2369 check_added_monitors!(nodes[2], 1);
2371 let events = nodes[2].node.get_and_clear_pending_msg_events();
2372 assert_eq!(events.len(), 1);
2374 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, .. } } => {
2375 assert!(update_add_htlcs.is_empty());
2376 assert!(!update_fail_htlcs.is_empty());
2377 assert!(update_fulfill_htlcs.is_empty());
2378 assert!(update_fail_malformed_htlcs.is_empty());
2379 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2381 _ => panic!("Unexpected event"),
2383 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2384 check_closed_broadcast!(nodes[2], false);
2385 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2386 assert_eq!(node_txn.len(), 1);
2387 check_spends!(node_txn[0], chan_2.3.clone());
2388 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2390 // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2391 // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2392 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2395 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2396 assert_eq!(node_txn.len(), 8); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 6 (HTLC-Timeout tx, commitment tx, timeout tx) * 2 (block-rescan)
2397 assert_eq!(node_txn[0], node_txn[5]);
2398 assert_eq!(node_txn[1], node_txn[6]);
2399 assert_eq!(node_txn[2], node_txn[7]);
2400 check_spends!(node_txn[0], commitment_tx[0].clone());
2401 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2402 check_spends!(node_txn[1], chan_2.3.clone());
2403 check_spends!(node_txn[2], node_txn[1].clone());
2404 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2405 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2406 check_spends!(node_txn[3], chan_2.3.clone());
2407 check_spends!(node_txn[4], node_txn[3].clone());
2408 assert_eq!(node_txn[3].input[0].witness.clone().last().unwrap().len(), 71);
2409 assert_eq!(node_txn[4].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2410 timeout_tx = node_txn[0].clone();
2414 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![timeout_tx]}, 1);
2415 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2416 check_added_monitors!(nodes[1], 0);
2417 check_closed_broadcast!(nodes[1], false);
2419 expect_pending_htlcs_forwardable!(nodes[1]);
2420 check_added_monitors!(nodes[1], 1);
2421 let events = nodes[1].node.get_and_clear_pending_msg_events();
2422 assert_eq!(events.len(), 1);
2424 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, .. } } => {
2425 assert!(update_add_htlcs.is_empty());
2426 assert!(!update_fail_htlcs.is_empty());
2427 assert!(update_fulfill_htlcs.is_empty());
2428 assert!(update_fail_malformed_htlcs.is_empty());
2429 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2431 _ => panic!("Unexpected event"),
2433 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
2434 assert_eq!(node_txn.len(), 0);
2436 // Broadcast legit commitment tx from B on A's chain
2437 let commitment_tx = nodes[1].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
2438 check_spends!(commitment_tx[0], chan_1.3.clone());
2440 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2441 check_closed_broadcast!(nodes[0], false);
2442 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (timeout tx) * 2 block-rescan
2443 assert_eq!(node_txn.len(), 4);
2444 assert_eq!(node_txn[0], node_txn[3]);
2445 check_spends!(node_txn[0], commitment_tx[0].clone());
2446 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2447 check_spends!(node_txn[1], chan_1.3.clone());
2448 check_spends!(node_txn[2], node_txn[1].clone());
2449 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2450 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2454 fn test_simple_commitment_revoked_fail_backward() {
2455 // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
2456 // and fail backward accordingly.
2458 let nodes = create_network(3, &[None, None, None]);
2460 // Create some initial channels
2461 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2462 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2464 let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2465 // Get the will-be-revoked local txn from nodes[2]
2466 let revoked_local_txn = nodes[2].node.channel_state.lock().unwrap().by_id.get_mut(&chan_2.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
2467 // Revoke the old state
2468 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, 3_000_000);
2470 route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2472 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2473 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2474 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2475 check_added_monitors!(nodes[1], 0);
2476 check_closed_broadcast!(nodes[1], false);
2478 expect_pending_htlcs_forwardable!(nodes[1]);
2479 check_added_monitors!(nodes[1], 1);
2480 let events = nodes[1].node.get_and_clear_pending_msg_events();
2481 assert_eq!(events.len(), 1);
2483 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, .. } } => {
2484 assert!(update_add_htlcs.is_empty());
2485 assert_eq!(update_fail_htlcs.len(), 1);
2486 assert!(update_fulfill_htlcs.is_empty());
2487 assert!(update_fail_malformed_htlcs.is_empty());
2488 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2490 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
2491 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2493 let events = nodes[0].node.get_and_clear_pending_msg_events();
2494 assert_eq!(events.len(), 1);
2496 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
2497 _ => panic!("Unexpected event"),
2499 let events = nodes[0].node.get_and_clear_pending_events();
2500 assert_eq!(events.len(), 1);
2502 Event::PaymentFailed { .. } => {},
2503 _ => panic!("Unexpected event"),
2506 _ => panic!("Unexpected event"),
2510 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
2511 // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
2512 // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
2513 // commitment transaction anymore.
2514 // To do this, we have the peer which will broadcast a revoked commitment transaction send
2515 // a number of update_fail/commitment_signed updates without ever sending the RAA in
2516 // response to our commitment_signed. This is somewhat misbehavior-y, though not
2517 // technically disallowed and we should probably handle it reasonably.
2518 // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
2519 // failed/fulfilled backwards must be in at least one of the latest two remote commitment
2521 // * Once we move it out of our holding cell/add it, we will immediately include it in a
2522 // commitment_signed (implying it will be in the latest remote commitment transaction).
2523 // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
2524 // and once they revoke the previous commitment transaction (allowing us to send a new
2525 // commitment_signed) we will be free to fail/fulfill the HTLC backwards.
2526 let mut nodes = create_network(3, &[None, None, None]);
2528 // Create some initial channels
2529 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2530 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2532 let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], if no_to_remote { 10_000 } else { 3_000_000 });
2533 // Get the will-be-revoked local txn from nodes[2]
2534 let revoked_local_txn = nodes[2].node.channel_state.lock().unwrap().by_id.get_mut(&chan_2.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
2535 assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
2536 // Revoke the old state
2537 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, if no_to_remote { 10_000 } else { 3_000_000});
2539 let value = if use_dust {
2540 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
2541 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
2542 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().our_dust_limit_satoshis * 1000
2545 let (_, first_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2546 let (_, second_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2547 let (_, third_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2549 assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash));
2550 expect_pending_htlcs_forwardable!(nodes[2]);
2551 check_added_monitors!(nodes[2], 1);
2552 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2553 assert!(updates.update_add_htlcs.is_empty());
2554 assert!(updates.update_fulfill_htlcs.is_empty());
2555 assert!(updates.update_fail_malformed_htlcs.is_empty());
2556 assert_eq!(updates.update_fail_htlcs.len(), 1);
2557 assert!(updates.update_fee.is_none());
2558 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2559 let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
2560 // Drop the last RAA from 3 -> 2
2562 assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash));
2563 expect_pending_htlcs_forwardable!(nodes[2]);
2564 check_added_monitors!(nodes[2], 1);
2565 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2566 assert!(updates.update_add_htlcs.is_empty());
2567 assert!(updates.update_fulfill_htlcs.is_empty());
2568 assert!(updates.update_fail_malformed_htlcs.is_empty());
2569 assert_eq!(updates.update_fail_htlcs.len(), 1);
2570 assert!(updates.update_fee.is_none());
2571 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2572 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2573 check_added_monitors!(nodes[1], 1);
2574 // Note that nodes[1] is in AwaitingRAA, so won't send a CS
2575 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2576 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2577 check_added_monitors!(nodes[2], 1);
2579 assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash));
2580 expect_pending_htlcs_forwardable!(nodes[2]);
2581 check_added_monitors!(nodes[2], 1);
2582 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2583 assert!(updates.update_add_htlcs.is_empty());
2584 assert!(updates.update_fulfill_htlcs.is_empty());
2585 assert!(updates.update_fail_malformed_htlcs.is_empty());
2586 assert_eq!(updates.update_fail_htlcs.len(), 1);
2587 assert!(updates.update_fee.is_none());
2588 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2589 // At this point first_payment_hash has dropped out of the latest two commitment
2590 // transactions that nodes[1] is tracking...
2591 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2592 check_added_monitors!(nodes[1], 1);
2593 // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
2594 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2595 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2596 check_added_monitors!(nodes[2], 1);
2598 // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
2599 // on nodes[2]'s RAA.
2600 let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
2601 let (_, fourth_payment_hash) = get_payment_preimage_hash!(nodes[0]);
2602 nodes[1].node.send_payment(route, fourth_payment_hash).unwrap();
2603 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2604 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2605 check_added_monitors!(nodes[1], 0);
2608 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
2609 // One monitor for the new revocation preimage, no second on as we won't generate a new
2610 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
2611 check_added_monitors!(nodes[1], 1);
2612 let events = nodes[1].node.get_and_clear_pending_events();
2613 assert_eq!(events.len(), 1);
2615 Event::PendingHTLCsForwardable { .. } => { },
2616 _ => panic!("Unexpected event"),
2618 // Deliberately don't process the pending fail-back so they all fail back at once after
2619 // block connection just like the !deliver_bs_raa case
2622 let mut failed_htlcs = HashSet::new();
2623 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2625 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2626 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2627 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2629 let events = nodes[1].node.get_and_clear_pending_events();
2630 assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
2632 Event::PaymentFailed { ref payment_hash, .. } => {
2633 assert_eq!(*payment_hash, fourth_payment_hash);
2635 _ => panic!("Unexpected event"),
2637 if !deliver_bs_raa {
2639 Event::PendingHTLCsForwardable { .. } => { },
2640 _ => panic!("Unexpected event"),
2643 nodes[1].node.process_pending_htlc_forwards();
2644 check_added_monitors!(nodes[1], 1);
2646 let events = nodes[1].node.get_and_clear_pending_msg_events();
2647 assert_eq!(events.len(), if deliver_bs_raa { 3 } else { 2 });
2648 match events[if deliver_bs_raa { 1 } else { 0 }] {
2649 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
2650 _ => panic!("Unexpected event"),
2654 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, .. } } => {
2655 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
2656 assert_eq!(update_add_htlcs.len(), 1);
2657 assert!(update_fulfill_htlcs.is_empty());
2658 assert!(update_fail_htlcs.is_empty());
2659 assert!(update_fail_malformed_htlcs.is_empty());
2661 _ => panic!("Unexpected event"),
2664 match events[if deliver_bs_raa { 2 } else { 1 }] {
2665 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, .. } } => {
2666 assert!(update_add_htlcs.is_empty());
2667 assert_eq!(update_fail_htlcs.len(), 3);
2668 assert!(update_fulfill_htlcs.is_empty());
2669 assert!(update_fail_malformed_htlcs.is_empty());
2670 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2672 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
2673 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
2674 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
2676 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2678 let events = nodes[0].node.get_and_clear_pending_msg_events();
2679 // If we delivered B's RAA we got an unknown preimage error, not something
2680 // that we should update our routing table for.
2681 assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
2682 for event in events {
2684 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
2685 _ => panic!("Unexpected event"),
2688 let events = nodes[0].node.get_and_clear_pending_events();
2689 assert_eq!(events.len(), 3);
2691 Event::PaymentFailed { ref payment_hash, .. } => {
2692 assert!(failed_htlcs.insert(payment_hash.0));
2694 _ => panic!("Unexpected event"),
2697 Event::PaymentFailed { ref payment_hash, .. } => {
2698 assert!(failed_htlcs.insert(payment_hash.0));
2700 _ => panic!("Unexpected event"),
2703 Event::PaymentFailed { ref payment_hash, .. } => {
2704 assert!(failed_htlcs.insert(payment_hash.0));
2706 _ => panic!("Unexpected event"),
2709 _ => panic!("Unexpected event"),
2712 assert!(failed_htlcs.contains(&first_payment_hash.0));
2713 assert!(failed_htlcs.contains(&second_payment_hash.0));
2714 assert!(failed_htlcs.contains(&third_payment_hash.0));
2718 fn test_commitment_revoked_fail_backward_exhaustive_a() {
2719 do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
2720 do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
2721 do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
2722 do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
2726 fn test_commitment_revoked_fail_backward_exhaustive_b() {
2727 do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
2728 do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
2729 do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
2730 do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
2734 fn test_htlc_ignore_latest_remote_commitment() {
2735 // Test that HTLC transactions spending the latest remote commitment transaction are simply
2736 // ignored if we cannot claim them. This originally tickled an invalid unwrap().
2737 let nodes = create_network(2, &[None, None]);
2738 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2740 route_payment(&nodes[0], &[&nodes[1]], 10000000);
2741 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id);
2742 check_closed_broadcast!(nodes[0], false);
2744 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2745 assert_eq!(node_txn.len(), 2);
2747 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2748 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
2749 check_closed_broadcast!(nodes[1], false);
2751 // Duplicate the block_connected call since this may happen due to other listeners
2752 // registering new transactions
2753 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
2757 fn test_force_close_fail_back() {
2758 // Check which HTLCs are failed-backwards on channel force-closure
2759 let mut nodes = create_network(3, &[None, None, None]);
2760 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2761 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2763 let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, 42).unwrap();
2765 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
2767 let mut payment_event = {
2768 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
2769 check_added_monitors!(nodes[0], 1);
2771 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2772 assert_eq!(events.len(), 1);
2773 SendEvent::from_event(events.remove(0))
2776 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
2777 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
2779 expect_pending_htlcs_forwardable!(nodes[1]);
2781 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
2782 assert_eq!(events_2.len(), 1);
2783 payment_event = SendEvent::from_event(events_2.remove(0));
2784 assert_eq!(payment_event.msgs.len(), 1);
2786 check_added_monitors!(nodes[1], 1);
2787 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
2788 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
2789 check_added_monitors!(nodes[2], 1);
2790 let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2792 // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
2793 // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
2794 // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
2796 nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id);
2797 check_closed_broadcast!(nodes[2], false);
2799 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
2800 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
2801 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
2802 // back to nodes[1] upon timeout otherwise.
2803 assert_eq!(node_txn.len(), 1);
2807 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2808 nodes[1].block_notifier.block_connected_checked(&header, 1, &[&tx], &[1]);
2810 // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
2811 check_closed_broadcast!(nodes[1], false);
2813 // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
2815 let mut monitors = nodes[2].chan_monitor.simple_monitor.monitors.lock().unwrap();
2816 monitors.get_mut(&OutPoint::new(Sha256dHash::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), 0)).unwrap()
2817 .provide_payment_preimage(&our_payment_hash, &our_payment_preimage);
2819 nodes[2].block_notifier.block_connected_checked(&header, 1, &[&tx], &[1]);
2820 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
2821 assert_eq!(node_txn.len(), 1);
2822 assert_eq!(node_txn[0].input.len(), 1);
2823 assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
2824 assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
2825 assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
2827 check_spends!(node_txn[0], tx);
2831 fn test_unconf_chan() {
2832 // After creating a chan between nodes, we disconnect all blocks previously seen to force a channel close on nodes[0] side
2833 let nodes = create_network(2, &[None, None]);
2834 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2836 let channel_state = nodes[0].node.channel_state.lock().unwrap();
2837 assert_eq!(channel_state.by_id.len(), 1);
2838 assert_eq!(channel_state.short_to_id.len(), 1);
2839 mem::drop(channel_state);
2841 let mut headers = Vec::new();
2842 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2843 headers.push(header.clone());
2845 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2846 headers.push(header.clone());
2848 let mut height = 99;
2849 while !headers.is_empty() {
2850 nodes[0].node.block_disconnected(&headers.pop().unwrap(), height);
2853 check_closed_broadcast!(nodes[0], false);
2854 let channel_state = nodes[0].node.channel_state.lock().unwrap();
2855 assert_eq!(channel_state.by_id.len(), 0);
2856 assert_eq!(channel_state.short_to_id.len(), 0);
2860 fn test_simple_peer_disconnect() {
2861 // Test that we can reconnect when there are no lost messages
2862 let nodes = create_network(3, &[None, None, None]);
2863 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2864 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2866 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2867 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2868 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
2870 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
2871 let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
2872 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
2873 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1, 1_000_000);
2875 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2876 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2877 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
2879 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
2880 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
2881 let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
2882 let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
2884 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2885 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2887 claim_payment_along_route(&nodes[0], &vec!(&nodes[1], &nodes[2]), true, payment_preimage_3, 1_000_000);
2888 fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
2890 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
2892 let events = nodes[0].node.get_and_clear_pending_events();
2893 assert_eq!(events.len(), 2);
2895 Event::PaymentSent { payment_preimage } => {
2896 assert_eq!(payment_preimage, payment_preimage_3);
2898 _ => panic!("Unexpected event"),
2901 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
2902 assert_eq!(payment_hash, payment_hash_5);
2903 assert!(rejected_by_dest);
2905 _ => panic!("Unexpected event"),
2909 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4, 1_000_000);
2910 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
2913 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
2914 // Test that we can reconnect when in-flight HTLC updates get dropped
2915 let mut nodes = create_network(2, &[None, None]);
2916 if messages_delivered == 0 {
2917 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
2918 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
2920 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2923 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), Some(&nodes[0].node.list_usable_channels()), &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
2924 let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
2926 let payment_event = {
2927 nodes[0].node.send_payment(route.clone(), payment_hash_1).unwrap();
2928 check_added_monitors!(nodes[0], 1);
2930 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2931 assert_eq!(events.len(), 1);
2932 SendEvent::from_event(events.remove(0))
2934 assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
2936 if messages_delivered < 2 {
2937 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
2939 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
2940 if messages_delivered >= 3 {
2941 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
2942 check_added_monitors!(nodes[1], 1);
2943 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2945 if messages_delivered >= 4 {
2946 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
2947 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2948 check_added_monitors!(nodes[0], 1);
2950 if messages_delivered >= 5 {
2951 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
2952 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2953 // No commitment_signed so get_event_msg's assert(len == 1) passes
2954 check_added_monitors!(nodes[0], 1);
2956 if messages_delivered >= 6 {
2957 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
2958 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2959 check_added_monitors!(nodes[1], 1);
2966 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2967 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2968 if messages_delivered < 3 {
2969 // Even if the funding_locked messages get exchanged, as long as nothing further was
2970 // received on either side, both sides will need to resend them.
2971 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
2972 } else if messages_delivered == 3 {
2973 // nodes[0] still wants its RAA + commitment_signed
2974 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
2975 } else if messages_delivered == 4 {
2976 // nodes[0] still wants its commitment_signed
2977 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
2978 } else if messages_delivered == 5 {
2979 // nodes[1] still wants its final RAA
2980 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
2981 } else if messages_delivered == 6 {
2982 // Everything was delivered...
2983 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
2986 let events_1 = nodes[1].node.get_and_clear_pending_events();
2987 assert_eq!(events_1.len(), 1);
2989 Event::PendingHTLCsForwardable { .. } => { },
2990 _ => panic!("Unexpected event"),
2993 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2994 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2995 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
2997 nodes[1].node.process_pending_htlc_forwards();
2999 let events_2 = nodes[1].node.get_and_clear_pending_events();
3000 assert_eq!(events_2.len(), 1);
3002 Event::PaymentReceived { ref payment_hash, amt } => {
3003 assert_eq!(payment_hash_1, *payment_hash);
3004 assert_eq!(amt, 1000000);
3006 _ => panic!("Unexpected event"),
3009 nodes[1].node.claim_funds(payment_preimage_1, 1_000_000);
3010 check_added_monitors!(nodes[1], 1);
3012 let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3013 assert_eq!(events_3.len(), 1);
3014 let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3015 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3016 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3017 assert!(updates.update_add_htlcs.is_empty());
3018 assert!(updates.update_fail_htlcs.is_empty());
3019 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3020 assert!(updates.update_fail_malformed_htlcs.is_empty());
3021 assert!(updates.update_fee.is_none());
3022 (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3024 _ => panic!("Unexpected event"),
3027 if messages_delivered >= 1 {
3028 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3030 let events_4 = nodes[0].node.get_and_clear_pending_events();
3031 assert_eq!(events_4.len(), 1);
3033 Event::PaymentSent { ref payment_preimage } => {
3034 assert_eq!(payment_preimage_1, *payment_preimage);
3036 _ => panic!("Unexpected event"),
3039 if messages_delivered >= 2 {
3040 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3041 check_added_monitors!(nodes[0], 1);
3042 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3044 if messages_delivered >= 3 {
3045 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3046 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3047 check_added_monitors!(nodes[1], 1);
3049 if messages_delivered >= 4 {
3050 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3051 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3052 // No commitment_signed so get_event_msg's assert(len == 1) passes
3053 check_added_monitors!(nodes[1], 1);
3055 if messages_delivered >= 5 {
3056 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3057 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3058 check_added_monitors!(nodes[0], 1);
3065 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3066 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3067 if messages_delivered < 2 {
3068 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3069 //TODO: Deduplicate PaymentSent events, then enable this if:
3070 //if messages_delivered < 1 {
3071 let events_4 = nodes[0].node.get_and_clear_pending_events();
3072 assert_eq!(events_4.len(), 1);
3074 Event::PaymentSent { ref payment_preimage } => {
3075 assert_eq!(payment_preimage_1, *payment_preimage);
3077 _ => panic!("Unexpected event"),
3080 } else if messages_delivered == 2 {
3081 // nodes[0] still wants its RAA + commitment_signed
3082 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3083 } else if messages_delivered == 3 {
3084 // nodes[0] still wants its commitment_signed
3085 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3086 } else if messages_delivered == 4 {
3087 // nodes[1] still wants its final RAA
3088 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3089 } else if messages_delivered == 5 {
3090 // Everything was delivered...
3091 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3094 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3095 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3096 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3098 // Channel should still work fine...
3099 let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3100 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3104 fn test_drop_messages_peer_disconnect_a() {
3105 do_test_drop_messages_peer_disconnect(0);
3106 do_test_drop_messages_peer_disconnect(1);
3107 do_test_drop_messages_peer_disconnect(2);
3108 do_test_drop_messages_peer_disconnect(3);
3112 fn test_drop_messages_peer_disconnect_b() {
3113 do_test_drop_messages_peer_disconnect(4);
3114 do_test_drop_messages_peer_disconnect(5);
3115 do_test_drop_messages_peer_disconnect(6);
3119 fn test_funding_peer_disconnect() {
3120 // Test that we can lock in our funding tx while disconnected
3121 let nodes = create_network(2, &[None, None]);
3122 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
3124 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3125 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3127 confirm_transaction(&nodes[0].block_notifier, &nodes[0].chain_monitor, &tx, tx.version);
3128 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3129 assert_eq!(events_1.len(), 1);
3131 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3132 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3134 _ => panic!("Unexpected event"),
3137 reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3139 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3140 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3142 confirm_transaction(&nodes[1].block_notifier, &nodes[1].chain_monitor, &tx, tx.version);
3143 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3144 assert_eq!(events_2.len(), 2);
3145 let funding_locked = match events_2[0] {
3146 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3147 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3150 _ => panic!("Unexpected event"),
3152 let bs_announcement_sigs = match events_2[1] {
3153 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3154 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3157 _ => panic!("Unexpected event"),
3160 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3162 nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3163 nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3164 let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3165 assert_eq!(events_3.len(), 2);
3166 let as_announcement_sigs = match events_3[0] {
3167 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3168 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3171 _ => panic!("Unexpected event"),
3173 let (as_announcement, as_update) = match events_3[1] {
3174 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3175 (msg.clone(), update_msg.clone())
3177 _ => panic!("Unexpected event"),
3180 nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3181 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3182 assert_eq!(events_4.len(), 1);
3183 let (_, bs_update) = match events_4[0] {
3184 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3185 (msg.clone(), update_msg.clone())
3187 _ => panic!("Unexpected event"),
3190 nodes[0].router.handle_channel_announcement(&as_announcement).unwrap();
3191 nodes[0].router.handle_channel_update(&bs_update).unwrap();
3192 nodes[0].router.handle_channel_update(&as_update).unwrap();
3194 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
3195 let (payment_preimage, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3196 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage, 1_000_000);
3200 fn test_drop_messages_peer_disconnect_dual_htlc() {
3201 // Test that we can handle reconnecting when both sides of a channel have pending
3202 // commitment_updates when we disconnect.
3203 let mut nodes = create_network(2, &[None, None]);
3204 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3206 let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3208 // Now try to send a second payment which will fail to send
3209 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
3210 let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
3212 nodes[0].node.send_payment(route.clone(), payment_hash_2).unwrap();
3213 check_added_monitors!(nodes[0], 1);
3215 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3216 assert_eq!(events_1.len(), 1);
3218 MessageSendEvent::UpdateHTLCs { .. } => {},
3219 _ => panic!("Unexpected event"),
3222 assert!(nodes[1].node.claim_funds(payment_preimage_1, 1_000_000));
3223 check_added_monitors!(nodes[1], 1);
3225 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3226 assert_eq!(events_2.len(), 1);
3228 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 } } => {
3229 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3230 assert!(update_add_htlcs.is_empty());
3231 assert_eq!(update_fulfill_htlcs.len(), 1);
3232 assert!(update_fail_htlcs.is_empty());
3233 assert!(update_fail_malformed_htlcs.is_empty());
3234 assert!(update_fee.is_none());
3236 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3237 let events_3 = nodes[0].node.get_and_clear_pending_events();
3238 assert_eq!(events_3.len(), 1);
3240 Event::PaymentSent { ref payment_preimage } => {
3241 assert_eq!(*payment_preimage, payment_preimage_1);
3243 _ => panic!("Unexpected event"),
3246 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
3247 let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3248 // No commitment_signed so get_event_msg's assert(len == 1) passes
3249 check_added_monitors!(nodes[0], 1);
3251 _ => panic!("Unexpected event"),
3254 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3255 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3257 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
3258 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3259 assert_eq!(reestablish_1.len(), 1);
3260 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
3261 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3262 assert_eq!(reestablish_2.len(), 1);
3264 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3265 let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3266 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3267 let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3269 assert!(as_resp.0.is_none());
3270 assert!(bs_resp.0.is_none());
3272 assert!(bs_resp.1.is_none());
3273 assert!(bs_resp.2.is_none());
3275 assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3277 assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3278 assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3279 assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3280 assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3281 assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3282 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
3283 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
3284 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3285 // No commitment_signed so get_event_msg's assert(len == 1) passes
3286 check_added_monitors!(nodes[1], 1);
3288 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
3289 let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3290 assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
3291 assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
3292 assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
3293 assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
3294 assert!(bs_second_commitment_signed.update_fee.is_none());
3295 check_added_monitors!(nodes[1], 1);
3297 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3298 let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3299 assert!(as_commitment_signed.update_add_htlcs.is_empty());
3300 assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
3301 assert!(as_commitment_signed.update_fail_htlcs.is_empty());
3302 assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
3303 assert!(as_commitment_signed.update_fee.is_none());
3304 check_added_monitors!(nodes[0], 1);
3306 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
3307 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3308 // No commitment_signed so get_event_msg's assert(len == 1) passes
3309 check_added_monitors!(nodes[0], 1);
3311 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
3312 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3313 // No commitment_signed so get_event_msg's assert(len == 1) passes
3314 check_added_monitors!(nodes[1], 1);
3316 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3317 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3318 check_added_monitors!(nodes[1], 1);
3320 expect_pending_htlcs_forwardable!(nodes[1]);
3322 let events_5 = nodes[1].node.get_and_clear_pending_events();
3323 assert_eq!(events_5.len(), 1);
3325 Event::PaymentReceived { ref payment_hash, amt: _ } => {
3326 assert_eq!(payment_hash_2, *payment_hash);
3328 _ => panic!("Unexpected event"),
3331 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
3332 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3333 check_added_monitors!(nodes[0], 1);
3335 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3339 fn test_invalid_channel_announcement() {
3340 //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
3341 let secp_ctx = Secp256k1::new();
3342 let nodes = create_network(2, &[None, None]);
3344 let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::supported(), InitFeatures::supported());
3346 let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
3347 let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
3348 let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
3349 let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
3351 nodes[0].router.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap(), is_permanent: false } );
3353 let as_bitcoin_key = PublicKey::from_secret_key(&secp_ctx, &as_chan.get_local_keys().inner.funding_key);
3354 let bs_bitcoin_key = PublicKey::from_secret_key(&secp_ctx, &bs_chan.get_local_keys().inner.funding_key);
3356 let as_network_key = nodes[0].node.get_our_node_id();
3357 let bs_network_key = nodes[1].node.get_our_node_id();
3359 let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
3361 let mut chan_announcement;
3363 macro_rules! dummy_unsigned_msg {
3365 msgs::UnsignedChannelAnnouncement {
3366 features: ChannelFeatures::supported(),
3367 chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
3368 short_channel_id: as_chan.get_short_channel_id().unwrap(),
3369 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
3370 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
3371 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
3372 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
3373 excess_data: Vec::new(),
3378 macro_rules! sign_msg {
3379 ($unsigned_msg: expr) => {
3380 let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
3381 let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_local_keys().inner.funding_key);
3382 let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_local_keys().inner.funding_key);
3383 let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
3384 let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
3385 chan_announcement = msgs::ChannelAnnouncement {
3386 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
3387 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
3388 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
3389 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
3390 contents: $unsigned_msg
3395 let unsigned_msg = dummy_unsigned_msg!();
3396 sign_msg!(unsigned_msg);
3397 assert_eq!(nodes[0].router.handle_channel_announcement(&chan_announcement).unwrap(), true);
3398 let _ = nodes[0].router.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap(), is_permanent: false } );
3400 // Configured with Network::Testnet
3401 let mut unsigned_msg = dummy_unsigned_msg!();
3402 unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.bitcoin_hash();
3403 sign_msg!(unsigned_msg);
3404 assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
3406 let mut unsigned_msg = dummy_unsigned_msg!();
3407 unsigned_msg.chain_hash = Sha256dHash::hash(&[1,2,3,4,5,6,7,8,9]);
3408 sign_msg!(unsigned_msg);
3409 assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
3413 fn test_no_txn_manager_serialize_deserialize() {
3414 let mut nodes = create_network(2, &[None, None]);
3416 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
3418 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3420 let nodes_0_serialized = nodes[0].node.encode();
3421 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3422 nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
3424 nodes[0].chan_monitor = Arc::new(test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), Arc::new(test_utils::TestLogger::new()), Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 })));
3425 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3426 let (_, mut chan_0_monitor) = <(Sha256dHash, ChannelMonitor)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
3427 assert!(chan_0_monitor_read.is_empty());
3429 let mut nodes_0_read = &nodes_0_serialized[..];
3430 let config = UserConfig::default();
3431 let keys_manager = Arc::new(test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
3432 let (_, nodes_0_deserialized) = {
3433 let mut channel_monitors = HashMap::new();
3434 channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &mut chan_0_monitor);
3435 <(Sha256dHash, ChannelManager<EnforcingChannelKeys>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3436 default_config: config,
3438 fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
3439 monitor: nodes[0].chan_monitor.clone(),
3440 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3441 logger: Arc::new(test_utils::TestLogger::new()),
3442 channel_monitors: &mut channel_monitors,
3445 assert!(nodes_0_read.is_empty());
3447 assert!(nodes[0].chan_monitor.add_update_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
3448 nodes[0].node = Arc::new(nodes_0_deserialized);
3449 let nodes_0_as_listener: Arc<ChainListener> = nodes[0].node.clone();
3450 nodes[0].block_notifier.register_listener(Arc::downgrade(&nodes_0_as_listener));
3451 assert_eq!(nodes[0].node.list_channels().len(), 1);
3452 check_added_monitors!(nodes[0], 1);
3454 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
3455 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3456 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
3457 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3459 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3460 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3461 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3462 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3464 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
3465 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
3466 for node in nodes.iter() {
3467 assert!(node.router.handle_channel_announcement(&announcement).unwrap());
3468 node.router.handle_channel_update(&as_update).unwrap();
3469 node.router.handle_channel_update(&bs_update).unwrap();
3472 send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
3476 fn test_simple_manager_serialize_deserialize() {
3477 let mut nodes = create_network(2, &[None, None]);
3478 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3480 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3481 let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3483 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3485 let nodes_0_serialized = nodes[0].node.encode();
3486 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3487 nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
3489 nodes[0].chan_monitor = Arc::new(test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), Arc::new(test_utils::TestLogger::new()), Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 })));
3490 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3491 let (_, mut chan_0_monitor) = <(Sha256dHash, ChannelMonitor)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
3492 assert!(chan_0_monitor_read.is_empty());
3494 let mut nodes_0_read = &nodes_0_serialized[..];
3495 let keys_manager = Arc::new(test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
3496 let (_, nodes_0_deserialized) = {
3497 let mut channel_monitors = HashMap::new();
3498 channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &mut chan_0_monitor);
3499 <(Sha256dHash, ChannelManager<EnforcingChannelKeys>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3500 default_config: UserConfig::default(),
3502 fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
3503 monitor: nodes[0].chan_monitor.clone(),
3504 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3505 logger: Arc::new(test_utils::TestLogger::new()),
3506 channel_monitors: &mut channel_monitors,
3509 assert!(nodes_0_read.is_empty());
3511 assert!(nodes[0].chan_monitor.add_update_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
3512 nodes[0].node = Arc::new(nodes_0_deserialized);
3513 check_added_monitors!(nodes[0], 1);
3515 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3517 fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
3518 claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage, 1_000_000);
3522 fn test_manager_serialize_deserialize_inconsistent_monitor() {
3523 // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
3524 let mut nodes = create_network(4, &[None, None, None, None]);
3525 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3526 create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::supported(), InitFeatures::supported());
3527 let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::supported(), InitFeatures::supported());
3529 let (our_payment_preimage, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
3531 // Serialize the ChannelManager here, but the monitor we keep up-to-date
3532 let nodes_0_serialized = nodes[0].node.encode();
3534 route_payment(&nodes[0], &[&nodes[3]], 1000000);
3535 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3536 nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3537 nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3539 // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
3541 let mut node_0_monitors_serialized = Vec::new();
3542 for monitor in nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter() {
3543 let mut writer = test_utils::TestVecWriter(Vec::new());
3544 monitor.1.write_for_disk(&mut writer).unwrap();
3545 node_0_monitors_serialized.push(writer.0);
3548 nodes[0].chan_monitor = Arc::new(test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), Arc::new(test_utils::TestLogger::new()), Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 })));
3549 let mut node_0_monitors = Vec::new();
3550 for serialized in node_0_monitors_serialized.iter() {
3551 let mut read = &serialized[..];
3552 let (_, monitor) = <(Sha256dHash, ChannelMonitor)>::read(&mut read, Arc::new(test_utils::TestLogger::new())).unwrap();
3553 assert!(read.is_empty());
3554 node_0_monitors.push(monitor);
3557 let mut nodes_0_read = &nodes_0_serialized[..];
3558 let keys_manager = Arc::new(test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
3559 let (_, nodes_0_deserialized) = <(Sha256dHash, ChannelManager<EnforcingChannelKeys>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3560 default_config: UserConfig::default(),
3562 fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
3563 monitor: nodes[0].chan_monitor.clone(),
3564 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3565 logger: Arc::new(test_utils::TestLogger::new()),
3566 channel_monitors: &mut node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().unwrap(), monitor) }).collect(),
3568 assert!(nodes_0_read.is_empty());
3570 { // Channel close should result in a commitment tx and an HTLC tx
3571 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3572 assert_eq!(txn.len(), 2);
3573 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
3574 assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
3577 for monitor in node_0_monitors.drain(..) {
3578 assert!(nodes[0].chan_monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor).is_ok());
3579 check_added_monitors!(nodes[0], 1);
3581 nodes[0].node = Arc::new(nodes_0_deserialized);
3583 // nodes[1] and nodes[2] have no lost state with nodes[0]...
3584 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3585 reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3586 //... and we can even still claim the payment!
3587 claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage, 1_000_000);
3589 nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id());
3590 let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
3591 nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id());
3592 nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
3593 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
3594 assert_eq!(msg_events.len(), 1);
3595 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
3597 &ErrorAction::SendErrorMessage { ref msg } => {
3598 assert_eq!(msg.channel_id, channel_id);
3600 _ => panic!("Unexpected event!"),
3605 macro_rules! check_spendable_outputs {
3606 ($node: expr, $der_idx: expr) => {
3608 let events = $node.chan_monitor.simple_monitor.get_and_clear_pending_events();
3609 let mut txn = Vec::new();
3610 for event in events {
3612 Event::SpendableOutputs { ref outputs } => {
3613 for outp in outputs {
3615 SpendableOutputDescriptor::DynamicOutputP2WPKH { ref outpoint, ref key, ref output } => {
3617 previous_output: outpoint.clone(),
3618 script_sig: Script::new(),
3620 witness: Vec::new(),
3623 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
3624 value: output.value,
3626 let mut spend_tx = Transaction {
3632 let secp_ctx = Secp256k1::new();
3633 let remotepubkey = PublicKey::from_secret_key(&secp_ctx, &key);
3634 let witness_script = Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: remotepubkey}, Network::Testnet).script_pubkey();
3635 let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
3636 let remotesig = secp_ctx.sign(&sighash, key);
3637 spend_tx.input[0].witness.push(remotesig.serialize_der().to_vec());
3638 spend_tx.input[0].witness[0].push(SigHashType::All as u8);
3639 spend_tx.input[0].witness.push(remotepubkey.serialize().to_vec());
3642 SpendableOutputDescriptor::DynamicOutputP2WSH { ref outpoint, ref key, ref witness_script, ref to_self_delay, ref output } => {
3644 previous_output: outpoint.clone(),
3645 script_sig: Script::new(),
3646 sequence: *to_self_delay as u32,
3647 witness: Vec::new(),
3650 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
3651 value: output.value,
3653 let mut spend_tx = Transaction {
3659 let secp_ctx = Secp256k1::new();
3660 let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], witness_script, output.value)[..]).unwrap();
3661 let local_delaysig = secp_ctx.sign(&sighash, key);
3662 spend_tx.input[0].witness.push(local_delaysig.serialize_der().to_vec());
3663 spend_tx.input[0].witness[0].push(SigHashType::All as u8);
3664 spend_tx.input[0].witness.push(vec!(0));
3665 spend_tx.input[0].witness.push(witness_script.clone().into_bytes());
3668 SpendableOutputDescriptor::StaticOutput { ref outpoint, ref output } => {
3669 let secp_ctx = Secp256k1::new();
3671 previous_output: outpoint.clone(),
3672 script_sig: Script::new(),
3674 witness: Vec::new(),
3677 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
3678 value: output.value,
3680 let mut spend_tx = Transaction {
3684 output: vec![outp.clone()],
3687 match ExtendedPrivKey::new_master(Network::Testnet, &$node.node_seed) {
3689 match master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx($der_idx).expect("key space exhausted")) {
3691 Err(_) => panic!("Your RNG is busted"),
3694 Err(_) => panic!("Your rng is busted"),
3697 let pubkey = ExtendedPubKey::from_private(&secp_ctx, &secret).public_key;
3698 let witness_script = Address::p2pkh(&pubkey, Network::Testnet).script_pubkey();
3699 let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
3700 let sig = secp_ctx.sign(&sighash, &secret.private_key.key);
3701 spend_tx.input[0].witness.push(sig.serialize_der().to_vec());
3702 spend_tx.input[0].witness[0].push(SigHashType::All as u8);
3703 spend_tx.input[0].witness.push(pubkey.key.serialize().to_vec());
3709 _ => panic!("Unexpected event"),
3718 fn test_claim_sizeable_push_msat() {
3719 // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
3720 let nodes = create_network(2, &[None, None]);
3722 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::supported(), InitFeatures::supported());
3723 nodes[1].node.force_close_channel(&chan.2);
3724 check_closed_broadcast!(nodes[1], false);
3725 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3726 assert_eq!(node_txn.len(), 1);
3727 check_spends!(node_txn[0], chan.3.clone());
3728 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
3730 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3731 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
3732 let spend_txn = check_spendable_outputs!(nodes[1], 1);
3733 assert_eq!(spend_txn.len(), 1);
3734 check_spends!(spend_txn[0], node_txn[0].clone());
3738 fn test_claim_on_remote_sizeable_push_msat() {
3739 // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
3740 // to_remote output is encumbered by a P2WPKH
3741 let nodes = create_network(2, &[None, None]);
3743 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::supported(), InitFeatures::supported());
3744 nodes[0].node.force_close_channel(&chan.2);
3745 check_closed_broadcast!(nodes[0], false);
3747 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3748 assert_eq!(node_txn.len(), 1);
3749 check_spends!(node_txn[0], chan.3.clone());
3750 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
3752 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3753 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
3754 check_closed_broadcast!(nodes[1], false);
3755 let spend_txn = check_spendable_outputs!(nodes[1], 1);
3756 assert_eq!(spend_txn.len(), 2);
3757 assert_eq!(spend_txn[0], spend_txn[1]);
3758 check_spends!(spend_txn[0], node_txn[0].clone());
3762 fn test_claim_on_remote_revoked_sizeable_push_msat() {
3763 // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
3764 // to_remote output is encumbered by a P2WPKH
3766 let nodes = create_network(2, &[None, None]);
3768 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::supported(), InitFeatures::supported());
3769 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
3770 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
3771 assert_eq!(revoked_local_txn[0].input.len(), 1);
3772 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
3774 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
3775 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3776 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3777 check_closed_broadcast!(nodes[1], false);
3779 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3780 let spend_txn = check_spendable_outputs!(nodes[1], 1);
3781 assert_eq!(spend_txn.len(), 4);
3782 assert_eq!(spend_txn[0], spend_txn[2]); // to_remote output on revoked remote commitment_tx
3783 check_spends!(spend_txn[0], revoked_local_txn[0].clone());
3784 assert_eq!(spend_txn[1], spend_txn[3]); // to_local output on local commitment tx
3785 check_spends!(spend_txn[1], node_txn[0].clone());
3789 fn test_static_spendable_outputs_preimage_tx() {
3790 let nodes = create_network(2, &[None, None]);
3792 // Create some initial channels
3793 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3795 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
3797 let commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
3798 assert_eq!(commitment_tx[0].input.len(), 1);
3799 assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
3801 // Settle A's commitment tx on B's chain
3802 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3803 assert!(nodes[1].node.claim_funds(payment_preimage, 3_000_000));
3804 check_added_monitors!(nodes[1], 1);
3805 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()] }, 1);
3806 let events = nodes[1].node.get_and_clear_pending_msg_events();
3808 MessageSendEvent::UpdateHTLCs { .. } => {},
3809 _ => panic!("Unexpected event"),
3812 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
3813 _ => panic!("Unexepected event"),
3816 // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
3817 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: 2 (1 preimage tx)
3818 assert_eq!(node_txn.len(), 4);
3819 check_spends!(node_txn[0], commitment_tx[0].clone());
3820 assert_eq!(node_txn[0], node_txn[3]);
3821 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3822 eprintln!("{:?}", node_txn[1]);
3823 check_spends!(node_txn[1], chan_1.3.clone());
3824 check_spends!(node_txn[2], node_txn[1]);
3826 let spend_txn = check_spendable_outputs!(nodes[1], 1); // , 0, 0, 1, 1);
3827 assert_eq!(spend_txn.len(), 2);
3828 assert_eq!(spend_txn[0], spend_txn[1]);
3829 check_spends!(spend_txn[0], node_txn[0].clone());
3833 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
3834 let nodes = create_network(2, &[None, None]);
3836 // Create some initial channels
3837 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3839 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
3840 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.iter_mut().next().unwrap().1.channel_monitor().get_latest_local_commitment_txn();
3841 assert_eq!(revoked_local_txn[0].input.len(), 1);
3842 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
3844 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
3846 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3847 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3848 check_closed_broadcast!(nodes[1], false);
3850 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3851 assert_eq!(node_txn.len(), 3);
3852 assert_eq!(node_txn.pop().unwrap(), node_txn[0]);
3853 assert_eq!(node_txn[0].input.len(), 2);
3854 check_spends!(node_txn[0], revoked_local_txn[0].clone());
3856 let spend_txn = check_spendable_outputs!(nodes[1], 1);
3857 assert_eq!(spend_txn.len(), 2);
3858 assert_eq!(spend_txn[0], spend_txn[1]);
3859 check_spends!(spend_txn[0], node_txn[0].clone());
3863 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
3864 let nodes = create_network(2, &[None, None]);
3866 // Create some initial channels
3867 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3869 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
3870 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
3871 assert_eq!(revoked_local_txn[0].input.len(), 1);
3872 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
3874 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
3876 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3877 // A will generate HTLC-Timeout from revoked commitment tx
3878 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3879 check_closed_broadcast!(nodes[0], false);
3881 let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3882 assert_eq!(revoked_htlc_txn.len(), 3);
3883 assert_eq!(revoked_htlc_txn[0], revoked_htlc_txn[2]);
3884 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
3885 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3886 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
3887 check_spends!(revoked_htlc_txn[1], chan_1.3.clone());
3889 // B will generate justice tx from A's revoked commitment/HTLC tx
3890 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
3891 check_closed_broadcast!(nodes[1], false);
3893 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3894 assert_eq!(node_txn.len(), 5);
3895 assert_eq!(node_txn[3].input.len(), 1);
3896 check_spends!(node_txn[3], revoked_htlc_txn[0].clone());
3898 // Check B's ChannelMonitor was able to generate the right spendable output descriptor
3899 let spend_txn = check_spendable_outputs!(nodes[1], 1);
3900 assert_eq!(spend_txn.len(), 3);
3901 assert_eq!(spend_txn[0], spend_txn[1]);
3902 check_spends!(spend_txn[0], node_txn[0].clone());
3903 check_spends!(spend_txn[2], node_txn[3].clone());
3907 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
3908 let nodes = create_network(2, &[None, None]);
3910 // Create some initial channels
3911 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3913 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
3914 let revoked_local_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
3915 assert_eq!(revoked_local_txn[0].input.len(), 1);
3916 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
3918 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
3920 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3921 // B will generate HTLC-Success from revoked commitment tx
3922 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3923 check_closed_broadcast!(nodes[1], false);
3924 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3926 assert_eq!(revoked_htlc_txn.len(), 3);
3927 assert_eq!(revoked_htlc_txn[0], revoked_htlc_txn[2]);
3928 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
3929 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3930 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
3932 // A will generate justice tx from B's revoked commitment/HTLC tx
3933 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
3934 check_closed_broadcast!(nodes[0], false);
3936 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3937 assert_eq!(node_txn.len(), 4);
3938 assert_eq!(node_txn[3].input.len(), 1);
3939 check_spends!(node_txn[3], revoked_htlc_txn[0].clone());
3941 // Check A's ChannelMonitor was able to generate the right spendable output descriptor
3942 let spend_txn = check_spendable_outputs!(nodes[0], 1);
3943 assert_eq!(spend_txn.len(), 5);
3944 assert_eq!(spend_txn[0], spend_txn[2]);
3945 assert_eq!(spend_txn[1], spend_txn[3]);
3946 check_spends!(spend_txn[0], revoked_local_txn[0].clone()); // spending to_remote output from revoked local tx
3947 check_spends!(spend_txn[1], node_txn[2].clone()); // spending justice tx output from revoked local tx htlc received output
3948 check_spends!(spend_txn[4], node_txn[3].clone()); // spending justice tx output on htlc success tx
3952 fn test_onchain_to_onchain_claim() {
3953 // Test that in case of channel closure, we detect the state of output thanks to
3954 // ChainWatchInterface and claim HTLC on downstream peer's remote commitment tx.
3955 // First, have C claim an HTLC against its own latest commitment transaction.
3956 // Then, broadcast these to B, which should update the monitor downstream on the A<->B
3958 // Finally, check that B will claim the HTLC output if A's latest commitment transaction
3961 let nodes = create_network(3, &[None, None, None]);
3963 // Create some initial channels
3964 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3965 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
3967 // Rebalance the network a bit by relaying one payment through all the channels ...
3968 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
3969 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
3971 let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
3972 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
3973 let commitment_tx = nodes[2].node.channel_state.lock().unwrap().by_id.get_mut(&chan_2.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
3974 check_spends!(commitment_tx[0], chan_2.3.clone());
3975 nodes[2].node.claim_funds(payment_preimage, 3_000_000);
3976 check_added_monitors!(nodes[2], 1);
3977 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3978 assert!(updates.update_add_htlcs.is_empty());
3979 assert!(updates.update_fail_htlcs.is_empty());
3980 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3981 assert!(updates.update_fail_malformed_htlcs.is_empty());
3983 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
3984 check_closed_broadcast!(nodes[2], false);
3986 let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
3987 assert_eq!(c_txn.len(), 4);
3988 assert_eq!(c_txn[0], c_txn[2]);
3989 assert_eq!(c_txn[0], c_txn[3]);
3990 assert_eq!(commitment_tx[0], c_txn[1]);
3991 check_spends!(c_txn[1], chan_2.3.clone());
3992 check_spends!(c_txn[2], c_txn[1].clone());
3993 assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
3994 assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3995 assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
3996 assert_eq!(c_txn[0].lock_time, 0); // Success tx
3998 // 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
3999 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]}, 1);
4001 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4002 assert_eq!(b_txn.len(), 4);
4003 assert_eq!(b_txn[0], b_txn[3]);
4004 check_spends!(b_txn[1], chan_2.3); // B local commitment tx, issued by ChannelManager
4005 check_spends!(b_txn[2], b_txn[1].clone()); // HTLC-Timeout on B local commitment tx, issued by ChannelManager
4006 assert_eq!(b_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4007 assert!(b_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
4008 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
4009 check_spends!(b_txn[0], c_txn[1].clone()); // timeout tx on C remote commitment tx, issued by ChannelMonitor, * 2 due to block rescan
4010 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4011 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
4012 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
4015 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
4016 check_added_monitors!(nodes[1], 1);
4017 match msg_events[0] {
4018 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4019 _ => panic!("Unexpected event"),
4021 match msg_events[1] {
4022 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, .. } } => {
4023 assert!(update_add_htlcs.is_empty());
4024 assert!(update_fail_htlcs.is_empty());
4025 assert_eq!(update_fulfill_htlcs.len(), 1);
4026 assert!(update_fail_malformed_htlcs.is_empty());
4027 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
4029 _ => panic!("Unexpected event"),
4031 // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
4032 let commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
4033 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
4034 let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4035 assert_eq!(b_txn.len(), 4);
4036 check_spends!(b_txn[1], chan_1.3); // Local commitment tx, issued by ChannelManager
4037 check_spends!(b_txn[2], b_txn[1]); // HTLC-Success tx, as a part of the local txn rebroadcast by ChannelManager in the force close
4038 assert_eq!(b_txn[0], b_txn[3]); // HTLC-Success tx, issued by ChannelMonitor, * 2 due to block rescan
4039 check_spends!(b_txn[0], commitment_tx[0].clone());
4040 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4041 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
4042 assert_eq!(b_txn[2].lock_time, 0); // Success tx
4044 check_closed_broadcast!(nodes[1], false);
4048 fn test_duplicate_payment_hash_one_failure_one_success() {
4049 // Topology : A --> B --> C
4050 // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
4051 let mut nodes = create_network(3, &[None, None, None]);
4053 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4054 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
4056 let (our_payment_preimage, duplicate_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
4057 *nodes[0].network_payment_count.borrow_mut() -= 1;
4058 assert_eq!(route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000).1, duplicate_payment_hash);
4060 let commitment_txn = nodes[2].node.channel_state.lock().unwrap().by_id.get_mut(&chan_2.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
4061 assert_eq!(commitment_txn[0].input.len(), 1);
4062 check_spends!(commitment_txn[0], chan_2.3.clone());
4064 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4065 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
4066 check_closed_broadcast!(nodes[1], false);
4068 let htlc_timeout_tx;
4069 { // Extract one of the two HTLC-Timeout transaction
4070 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4071 assert_eq!(node_txn.len(), 7);
4072 assert_eq!(node_txn[0], node_txn[5]);
4073 assert_eq!(node_txn[1], node_txn[6]);
4074 check_spends!(node_txn[0], commitment_txn[0].clone());
4075 assert_eq!(node_txn[0].input.len(), 1);
4076 check_spends!(node_txn[1], commitment_txn[0].clone());
4077 assert_eq!(node_txn[1].input.len(), 1);
4078 assert_ne!(node_txn[0].input[0], node_txn[1].input[0]);
4079 check_spends!(node_txn[2], chan_2.3.clone());
4080 check_spends!(node_txn[3], node_txn[2].clone());
4081 check_spends!(node_txn[4], node_txn[2].clone());
4082 htlc_timeout_tx = node_txn[1].clone();
4085 nodes[2].node.claim_funds(our_payment_preimage, 900_000);
4086 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
4087 check_added_monitors!(nodes[2], 2);
4088 let events = nodes[2].node.get_and_clear_pending_msg_events();
4090 MessageSendEvent::UpdateHTLCs { .. } => {},
4091 _ => panic!("Unexpected event"),
4094 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4095 _ => panic!("Unexepected event"),
4097 let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
4098 assert_eq!(htlc_success_txn.len(), 7);
4099 check_spends!(htlc_success_txn[2], chan_2.3.clone());
4100 check_spends!(htlc_success_txn[3], htlc_success_txn[2]);
4101 check_spends!(htlc_success_txn[4], htlc_success_txn[2]);
4102 assert_eq!(htlc_success_txn[0], htlc_success_txn[5]);
4103 assert_eq!(htlc_success_txn[0].input.len(), 1);
4104 assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4105 assert_eq!(htlc_success_txn[1], htlc_success_txn[4]);
4106 assert_eq!(htlc_success_txn[1].input.len(), 1);
4107 assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4108 assert_ne!(htlc_success_txn[0].input[0], htlc_success_txn[1].input[0]);
4109 check_spends!(htlc_success_txn[0], commitment_txn[0].clone());
4110 check_spends!(htlc_success_txn[1], commitment_txn[0].clone());
4112 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![htlc_timeout_tx] }, 200);
4113 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
4114 expect_pending_htlcs_forwardable!(nodes[1]);
4115 let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4116 assert!(htlc_updates.update_add_htlcs.is_empty());
4117 assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
4118 assert_eq!(htlc_updates.update_fail_htlcs[0].htlc_id, 1);
4119 assert!(htlc_updates.update_fulfill_htlcs.is_empty());
4120 assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
4121 check_added_monitors!(nodes[1], 1);
4123 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
4124 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4126 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
4127 let events = nodes[0].node.get_and_clear_pending_msg_events();
4128 assert_eq!(events.len(), 1);
4130 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. } } => {
4132 _ => { panic!("Unexpected event"); }
4135 let events = nodes[0].node.get_and_clear_pending_events();
4137 Event::PaymentFailed { ref payment_hash, .. } => {
4138 assert_eq!(*payment_hash, duplicate_payment_hash);
4140 _ => panic!("Unexpected event"),
4143 // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
4144 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![htlc_success_txn[0].clone()] }, 200);
4145 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4146 assert!(updates.update_add_htlcs.is_empty());
4147 assert!(updates.update_fail_htlcs.is_empty());
4148 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4149 assert_eq!(updates.update_fulfill_htlcs[0].htlc_id, 0);
4150 assert!(updates.update_fail_malformed_htlcs.is_empty());
4151 check_added_monitors!(nodes[1], 1);
4153 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
4154 commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
4156 let events = nodes[0].node.get_and_clear_pending_events();
4158 Event::PaymentSent { ref payment_preimage } => {
4159 assert_eq!(*payment_preimage, our_payment_preimage);
4161 _ => panic!("Unexpected event"),
4166 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
4167 let nodes = create_network(2, &[None, None]);
4169 // Create some initial channels
4170 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4172 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
4173 let local_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
4174 assert_eq!(local_txn[0].input.len(), 1);
4175 check_spends!(local_txn[0], chan_1.3.clone());
4177 // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
4178 nodes[1].node.claim_funds(payment_preimage, 9_000_000);
4179 check_added_monitors!(nodes[1], 1);
4180 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4181 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![local_txn[0].clone()] }, 1);
4182 let events = nodes[1].node.get_and_clear_pending_msg_events();
4184 MessageSendEvent::UpdateHTLCs { .. } => {},
4185 _ => panic!("Unexpected event"),
4188 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4189 _ => panic!("Unexepected event"),
4191 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4192 assert_eq!(node_txn[0].input.len(), 1);
4193 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4194 check_spends!(node_txn[0], local_txn[0].clone());
4196 // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
4197 let spend_txn = check_spendable_outputs!(nodes[1], 1);
4198 assert_eq!(spend_txn.len(), 2);
4199 check_spends!(spend_txn[0], node_txn[0].clone());
4200 check_spends!(spend_txn[1], node_txn[2].clone());
4203 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
4204 // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
4205 // unrevoked commitment transaction.
4206 // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
4207 // a remote RAA before they could be failed backwards (and combinations thereof).
4208 // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
4209 // use the same payment hashes.
4210 // Thus, we use a six-node network:
4215 // And test where C fails back to A/B when D announces its latest commitment transaction
4216 let nodes = create_network(6, &[None, None, None, None, None, None]);
4218 create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::supported(), InitFeatures::supported());
4219 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
4220 let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
4221 create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::supported(), InitFeatures::supported());
4222 create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::supported(), InitFeatures::supported());
4224 // Rebalance and check output sanity...
4225 send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000, 500_000);
4226 send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000, 500_000);
4227 assert_eq!(nodes[3].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn()[0].output.len(), 2);
4229 let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
4231 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
4233 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
4234 let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), ds_dust_limit*1000, TEST_FINAL_CLTV).unwrap();
4236 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
4238 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
4240 let (_, payment_hash_3) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4242 let (_, payment_hash_4) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4243 let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4245 send_along_route_with_hash(&nodes[1], route.clone(), &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_3);
4247 send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_4);
4250 let (_, payment_hash_5) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4252 let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), ds_dust_limit*1000, TEST_FINAL_CLTV).unwrap();
4253 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
4256 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
4258 let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4259 send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_6);
4261 // Double-check that six of the new HTLC were added
4262 // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
4263 // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
4264 assert_eq!(nodes[3].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn().len(), 1);
4265 assert_eq!(nodes[3].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn()[0].output.len(), 8);
4267 // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
4268 // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
4269 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1));
4270 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3));
4271 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5));
4272 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6));
4273 check_added_monitors!(nodes[4], 0);
4274 expect_pending_htlcs_forwardable!(nodes[4]);
4275 check_added_monitors!(nodes[4], 1);
4277 let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
4278 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
4279 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
4280 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
4281 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
4282 commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
4284 // Fail 3rd below-dust and 7th above-dust HTLCs
4285 assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2));
4286 assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4));
4287 check_added_monitors!(nodes[5], 0);
4288 expect_pending_htlcs_forwardable!(nodes[5]);
4289 check_added_monitors!(nodes[5], 1);
4291 let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
4292 nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
4293 nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
4294 commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
4296 let ds_prev_commitment_tx = nodes[3].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
4298 expect_pending_htlcs_forwardable!(nodes[3]);
4299 check_added_monitors!(nodes[3], 1);
4300 let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
4301 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
4302 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
4303 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
4304 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
4305 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
4306 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
4307 if deliver_last_raa {
4308 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
4310 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
4313 // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
4314 // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
4315 // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
4316 // propagated back to A/B yet (and D has two unrevoked commitment transactions).
4318 // We now broadcast the latest commitment transaction, which *should* result in failures for
4319 // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
4320 // the non-broadcast above-dust HTLCs.
4322 // Alternatively, we may broadcast the previous commitment transaction, which should only
4323 // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
4324 let ds_last_commitment_tx = nodes[3].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
4326 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4327 if announce_latest {
4328 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![ds_last_commitment_tx[0].clone()]}, 1);
4330 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![ds_prev_commitment_tx[0].clone()]}, 1);
4332 connect_blocks(&nodes[2].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4333 check_closed_broadcast!(nodes[2], false);
4334 expect_pending_htlcs_forwardable!(nodes[2]);
4335 check_added_monitors!(nodes[2], 2);
4337 let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
4338 assert_eq!(cs_msgs.len(), 2);
4339 let mut a_done = false;
4340 for msg in cs_msgs {
4342 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
4343 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
4344 // should be failed-backwards here.
4345 let target = if *node_id == nodes[0].node.get_our_node_id() {
4346 // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
4347 for htlc in &updates.update_fail_htlcs {
4348 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 });
4350 assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
4355 // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
4356 for htlc in &updates.update_fail_htlcs {
4357 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
4359 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
4360 assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
4363 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
4364 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
4365 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
4366 if announce_latest {
4367 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
4368 if *node_id == nodes[0].node.get_our_node_id() {
4369 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
4372 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
4374 _ => panic!("Unexpected event"),
4378 let as_events = nodes[0].node.get_and_clear_pending_events();
4379 assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
4380 let mut as_failds = HashSet::new();
4381 for event in as_events.iter() {
4382 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
4383 assert!(as_failds.insert(*payment_hash));
4384 if *payment_hash != payment_hash_2 {
4385 assert_eq!(*rejected_by_dest, deliver_last_raa);
4387 assert!(!rejected_by_dest);
4389 } else { panic!("Unexpected event"); }
4391 assert!(as_failds.contains(&payment_hash_1));
4392 assert!(as_failds.contains(&payment_hash_2));
4393 if announce_latest {
4394 assert!(as_failds.contains(&payment_hash_3));
4395 assert!(as_failds.contains(&payment_hash_5));
4397 assert!(as_failds.contains(&payment_hash_6));
4399 let bs_events = nodes[1].node.get_and_clear_pending_events();
4400 assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
4401 let mut bs_failds = HashSet::new();
4402 for event in bs_events.iter() {
4403 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
4404 assert!(bs_failds.insert(*payment_hash));
4405 if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
4406 assert_eq!(*rejected_by_dest, deliver_last_raa);
4408 assert!(!rejected_by_dest);
4410 } else { panic!("Unexpected event"); }
4412 assert!(bs_failds.contains(&payment_hash_1));
4413 assert!(bs_failds.contains(&payment_hash_2));
4414 if announce_latest {
4415 assert!(bs_failds.contains(&payment_hash_4));
4417 assert!(bs_failds.contains(&payment_hash_5));
4419 // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
4420 // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
4421 // to unknown-preimage-etc, B should have gotten 2. Thus, in the
4422 // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
4423 // PaymentFailureNetworkUpdates.
4424 let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4425 assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
4426 let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
4427 assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
4428 for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
4430 &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
4431 _ => panic!("Unexpected event"),
4437 fn test_fail_backwards_latest_remote_announce_a() {
4438 do_test_fail_backwards_unrevoked_remote_announce(false, true);
4442 fn test_fail_backwards_latest_remote_announce_b() {
4443 do_test_fail_backwards_unrevoked_remote_announce(true, true);
4447 fn test_fail_backwards_previous_remote_announce() {
4448 do_test_fail_backwards_unrevoked_remote_announce(false, false);
4449 // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
4450 // tested for in test_commitment_revoked_fail_backward_exhaustive()
4454 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
4455 let nodes = create_network(2, &[None, None]);
4457 // Create some initial channels
4458 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4460 route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
4461 let local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
4462 assert_eq!(local_txn[0].input.len(), 1);
4463 check_spends!(local_txn[0], chan_1.3.clone());
4465 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
4466 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4467 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![local_txn[0].clone()] }, 200);
4468 check_closed_broadcast!(nodes[0], false);
4470 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4471 assert_eq!(node_txn[0].input.len(), 1);
4472 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4473 check_spends!(node_txn[0], local_txn[0].clone());
4475 // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
4476 let spend_txn = check_spendable_outputs!(nodes[0], 1);
4477 assert_eq!(spend_txn.len(), 8);
4478 assert_eq!(spend_txn[0], spend_txn[2]);
4479 assert_eq!(spend_txn[0], spend_txn[4]);
4480 assert_eq!(spend_txn[0], spend_txn[6]);
4481 assert_eq!(spend_txn[1], spend_txn[3]);
4482 assert_eq!(spend_txn[1], spend_txn[5]);
4483 assert_eq!(spend_txn[1], spend_txn[7]);
4484 check_spends!(spend_txn[0], local_txn[0].clone());
4485 check_spends!(spend_txn[1], node_txn[0].clone());
4489 fn test_static_output_closing_tx() {
4490 let nodes = create_network(2, &[None, None]);
4492 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4494 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
4495 let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
4497 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4498 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![closing_tx.clone()] }, 1);
4499 let spend_txn = check_spendable_outputs!(nodes[0], 2);
4500 assert_eq!(spend_txn.len(), 1);
4501 check_spends!(spend_txn[0], closing_tx.clone());
4503 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![closing_tx.clone()] }, 1);
4504 let spend_txn = check_spendable_outputs!(nodes[1], 2);
4505 assert_eq!(spend_txn.len(), 1);
4506 check_spends!(spend_txn[0], closing_tx);
4509 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
4510 let nodes = create_network(2, &[None, None]);
4511 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4513 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
4515 // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
4516 // present in B's local commitment transaction, but none of A's commitment transactions.
4517 assert!(nodes[1].node.claim_funds(our_payment_preimage, if use_dust { 50_000 } else { 3_000_000 }));
4518 check_added_monitors!(nodes[1], 1);
4520 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4521 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
4522 let events = nodes[0].node.get_and_clear_pending_events();
4523 assert_eq!(events.len(), 1);
4525 Event::PaymentSent { payment_preimage } => {
4526 assert_eq!(payment_preimage, our_payment_preimage);
4528 _ => panic!("Unexpected event"),
4531 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
4532 check_added_monitors!(nodes[0], 1);
4533 let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4534 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
4535 check_added_monitors!(nodes[1], 1);
4537 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4538 for i in 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + CHAN_CONFIRM_DEPTH + 1 {
4539 nodes[1].block_notifier.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
4540 header.prev_blockhash = header.bitcoin_hash();
4542 test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
4543 check_closed_broadcast!(nodes[1], false);
4546 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
4547 let mut nodes = create_network(2, &[None, None]);
4548 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4550 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), if use_dust { 50000 } else { 3000000 }, TEST_FINAL_CLTV).unwrap();
4551 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
4552 nodes[0].node.send_payment(route, payment_hash).unwrap();
4553 check_added_monitors!(nodes[0], 1);
4555 let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4557 // As far as A is concerned, the HTLC is now present only in the latest remote commitment
4558 // transaction, however it is not in A's latest local commitment, so we can just broadcast that
4559 // to "time out" the HTLC.
4561 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4563 for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
4564 nodes[0].block_notifier.block_connected(&Block { header, txdata: Vec::new()}, i);
4565 header.prev_blockhash = header.bitcoin_hash();
4567 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
4568 check_closed_broadcast!(nodes[0], false);
4571 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
4572 let nodes = create_network(3, &[None, None, None]);
4573 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4575 // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
4576 // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
4577 // Also optionally test that we *don't* fail the channel in case the commitment transaction was
4578 // actually revoked.
4579 let htlc_value = if use_dust { 50000 } else { 3000000 };
4580 let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
4581 assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash));
4582 expect_pending_htlcs_forwardable!(nodes[1]);
4583 check_added_monitors!(nodes[1], 1);
4585 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4586 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
4587 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
4588 check_added_monitors!(nodes[0], 1);
4589 let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4590 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
4591 check_added_monitors!(nodes[1], 1);
4592 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
4593 check_added_monitors!(nodes[1], 1);
4594 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4596 if check_revoke_no_close {
4597 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
4598 check_added_monitors!(nodes[0], 1);
4601 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4602 for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
4603 nodes[0].block_notifier.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
4604 header.prev_blockhash = header.bitcoin_hash();
4606 if !check_revoke_no_close {
4607 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
4608 check_closed_broadcast!(nodes[0], false);
4610 let events = nodes[0].node.get_and_clear_pending_events();
4611 assert_eq!(events.len(), 1);
4613 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
4614 assert_eq!(payment_hash, our_payment_hash);
4615 assert!(rejected_by_dest);
4617 _ => panic!("Unexpected event"),
4622 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
4623 // There are only a few cases to test here:
4624 // * its not really normative behavior, but we test that below-dust HTLCs "included" in
4625 // broadcastable commitment transactions result in channel closure,
4626 // * its included in an unrevoked-but-previous remote commitment transaction,
4627 // * its included in the latest remote or local commitment transactions.
4628 // We test each of the three possible commitment transactions individually and use both dust and
4630 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
4631 // assume they are handled the same across all six cases, as both outbound and inbound failures are
4632 // tested for at least one of the cases in other tests.
4634 fn htlc_claim_single_commitment_only_a() {
4635 do_htlc_claim_local_commitment_only(true);
4636 do_htlc_claim_local_commitment_only(false);
4638 do_htlc_claim_current_remote_commitment_only(true);
4639 do_htlc_claim_current_remote_commitment_only(false);
4643 fn htlc_claim_single_commitment_only_b() {
4644 do_htlc_claim_previous_remote_commitment_only(true, false);
4645 do_htlc_claim_previous_remote_commitment_only(false, false);
4646 do_htlc_claim_previous_remote_commitment_only(true, true);
4647 do_htlc_claim_previous_remote_commitment_only(false, true);
4650 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>)
4651 where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
4654 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);
4658 // 0: node1 fails backward
4659 // 1: final node fails backward
4660 // 2: payment completed but the user rejects the payment
4661 // 3: final node fails backward (but tamper onion payloads from node0)
4662 // 100: trigger error in the intermediate node and tamper returning fail_htlc
4663 // 200: trigger error in the final node and tamper returning fail_htlc
4664 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>)
4665 where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
4666 F2: for <'a> FnMut(&'a mut msgs::UpdateFailHTLC),
4670 // reset block height
4671 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4672 for ix in 0..nodes.len() {
4673 nodes[ix].block_notifier.block_connected_checked(&header, 1, &[], &[]);
4676 macro_rules! expect_event {
4677 ($node: expr, $event_type: path) => {{
4678 let events = $node.node.get_and_clear_pending_events();
4679 assert_eq!(events.len(), 1);
4681 $event_type { .. } => {},
4682 _ => panic!("Unexpected event"),
4687 macro_rules! expect_htlc_forward {
4689 expect_event!($node, Event::PendingHTLCsForwardable);
4690 $node.node.process_pending_htlc_forwards();
4694 // 0 ~~> 2 send payment
4695 nodes[0].node.send_payment(route.clone(), payment_hash.clone()).unwrap();
4696 check_added_monitors!(nodes[0], 1);
4697 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4698 // temper update_add (0 => 1)
4699 let mut update_add_0 = update_0.update_add_htlcs[0].clone();
4700 if test_case == 0 || test_case == 3 || test_case == 100 {
4701 callback_msg(&mut update_add_0);
4704 // 0 => 1 update_add & CS
4705 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0);
4706 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
4708 let update_1_0 = match test_case {
4709 0|100 => { // intermediate node failure; fail backward to 0
4710 let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4711 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));
4714 1|2|3|200 => { // final node failure; forwarding to 2
4715 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4717 if test_case != 200 {
4720 expect_htlc_forward!(&nodes[1]);
4722 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
4723 check_added_monitors!(&nodes[1], 1);
4724 assert_eq!(update_1.update_add_htlcs.len(), 1);
4725 // tamper update_add (1 => 2)
4726 let mut update_add_1 = update_1.update_add_htlcs[0].clone();
4727 if test_case != 3 && test_case != 200 {
4728 callback_msg(&mut update_add_1);
4732 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1);
4733 commitment_signed_dance!(nodes[2], nodes[1], update_1.commitment_signed, false, true);
4735 if test_case == 2 || test_case == 200 {
4736 expect_htlc_forward!(&nodes[2]);
4737 expect_event!(&nodes[2], Event::PaymentReceived);
4739 expect_pending_htlcs_forwardable!(nodes[2]);
4742 let update_2_1 = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
4743 if test_case == 2 || test_case == 200 {
4744 check_added_monitors!(&nodes[2], 1);
4746 assert!(update_2_1.update_fail_htlcs.len() == 1);
4748 let mut fail_msg = update_2_1.update_fail_htlcs[0].clone();
4749 if test_case == 200 {
4750 callback_fail(&mut fail_msg);
4754 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &fail_msg);
4755 commitment_signed_dance!(nodes[1], nodes[2], update_2_1.commitment_signed, true);
4757 // backward fail on 1
4758 let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4759 assert!(update_1_0.update_fail_htlcs.len() == 1);
4762 _ => unreachable!(),
4765 // 1 => 0 commitment_signed_dance
4766 if update_1_0.update_fail_htlcs.len() > 0 {
4767 let mut fail_msg = update_1_0.update_fail_htlcs[0].clone();
4768 if test_case == 100 {
4769 callback_fail(&mut fail_msg);
4771 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
4773 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_1_0.update_fail_malformed_htlcs[0]);
4776 commitment_signed_dance!(nodes[0], nodes[1], update_1_0.commitment_signed, false, true);
4778 let events = nodes[0].node.get_and_clear_pending_events();
4779 assert_eq!(events.len(), 1);
4780 if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code } = &events[0] {
4781 assert_eq!(*rejected_by_dest, !expected_retryable);
4782 assert_eq!(*error_code, expected_error_code);
4784 panic!("Uexpected event");
4787 let events = nodes[0].node.get_and_clear_pending_msg_events();
4788 if expected_channel_update.is_some() {
4789 assert_eq!(events.len(), 1);
4791 MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
4793 &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {
4794 if let HTLCFailChannelUpdate::ChannelUpdateMessage { .. } = expected_channel_update.unwrap() {} else {
4795 panic!("channel_update not found!");
4798 &HTLCFailChannelUpdate::ChannelClosed { ref short_channel_id, ref is_permanent } => {
4799 if let HTLCFailChannelUpdate::ChannelClosed { short_channel_id: ref expected_short_channel_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
4800 assert!(*short_channel_id == *expected_short_channel_id);
4801 assert!(*is_permanent == *expected_is_permanent);
4803 panic!("Unexpected message event");
4806 &HTLCFailChannelUpdate::NodeFailure { ref node_id, ref is_permanent } => {
4807 if let HTLCFailChannelUpdate::NodeFailure { node_id: ref expected_node_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
4808 assert!(*node_id == *expected_node_id);
4809 assert!(*is_permanent == *expected_is_permanent);
4811 panic!("Unexpected message event");
4816 _ => panic!("Unexpected message event"),
4819 assert_eq!(events.len(), 0);
4823 impl msgs::ChannelUpdate {
4824 fn dummy() -> msgs::ChannelUpdate {
4825 use secp256k1::ffi::Signature as FFISignature;
4826 use secp256k1::Signature;
4827 msgs::ChannelUpdate {
4828 signature: Signature::from(FFISignature::new()),
4829 contents: msgs::UnsignedChannelUpdate {
4830 chain_hash: Sha256dHash::hash(&vec![0u8][..]),
4831 short_channel_id: 0,
4834 cltv_expiry_delta: 0,
4835 htlc_minimum_msat: 0,
4837 fee_proportional_millionths: 0,
4838 excess_data: vec![],
4845 fn test_onion_failure() {
4846 use ln::msgs::ChannelUpdate;
4847 use ln::channelmanager::CLTV_FAR_FAR_AWAY;
4850 const BADONION: u16 = 0x8000;
4851 const PERM: u16 = 0x4000;
4852 const NODE: u16 = 0x2000;
4853 const UPDATE: u16 = 0x1000;
4855 let mut nodes = create_network(3, &[None, None, None]);
4856 for node in nodes.iter() {
4857 *node.keys_manager.override_session_priv.lock().unwrap() = Some(SecretKey::from_slice(&[3; 32]).unwrap());
4859 let channels = [create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()), create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported())];
4860 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
4861 let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV).unwrap();
4863 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 40000, 40_000);
4865 // intermediate node failure
4866 run_onion_failure_test("invalid_realm", 0, &nodes, &route, &payment_hash, |msg| {
4867 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4868 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
4869 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4870 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
4871 onion_payloads[0].realm = 3;
4872 msg.onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
4873 }, ||{}, true, Some(PERM|1), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));//XXX incremented channels idx here
4875 // final node failure
4876 run_onion_failure_test("invalid_realm", 3, &nodes, &route, &payment_hash, |msg| {
4877 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4878 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
4879 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4880 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
4881 onion_payloads[1].realm = 3;
4882 msg.onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
4883 }, ||{}, false, Some(PERM|1), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
4885 // the following three with run_onion_failure_test_with_fail_intercept() test only the origin node
4886 // receiving simulated fail messages
4887 // intermediate node failure
4888 run_onion_failure_test_with_fail_intercept("temporary_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
4890 msg.amount_msat -= 1;
4892 // and tamper returning error message
4893 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4894 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4895 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], NODE|2, &[0;0]);
4896 }, ||{}, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: false}));
4898 // final node failure
4899 run_onion_failure_test_with_fail_intercept("temporary_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
4900 // and tamper returning error message
4901 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4902 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4903 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], NODE|2, &[0;0]);
4905 nodes[2].node.fail_htlc_backwards(&payment_hash);
4906 }, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: false}));
4908 // intermediate node failure
4909 run_onion_failure_test_with_fail_intercept("permanent_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
4910 msg.amount_msat -= 1;
4912 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4913 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4914 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|2, &[0;0]);
4915 }, ||{}, true, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: true}));
4917 // final node failure
4918 run_onion_failure_test_with_fail_intercept("permanent_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
4919 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4920 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4921 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|2, &[0;0]);
4923 nodes[2].node.fail_htlc_backwards(&payment_hash);
4924 }, false, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: true}));
4926 // intermediate node failure
4927 run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
4928 msg.amount_msat -= 1;
4930 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4931 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4932 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|3, &[0;0]);
4934 nodes[2].node.fail_htlc_backwards(&payment_hash);
4935 }, true, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: true}));
4937 // final node failure
4938 run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
4939 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4940 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4941 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|3, &[0;0]);
4943 nodes[2].node.fail_htlc_backwards(&payment_hash);
4944 }, false, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: true}));
4946 run_onion_failure_test("invalid_onion_version", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.version = 1; }, ||{}, true,
4947 Some(BADONION|PERM|4), None);
4949 run_onion_failure_test("invalid_onion_hmac", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.hmac = [3; 32]; }, ||{}, true,
4950 Some(BADONION|PERM|5), None);
4952 run_onion_failure_test("invalid_onion_key", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.public_key = Err(secp256k1::Error::InvalidPublicKey);}, ||{}, true,
4953 Some(BADONION|PERM|6), None);
4955 run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
4956 msg.amount_msat -= 1;
4958 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4959 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4960 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], UPDATE|7, &ChannelUpdate::dummy().encode_with_len()[..]);
4961 }, ||{}, true, Some(UPDATE|7), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
4963 run_onion_failure_test_with_fail_intercept("permanent_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
4964 msg.amount_msat -= 1;
4966 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4967 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4968 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|8, &[0;0]);
4969 // short_channel_id from the processing node
4970 }, ||{}, true, Some(PERM|8), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
4972 run_onion_failure_test_with_fail_intercept("required_channel_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
4973 msg.amount_msat -= 1;
4975 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4976 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4977 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|9, &[0;0]);
4978 // short_channel_id from the processing node
4979 }, ||{}, true, Some(PERM|9), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
4981 let mut bogus_route = route.clone();
4982 bogus_route.hops[1].short_channel_id -= 1;
4983 run_onion_failure_test("unknown_next_peer", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(PERM|10),
4984 Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: bogus_route.hops[1].short_channel_id, is_permanent:true}));
4986 let amt_to_forward = nodes[1].node.channel_state.lock().unwrap().by_id.get(&channels[1].2).unwrap().get_their_htlc_minimum_msat() - 1;
4987 let mut bogus_route = route.clone();
4988 let route_len = bogus_route.hops.len();
4989 bogus_route.hops[route_len-1].fee_msat = amt_to_forward;
4990 run_onion_failure_test("amount_below_minimum", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(UPDATE|11), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
4992 //TODO: with new config API, we will be able to generate both valid and
4993 //invalid channel_update cases.
4994 run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, |msg| {
4995 msg.amount_msat -= 1;
4996 }, || {}, true, Some(UPDATE|12), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
4998 run_onion_failure_test("incorrect_cltv_expiry", 0, &nodes, &route, &payment_hash, |msg| {
4999 // need to violate: cltv_expiry - cltv_expiry_delta >= outgoing_cltv_value
5000 msg.cltv_expiry -= 1;
5001 }, || {}, true, Some(UPDATE|13), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
5003 run_onion_failure_test("expiry_too_soon", 0, &nodes, &route, &payment_hash, |msg| {
5004 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
5005 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5007 nodes[1].block_notifier.block_connected_checked(&header, height, &[], &[]);
5008 }, ||{}, true, Some(UPDATE|14), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5010 run_onion_failure_test("unknown_payment_hash", 2, &nodes, &route, &payment_hash, |_| {}, || {
5011 nodes[2].node.fail_htlc_backwards(&payment_hash);
5012 }, false, Some(PERM|15), None);
5014 run_onion_failure_test("final_expiry_too_soon", 1, &nodes, &route, &payment_hash, |msg| {
5015 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
5016 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5018 nodes[2].block_notifier.block_connected_checked(&header, height, &[], &[]);
5019 }, || {}, true, Some(17), None);
5021 run_onion_failure_test("final_incorrect_cltv_expiry", 1, &nodes, &route, &payment_hash, |_| {}, || {
5022 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
5023 for f in pending_forwards.iter_mut() {
5025 &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
5026 forward_info.outgoing_cltv_value += 1,
5031 }, true, Some(18), None);
5033 run_onion_failure_test("final_incorrect_htlc_amount", 1, &nodes, &route, &payment_hash, |_| {}, || {
5034 // violate amt_to_forward > msg.amount_msat
5035 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
5036 for f in pending_forwards.iter_mut() {
5038 &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
5039 forward_info.amt_to_forward -= 1,
5044 }, true, Some(19), None);
5046 run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, |_| {}, || {
5047 // disconnect event to the channel between nodes[1] ~ nodes[2]
5048 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
5049 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5050 }, true, Some(UPDATE|20), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5051 reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
5053 run_onion_failure_test("expiry_too_far", 0, &nodes, &route, &payment_hash, |msg| {
5054 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5055 let mut route = route.clone();
5057 route.hops[1].cltv_expiry_delta += CLTV_FAR_FAR_AWAY + route.hops[0].cltv_expiry_delta + 1;
5058 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5059 let (onion_payloads, _, htlc_cltv) = onion_utils::build_onion_payloads(&route, height).unwrap();
5060 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
5061 msg.cltv_expiry = htlc_cltv;
5062 msg.onion_routing_packet = onion_packet;
5063 }, ||{}, true, Some(21), None);
5068 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
5069 let nodes = create_network(2, &[None, None]);
5070 //Force duplicate channel ids
5071 for node in nodes.iter() {
5072 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
5075 // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
5076 let channel_value_satoshis=10000;
5077 let push_msat=10001;
5078 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).unwrap();
5079 let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5080 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::supported(), &node0_to_1_send_open_channel);
5082 //Create a second channel with a channel_id collision
5083 assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).is_err());
5087 fn bolt2_open_channel_sending_node_checks_part2() {
5088 let nodes = create_network(2, &[None, None]);
5090 // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
5091 let channel_value_satoshis=2^24;
5092 let push_msat=10001;
5093 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).is_err());
5095 // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
5096 let channel_value_satoshis=10000;
5097 // Test when push_msat is equal to 1000 * funding_satoshis.
5098 let push_msat=1000*channel_value_satoshis+1;
5099 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).is_err());
5101 // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
5102 let channel_value_satoshis=10000;
5103 let push_msat=10001;
5104 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).is_ok()); //Create a valid channel
5105 let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5106 assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
5108 // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
5109 // 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
5110 assert!(node0_to_1_send_open_channel.channel_flags<=1);
5112 // 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.
5113 assert!(BREAKDOWN_TIMEOUT>0);
5114 assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
5116 // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
5117 let chain_hash=genesis_block(Network::Testnet).header.bitcoin_hash();
5118 assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
5120 // 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.
5121 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
5122 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
5123 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
5124 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_basepoint.serialize()).is_ok());
5125 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
5128 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
5129 // 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.
5130 //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.
5133 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
5134 //BOLT2 Requirement: MUST offer amount_msat greater than 0.
5135 //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
5136 let mut nodes = create_network(2, &[None, None]);
5137 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5138 let mut route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5139 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5141 route.hops[0].fee_msat = 0;
5143 let err = nodes[0].node.send_payment(route, our_payment_hash);
5145 if let Err(APIError::ChannelUnavailable{err}) = err {
5146 assert_eq!(err, "Cannot send less than their minimum HTLC value");
5150 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5151 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
5155 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
5156 //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
5157 //It is enforced when constructing a route.
5158 let mut nodes = create_network(2, &[None, None]);
5159 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 0, InitFeatures::supported(), InitFeatures::supported());
5160 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000000, 500000001).unwrap();
5161 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5163 let err = nodes[0].node.send_payment(route, our_payment_hash);
5165 if let Err(APIError::RouteError{err}) = err {
5166 assert_eq!(err, "Channel CLTV overflowed?!");
5173 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
5174 //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.
5175 //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
5176 //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
5177 let mut nodes = create_network(2, &[None, None]);
5178 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::supported(), InitFeatures::supported());
5179 let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().their_max_accepted_htlcs as u64;
5181 for i in 0..max_accepted_htlcs {
5182 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5183 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5184 let payment_event = {
5185 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5186 check_added_monitors!(nodes[0], 1);
5188 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5189 assert_eq!(events.len(), 1);
5190 if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
5191 assert_eq!(htlcs[0].htlc_id, i);
5195 SendEvent::from_event(events.remove(0))
5197 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
5198 check_added_monitors!(nodes[1], 0);
5199 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
5201 expect_pending_htlcs_forwardable!(nodes[1]);
5202 expect_payment_received!(nodes[1], our_payment_hash, 100000);
5204 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5205 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5206 let err = nodes[0].node.send_payment(route, our_payment_hash);
5208 if let Err(APIError::ChannelUnavailable{err}) = err {
5209 assert_eq!(err, "Cannot push more than their max accepted HTLCs");
5213 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5214 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
5218 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
5219 //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.
5220 let mut nodes = create_network(2, &[None, None]);
5221 let channel_value = 100000;
5222 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::supported(), InitFeatures::supported());
5223 let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).their_max_htlc_value_in_flight_msat;
5225 send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight, max_in_flight);
5227 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], max_in_flight+1, TEST_FINAL_CLTV).unwrap();
5228 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5229 let err = nodes[0].node.send_payment(route, our_payment_hash);
5231 if let Err(APIError::ChannelUnavailable{err}) = err {
5232 assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight our peer will accept");
5236 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5237 nodes[0].logger.assert_log("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);
5239 send_payment(&nodes[0], &[&nodes[1]], max_in_flight, max_in_flight);
5242 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
5244 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
5245 //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
5246 let mut nodes = create_network(2, &[None, None]);
5247 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5248 let htlc_minimum_msat: u64;
5250 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
5251 let channel = chan_lock.by_id.get(&chan.2).unwrap();
5252 htlc_minimum_msat = channel.get_our_htlc_minimum_msat();
5254 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], htlc_minimum_msat, TEST_FINAL_CLTV).unwrap();
5255 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5256 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5257 check_added_monitors!(nodes[0], 1);
5258 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5259 updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
5260 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5261 assert!(nodes[1].node.list_channels().is_empty());
5262 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5263 assert_eq!(err_msg.data, "Remote side tried to send less than our minimum HTLC value");
5267 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
5268 //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
5269 let mut nodes = create_network(2, &[None, None]);
5270 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5272 let their_channel_reserve = get_channel_value_stat!(nodes[0], chan.2).channel_reserve_msat;
5274 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 5000000-their_channel_reserve, TEST_FINAL_CLTV).unwrap();
5275 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5276 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5277 check_added_monitors!(nodes[0], 1);
5278 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5280 updates.update_add_htlcs[0].amount_msat = 5000000-their_channel_reserve+1;
5281 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5283 assert!(nodes[1].node.list_channels().is_empty());
5284 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5285 assert_eq!(err_msg.data, "Remote HTLC add would put them over their reserve value");
5289 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
5290 //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
5291 //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
5292 let mut nodes = create_network(2, &[None, None]);
5293 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5294 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 3999999, TEST_FINAL_CLTV).unwrap();
5295 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5297 let session_priv = SecretKey::from_slice(&{
5298 let mut session_key = [0; 32];
5299 let mut rng = thread_rng();
5300 rng.fill_bytes(&mut session_key);
5302 }).expect("RNG is bad!");
5304 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5305 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route, &session_priv).unwrap();
5306 let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
5307 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
5309 let mut msg = msgs::UpdateAddHTLC {
5313 payment_hash: our_payment_hash,
5314 cltv_expiry: htlc_cltv,
5315 onion_routing_packet: onion_packet.clone(),
5318 for i in 0..super::channel::OUR_MAX_HTLCS {
5319 msg.htlc_id = i as u64;
5320 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
5322 msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
5323 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
5325 assert!(nodes[1].node.list_channels().is_empty());
5326 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5327 assert_eq!(err_msg.data, "Remote tried to push more than our max accepted HTLCs");
5331 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
5332 //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
5333 let mut nodes = create_network(2, &[None, None]);
5334 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
5335 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5336 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5337 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5338 check_added_monitors!(nodes[0], 1);
5339 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5340 updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).their_max_htlc_value_in_flight_msat + 1;
5341 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5343 assert!(nodes[1].node.list_channels().is_empty());
5344 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5345 assert_eq!(err_msg.data,"Remote HTLC add would put them over our max HTLC value");
5349 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
5350 //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
5351 let mut nodes = create_network(2, &[None, None]);
5352 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5353 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 3999999, TEST_FINAL_CLTV).unwrap();
5354 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5355 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5356 check_added_monitors!(nodes[0], 1);
5357 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5358 updates.update_add_htlcs[0].cltv_expiry = 500000000;
5359 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5361 assert!(nodes[1].node.list_channels().is_empty());
5362 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5363 assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
5367 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
5368 //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
5369 // We test this by first testing that that repeated HTLCs pass commitment signature checks
5370 // after disconnect and that non-sequential htlc_ids result in a channel failure.
5371 let mut nodes = create_network(2, &[None, None]);
5372 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5373 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5374 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5375 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5376 check_added_monitors!(nodes[0], 1);
5377 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5378 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5380 //Disconnect and Reconnect
5381 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5382 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5383 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
5384 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
5385 assert_eq!(reestablish_1.len(), 1);
5386 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
5387 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
5388 assert_eq!(reestablish_2.len(), 1);
5389 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
5390 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
5391 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
5392 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
5395 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5396 assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
5397 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
5398 check_added_monitors!(nodes[1], 1);
5399 let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5401 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5403 assert!(nodes[1].node.list_channels().is_empty());
5404 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5405 assert_eq!(err_msg.data, "Remote skipped HTLC ID");
5409 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
5410 //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.
5412 let mut nodes = create_network(2, &[None, None]);
5413 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5415 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5416 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5417 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5418 check_added_monitors!(nodes[0], 1);
5419 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5420 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5422 let update_msg = msgs::UpdateFulfillHTLC{
5425 payment_preimage: our_payment_preimage,
5428 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5430 assert!(nodes[0].node.list_channels().is_empty());
5431 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5432 assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
5436 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
5437 //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.
5439 let mut nodes = create_network(2, &[None, None]);
5440 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5442 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5443 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5444 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5445 check_added_monitors!(nodes[0], 1);
5446 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5447 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5449 let update_msg = msgs::UpdateFailHTLC{
5452 reason: msgs::OnionErrorPacket { data: Vec::new()},
5455 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5457 assert!(nodes[0].node.list_channels().is_empty());
5458 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5459 assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
5463 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
5464 //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.
5466 let mut nodes = create_network(2, &[None, None]);
5467 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5469 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5470 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5471 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5472 check_added_monitors!(nodes[0], 1);
5473 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5474 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5476 let update_msg = msgs::UpdateFailMalformedHTLC{
5479 sha256_of_onion: [1; 32],
5480 failure_code: 0x8000,
5483 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5485 assert!(nodes[0].node.list_channels().is_empty());
5486 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5487 assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
5491 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
5492 //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
5494 let nodes = create_network(2, &[None, None]);
5495 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5497 let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
5499 nodes[1].node.claim_funds(our_payment_preimage, 100_000);
5500 check_added_monitors!(nodes[1], 1);
5502 let events = nodes[1].node.get_and_clear_pending_msg_events();
5503 assert_eq!(events.len(), 1);
5504 let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
5506 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, .. } } => {
5507 assert!(update_add_htlcs.is_empty());
5508 assert_eq!(update_fulfill_htlcs.len(), 1);
5509 assert!(update_fail_htlcs.is_empty());
5510 assert!(update_fail_malformed_htlcs.is_empty());
5511 assert!(update_fee.is_none());
5512 update_fulfill_htlcs[0].clone()
5514 _ => panic!("Unexpected event"),
5518 update_fulfill_msg.htlc_id = 1;
5520 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
5522 assert!(nodes[0].node.list_channels().is_empty());
5523 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5524 assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
5528 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
5529 //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.
5531 let nodes = create_network(2, &[None, None]);
5532 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5534 let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
5536 nodes[1].node.claim_funds(our_payment_preimage, 100_000);
5537 check_added_monitors!(nodes[1], 1);
5539 let events = nodes[1].node.get_and_clear_pending_msg_events();
5540 assert_eq!(events.len(), 1);
5541 let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
5543 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, .. } } => {
5544 assert!(update_add_htlcs.is_empty());
5545 assert_eq!(update_fulfill_htlcs.len(), 1);
5546 assert!(update_fail_htlcs.is_empty());
5547 assert!(update_fail_malformed_htlcs.is_empty());
5548 assert!(update_fee.is_none());
5549 update_fulfill_htlcs[0].clone()
5551 _ => panic!("Unexpected event"),
5555 update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
5557 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
5559 assert!(nodes[0].node.list_channels().is_empty());
5560 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5561 assert_eq!(err_msg.data, "Remote tried to fulfill HTLC with an incorrect preimage");
5566 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
5567 //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.
5569 let mut nodes = create_network(2, &[None, None]);
5570 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
5571 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5572 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5573 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5574 check_added_monitors!(nodes[0], 1);
5576 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5577 updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
5579 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5580 check_added_monitors!(nodes[1], 0);
5581 commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
5583 let events = nodes[1].node.get_and_clear_pending_msg_events();
5585 let mut update_msg: msgs::UpdateFailMalformedHTLC = {
5587 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, .. } } => {
5588 assert!(update_add_htlcs.is_empty());
5589 assert!(update_fulfill_htlcs.is_empty());
5590 assert!(update_fail_htlcs.is_empty());
5591 assert_eq!(update_fail_malformed_htlcs.len(), 1);
5592 assert!(update_fee.is_none());
5593 update_fail_malformed_htlcs[0].clone()
5595 _ => panic!("Unexpected event"),
5598 update_msg.failure_code &= !0x8000;
5599 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5601 assert!(nodes[0].node.list_channels().is_empty());
5602 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5603 assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
5607 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
5608 //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
5609 // * 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.
5611 let mut nodes = create_network(3, &[None, None, None]);
5612 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
5613 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
5615 let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
5616 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5619 let mut payment_event = {
5620 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5621 check_added_monitors!(nodes[0], 1);
5622 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5623 assert_eq!(events.len(), 1);
5624 SendEvent::from_event(events.remove(0))
5626 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
5627 check_added_monitors!(nodes[1], 0);
5628 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
5629 expect_pending_htlcs_forwardable!(nodes[1]);
5630 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
5631 assert_eq!(events_2.len(), 1);
5632 check_added_monitors!(nodes[1], 1);
5633 payment_event = SendEvent::from_event(events_2.remove(0));
5634 assert_eq!(payment_event.msgs.len(), 1);
5637 payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
5638 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
5639 check_added_monitors!(nodes[2], 0);
5640 commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
5642 let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
5643 assert_eq!(events_3.len(), 1);
5644 let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
5646 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 } } => {
5647 assert!(update_add_htlcs.is_empty());
5648 assert!(update_fulfill_htlcs.is_empty());
5649 assert!(update_fail_htlcs.is_empty());
5650 assert_eq!(update_fail_malformed_htlcs.len(), 1);
5651 assert!(update_fee.is_none());
5652 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
5654 _ => panic!("Unexpected event"),
5658 nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
5660 check_added_monitors!(nodes[1], 0);
5661 commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
5662 expect_pending_htlcs_forwardable!(nodes[1]);
5663 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
5664 assert_eq!(events_4.len(), 1);
5666 //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
5668 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, .. } } => {
5669 assert!(update_add_htlcs.is_empty());
5670 assert!(update_fulfill_htlcs.is_empty());
5671 assert_eq!(update_fail_htlcs.len(), 1);
5672 assert!(update_fail_malformed_htlcs.is_empty());
5673 assert!(update_fee.is_none());
5675 _ => panic!("Unexpected event"),
5678 check_added_monitors!(nodes[1], 1);
5681 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
5682 // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
5683 // 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
5684 // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
5686 let nodes = create_network(2, &[None, None]);
5687 let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5689 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
5691 // We route 2 dust-HTLCs between A and B
5692 let (_, payment_hash_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
5693 let (_, payment_hash_2) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
5694 route_payment(&nodes[0], &[&nodes[1]], 1000000);
5696 // Cache one local commitment tx as previous
5697 let as_prev_commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
5699 // Fail one HTLC to prune it in the will-be-latest-local commitment tx
5700 assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2));
5701 check_added_monitors!(nodes[1], 0);
5702 expect_pending_htlcs_forwardable!(nodes[1]);
5703 check_added_monitors!(nodes[1], 1);
5705 let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5706 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
5707 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
5708 check_added_monitors!(nodes[0], 1);
5710 // Cache one local commitment tx as lastest
5711 let as_last_commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
5713 let events = nodes[0].node.get_and_clear_pending_msg_events();
5715 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
5716 assert_eq!(node_id, nodes[1].node.get_our_node_id());
5718 _ => panic!("Unexpected event"),
5721 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
5722 assert_eq!(node_id, nodes[1].node.get_our_node_id());
5724 _ => panic!("Unexpected event"),
5727 assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
5728 // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
5729 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5731 if announce_latest {
5732 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_last_commitment_tx[0].clone()]}, 1);
5734 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_prev_commitment_tx[0].clone()]}, 1);
5737 let events = nodes[0].node.get_and_clear_pending_msg_events();
5738 assert_eq!(events.len(), 1);
5740 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5741 _ => panic!("Unexpected event"),
5744 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
5745 connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
5746 let events = nodes[0].node.get_and_clear_pending_events();
5747 // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
5748 assert_eq!(events.len(), 2);
5749 let mut first_failed = false;
5750 for event in events {
5752 Event::PaymentFailed { payment_hash, .. } => {
5753 if payment_hash == payment_hash_1 {
5754 assert!(!first_failed);
5755 first_failed = true;
5757 assert_eq!(payment_hash, payment_hash_2);
5760 _ => panic!("Unexpected event"),
5766 fn test_failure_delay_dust_htlc_local_commitment() {
5767 do_test_failure_delay_dust_htlc_local_commitment(true);
5768 do_test_failure_delay_dust_htlc_local_commitment(false);
5772 fn test_no_failure_dust_htlc_local_commitment() {
5773 // Transaction filters for failing back dust htlc based on local commitment txn infos has been
5774 // prone to error, we test here that a dummy transaction don't fail them.
5776 let nodes = create_network(2, &[None, None]);
5777 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5780 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
5782 let as_dust_limit = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
5783 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
5785 // We route 2 dust-HTLCs between A and B
5786 let (preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
5787 let (preimage_2, _) = route_payment(&nodes[1], &[&nodes[0]], as_dust_limit*1000);
5789 // Build a dummy invalid transaction trying to spend a commitment tx
5791 previous_output: BitcoinOutPoint { txid: chan.3.txid(), vout: 0 },
5792 script_sig: Script::new(),
5794 witness: Vec::new(),
5798 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
5802 let dummy_tx = Transaction {
5809 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5810 nodes[0].chan_monitor.simple_monitor.block_connected(&header, 1, &[&dummy_tx], &[1;1]);
5811 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
5812 assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
5813 // We broadcast a few more block to check everything is all right
5814 connect_blocks(&nodes[0].block_notifier, 20, 1, true, header.bitcoin_hash());
5815 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
5816 assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
5818 claim_payment(&nodes[0], &vec!(&nodes[1])[..], preimage_1, bs_dust_limit*1000);
5819 claim_payment(&nodes[1], &vec!(&nodes[0])[..], preimage_2, as_dust_limit*1000);
5822 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
5823 // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
5824 // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
5825 // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
5826 // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
5827 // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
5828 // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
5830 let nodes = create_network(3, &[None, None, None]);
5831 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5833 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
5835 let (_payment_preimage_1, dust_hash) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
5836 let (_payment_preimage_2, non_dust_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
5838 let as_commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
5839 let bs_commitment_tx = nodes[1].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
5841 // We revoked bs_commitment_tx
5843 let (payment_preimage_3, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
5844 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 1_000_000);
5847 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5848 let mut timeout_tx = Vec::new();
5850 // We fail dust-HTLC 1 by broadcast of local commitment tx
5851 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_commitment_tx[0].clone()]}, 1);
5852 let events = nodes[0].node.get_and_clear_pending_msg_events();
5853 assert_eq!(events.len(), 1);
5855 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5856 _ => panic!("Unexpected event"),
5858 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
5859 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
5860 let parent_hash = connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
5861 let events = nodes[0].node.get_and_clear_pending_events();
5862 assert_eq!(events.len(), 1);
5864 Event::PaymentFailed { payment_hash, .. } => {
5865 assert_eq!(payment_hash, dust_hash);
5867 _ => panic!("Unexpected event"),
5869 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5870 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
5871 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5872 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
5873 nodes[0].block_notifier.block_connected(&Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
5874 let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5875 connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
5876 let events = nodes[0].node.get_and_clear_pending_events();
5877 assert_eq!(events.len(), 1);
5879 Event::PaymentFailed { payment_hash, .. } => {
5880 assert_eq!(payment_hash, non_dust_hash);
5882 _ => panic!("Unexpected event"),
5885 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
5886 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![bs_commitment_tx[0].clone()]}, 1);
5887 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
5888 let events = nodes[0].node.get_and_clear_pending_msg_events();
5889 assert_eq!(events.len(), 1);
5891 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5892 _ => panic!("Unexpected event"),
5894 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
5895 let parent_hash = connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
5896 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5898 let events = nodes[0].node.get_and_clear_pending_events();
5899 assert_eq!(events.len(), 1);
5901 Event::PaymentFailed { payment_hash, .. } => {
5902 assert_eq!(payment_hash, dust_hash);
5904 _ => panic!("Unexpected event"),
5906 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5907 // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
5908 nodes[0].block_notifier.block_connected(&Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
5909 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
5910 let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5911 connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
5912 let events = nodes[0].node.get_and_clear_pending_events();
5913 assert_eq!(events.len(), 1);
5915 Event::PaymentFailed { payment_hash, .. } => {
5916 assert_eq!(payment_hash, non_dust_hash);
5918 _ => panic!("Unexpected event"),
5921 // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
5923 let events = nodes[0].node.get_and_clear_pending_events();
5924 assert_eq!(events.len(), 2);
5927 Event::PaymentFailed { payment_hash, .. } => {
5928 if payment_hash == dust_hash { first = true; }
5929 else { first = false; }
5931 _ => panic!("Unexpected event"),
5934 Event::PaymentFailed { payment_hash, .. } => {
5935 if first { assert_eq!(payment_hash, non_dust_hash); }
5936 else { assert_eq!(payment_hash, dust_hash); }
5938 _ => panic!("Unexpected event"),
5945 fn test_sweep_outbound_htlc_failure_update() {
5946 do_test_sweep_outbound_htlc_failure_update(false, true);
5947 do_test_sweep_outbound_htlc_failure_update(false, false);
5948 do_test_sweep_outbound_htlc_failure_update(true, false);
5952 fn test_upfront_shutdown_script() {
5953 // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
5954 // enforce it at shutdown message
5956 let mut config = UserConfig::default();
5957 config.channel_options.announced_channel = true;
5958 config.peer_channel_config_limits.force_announced_channel_preference = false;
5959 config.channel_options.commit_upfront_shutdown_pubkey = false;
5960 let cfgs = [None, Some(config), None];
5961 let nodes = create_network(3, &cfgs);
5963 // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
5964 let flags = InitFeatures::supported();
5965 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
5966 nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
5967 let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
5968 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
5969 // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that we disconnect peer
5970 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
5971 let events = nodes[2].node.get_and_clear_pending_msg_events();
5972 assert_eq!(events.len(), 2);
5974 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5975 _ => panic!("Unexpected event"),
5977 if let MessageSendEvent::HandleError { ref action, .. } = events[1] {
5979 &ErrorAction::SendErrorMessage { ref msg } => {
5980 assert_eq!(msg.data,"Got shutdown request with a scriptpubkey which did not match their previous scriptpubkey");
5982 _ => { assert!(false); }
5984 } else { assert!(false); }
5986 // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
5987 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
5988 nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
5989 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
5990 // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
5991 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
5992 let events = nodes[2].node.get_and_clear_pending_msg_events();
5993 assert_eq!(events.len(), 1);
5995 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
5996 _ => panic!("Unexpected event"),
5999 // We test that if case of peer non-signaling we don't enforce committed script at channel opening
6000 let mut flags_no = InitFeatures::supported();
6001 flags_no.unset_upfront_shutdown_script();
6002 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
6003 nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6004 let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
6005 node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6006 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_1_shutdown);
6007 let events = nodes[1].node.get_and_clear_pending_msg_events();
6008 assert_eq!(events.len(), 1);
6010 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
6011 _ => panic!("Unexpected event"),
6014 // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
6015 // channel smoothly, opt-out is from channel initiator here
6016 let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
6017 nodes[1].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6018 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
6019 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6020 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
6021 let events = nodes[0].node.get_and_clear_pending_msg_events();
6022 assert_eq!(events.len(), 1);
6024 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6025 _ => panic!("Unexpected event"),
6028 //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
6029 //// channel smoothly
6030 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
6031 nodes[1].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6032 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
6033 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6034 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
6035 let events = nodes[0].node.get_and_clear_pending_msg_events();
6036 assert_eq!(events.len(), 2);
6038 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6039 _ => panic!("Unexpected event"),
6042 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6043 _ => panic!("Unexpected event"),
6048 fn test_user_configurable_csv_delay() {
6049 // We test our channel constructors yield errors when we pass them absurd csv delay
6051 let mut low_our_to_self_config = UserConfig::default();
6052 low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
6053 let mut high_their_to_self_config = UserConfig::default();
6054 high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
6055 let cfgs = [Some(high_their_to_self_config.clone()), None];
6056 let nodes = create_network(2, &cfgs);
6058 // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
6059 let keys_manager: Arc<KeysInterface<ChanKeySigner = EnforcingChannelKeys>> = Arc::new(test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
6060 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, Arc::new(test_utils::TestLogger::new()), &low_our_to_self_config) {
6062 APIError::APIMisuseError { err } => { assert_eq!(err, "Configured with an unreasonable our_to_self_delay putting user funds at risks"); },
6063 _ => panic!("Unexpected event"),
6065 } else { assert!(false) }
6067 // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
6068 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42).unwrap();
6069 let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
6070 open_channel.to_self_delay = 200;
6071 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::supported(), &open_channel, 0, Arc::new(test_utils::TestLogger::new()), &low_our_to_self_config) {
6073 ChannelError::Close(err) => { assert_eq!(err, "Configured with an unreasonable our_to_self_delay putting user funds at risks"); },
6074 _ => panic!("Unexpected event"),
6076 } else { assert!(false); }
6078 // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
6079 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42).unwrap();
6080 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::supported(), &get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id()));
6081 let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
6082 accept_channel.to_self_delay = 200;
6083 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::supported(), &accept_channel);
6084 if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
6086 &ErrorAction::SendErrorMessage { ref msg } => {
6087 assert_eq!(msg.data,"They wanted our payments to be delayed by a needlessly long period");
6089 _ => { assert!(false); }
6091 } else { assert!(false); }
6093 // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
6094 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42).unwrap();
6095 let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
6096 open_channel.to_self_delay = 200;
6097 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::supported(), &open_channel, 0, Arc::new(test_utils::TestLogger::new()), &high_their_to_self_config) {
6099 ChannelError::Close(err) => { assert_eq!(err, "They wanted our payments to be delayed by a needlessly long period"); },
6100 _ => panic!("Unexpected event"),
6102 } else { assert!(false); }
6106 fn test_data_loss_protect() {
6107 // We want to be sure that :
6108 // * we don't broadcast our Local Commitment Tx in case of fallen behind
6109 // * we close channel in case of detecting other being fallen behind
6110 // * we are able to claim our own outputs thanks to remote my_current_per_commitment_point
6111 let mut nodes = create_network(2, &[None, None]);
6113 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
6115 // Cache node A state before any channel update
6116 let previous_node_state = nodes[0].node.encode();
6117 let mut previous_chan_monitor_state = test_utils::TestVecWriter(Vec::new());
6118 nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut previous_chan_monitor_state).unwrap();
6120 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
6121 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
6123 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6124 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6126 // Restore node A from previous state
6127 let logger: Arc<Logger> = Arc::new(test_utils::TestLogger::with_id(format!("node {}", 0)));
6128 let mut chan_monitor = <(Sha256dHash, ChannelMonitor)>::read(&mut ::std::io::Cursor::new(previous_chan_monitor_state.0), Arc::clone(&logger)).unwrap().1;
6129 let chain_monitor = Arc::new(ChainWatchInterfaceUtil::new(Network::Testnet, Arc::clone(&logger)));
6130 let tx_broadcaster = Arc::new(test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())});
6131 let feeest = Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 });
6132 let monitor = Arc::new(test_utils::TestChannelMonitor::new(chain_monitor.clone(), tx_broadcaster.clone(), logger.clone(), feeest.clone()));
6133 let node_state_0 = {
6134 let mut channel_monitors = HashMap::new();
6135 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chan_monitor);
6136 <(Sha256dHash, ChannelManager<EnforcingChannelKeys>)>::read(&mut ::std::io::Cursor::new(previous_node_state), ChannelManagerReadArgs {
6137 keys_manager: Arc::new(test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::clone(&logger))),
6138 fee_estimator: feeest.clone(),
6139 monitor: monitor.clone(),
6140 logger: Arc::clone(&logger),
6142 default_config: UserConfig::default(),
6143 channel_monitors: &mut channel_monitors
6146 nodes[0].node = Arc::new(node_state_0);
6147 assert!(monitor.add_update_monitor(OutPoint { txid: chan.3.txid(), index: 0 }, chan_monitor.clone()).is_ok());
6148 nodes[0].chan_monitor = monitor;
6149 nodes[0].chain_monitor = chain_monitor;
6151 let weak_res = Arc::downgrade(&nodes[0].chan_monitor.simple_monitor);
6152 nodes[0].block_notifier.register_listener(weak_res);
6153 let weak_res = Arc::downgrade(&nodes[0].node);
6154 nodes[0].block_notifier.register_listener(weak_res);
6156 check_added_monitors!(nodes[0], 1);
6158 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
6159 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
6161 let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6163 // Check we update monitor following learning of per_commitment_point from B
6164 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
6165 check_added_monitors!(nodes[0], 1);
6168 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
6169 assert_eq!(node_txn.len(), 0);
6172 let mut reestablish_1 = Vec::with_capacity(1);
6173 for msg in nodes[0].node.get_and_clear_pending_msg_events() {
6174 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
6175 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
6176 reestablish_1.push(msg.clone());
6177 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
6178 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
6180 &ErrorAction::SendErrorMessage { ref msg } => {
6181 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");
6183 _ => panic!("Unexpected event!"),
6186 panic!("Unexpected event")
6190 // Check we close channel detecting A is fallen-behind
6191 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6192 let events = nodes[1].node.get_and_clear_pending_msg_events();
6193 assert_eq!(events.len(), 2);
6195 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
6196 _ => panic!("Unexpected event"),
6199 MessageSendEvent::HandleError { ref action, .. } => {
6201 &ErrorAction::SendErrorMessage { ref msg } => {
6202 assert_eq!(msg.data, "Peer attempted to reestablish channel with a very old local commitment transaction"); },
6203 _ => panic!("Unexpected event!"),
6206 _ => panic!("Unexpected event"),
6209 // Check A is able to claim to_remote output
6210 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
6211 assert_eq!(node_txn.len(), 1);
6212 check_spends!(node_txn[0], chan.3.clone());
6213 assert_eq!(node_txn[0].output.len(), 2);
6214 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
6215 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()]}, 1);
6216 let spend_txn = check_spendable_outputs!(nodes[0], 1);
6217 assert_eq!(spend_txn.len(), 1);
6218 check_spends!(spend_txn[0], node_txn[0].clone());
6222 fn test_check_htlc_underpaying() {
6223 // Send payment through A -> B but A is maliciously
6224 // sending a probe payment (i.e less than expected value0
6225 // to B, B should refuse payment.
6227 let nodes = create_network(2, &[None, None, None]);
6229 // Create some initial channels
6230 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6232 let (payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 10_000);
6234 // Node 3 is expecting payment of 100_000 but receive 10_000,
6235 // fail htlc like we didn't know the preimage.
6236 nodes[1].node.claim_funds(payment_preimage, 100_000);
6237 nodes[1].node.process_pending_htlc_forwards();
6239 let events = nodes[1].node.get_and_clear_pending_msg_events();
6240 assert_eq!(events.len(), 1);
6241 let (update_fail_htlc, commitment_signed) = match events[0] {
6242 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 } } => {
6243 assert!(update_add_htlcs.is_empty());
6244 assert!(update_fulfill_htlcs.is_empty());
6245 assert_eq!(update_fail_htlcs.len(), 1);
6246 assert!(update_fail_malformed_htlcs.is_empty());
6247 assert!(update_fee.is_none());
6248 (update_fail_htlcs[0].clone(), commitment_signed)
6250 _ => panic!("Unexpected event"),
6252 check_added_monitors!(nodes[1], 1);
6254 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
6255 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
6257 let events = nodes[0].node.get_and_clear_pending_events();
6258 assert_eq!(events.len(), 1);
6259 if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code } = &events[0] {
6260 assert_eq!(*rejected_by_dest, true);
6261 assert_eq!(error_code.unwrap(), 0x4000|15);
6263 panic!("Unexpected event");
6265 nodes[1].node.get_and_clear_pending_events();
6269 fn test_announce_disable_channels() {
6270 // Create 2 channels between A and B. Disconnect B. Call timer_chan_freshness_every_min and check for generated
6271 // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
6273 let nodes = create_network(2, &[None, None]);
6275 let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
6276 let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
6277 let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
6280 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6281 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6283 nodes[0].node.timer_chan_freshness_every_min(); // dirty -> stagged
6284 nodes[0].node.timer_chan_freshness_every_min(); // staged -> fresh
6285 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
6286 assert_eq!(msg_events.len(), 3);
6287 for e in msg_events {
6289 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
6290 let short_id = msg.contents.short_channel_id;
6291 // Check generated channel_update match list in PendingChannelUpdate
6292 if short_id != short_id_1 && short_id != short_id_2 && short_id != short_id_3 {
6293 panic!("Generated ChannelUpdate for wrong chan!");
6296 _ => panic!("Unexpected event"),
6300 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
6301 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6302 assert_eq!(reestablish_1.len(), 3);
6303 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
6304 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6305 assert_eq!(reestablish_2.len(), 3);
6307 // Reestablish chan_1
6308 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6309 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6310 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6311 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6312 // Reestablish chan_2
6313 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
6314 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6315 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
6316 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6317 // Reestablish chan_3
6318 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
6319 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6320 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
6321 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6323 nodes[0].node.timer_chan_freshness_every_min();
6324 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6328 fn test_bump_penalty_txn_on_revoked_commitment() {
6329 // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
6330 // we're able to claim outputs on revoked commitment transaction before timelocks expiration
6332 let nodes = create_network(2, &[None, None]);
6334 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
6335 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
6336 let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 3000000, 30).unwrap();
6337 send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
6339 let revoked_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
6340 // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
6341 assert_eq!(revoked_txn[0].output.len(), 4);
6342 assert_eq!(revoked_txn[0].input.len(), 1);
6343 assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
6344 let revoked_txid = revoked_txn[0].txid();
6346 let mut penalty_sum = 0;
6347 for outp in revoked_txn[0].output.iter() {
6348 if outp.script_pubkey.is_v0_p2wsh() {
6349 penalty_sum += outp.value;
6353 // Connect blocks to change height_timer range to see if we use right soonest_timelock
6354 let header_114 = connect_blocks(&nodes[1].block_notifier, 114, 0, false, Default::default());
6356 // Actually revoke tx by claiming a HTLC
6357 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
6358 let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6359 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_txn[0].clone()] }, 115);
6361 // One or more justice tx should have been broadcast, check it
6365 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6366 assert_eq!(node_txn.len(), 4); // justice tx (broadcasted from ChannelMonitor) * 2 (block-reparsing) + local commitment tx + local HTLC-timeout (broadcasted from ChannelManager)
6367 assert_eq!(node_txn[0], node_txn[3]);
6368 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
6369 assert_eq!(node_txn[0].output.len(), 1);
6370 check_spends!(node_txn[0], revoked_txn[0].clone());
6371 let fee_1 = penalty_sum - node_txn[0].output[0].value;
6372 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
6373 penalty_1 = node_txn[0].txid();
6377 // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
6378 let header = connect_blocks(&nodes[1].block_notifier, 3, 115, true, header.bitcoin_hash());
6379 let mut penalty_2 = penalty_1;
6380 let mut feerate_2 = 0;
6382 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6383 assert_eq!(node_txn.len(), 1);
6384 if node_txn[0].input[0].previous_output.txid == revoked_txid {
6385 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
6386 assert_eq!(node_txn[0].output.len(), 1);
6387 check_spends!(node_txn[0], revoked_txn[0].clone());
6388 penalty_2 = node_txn[0].txid();
6389 // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
6390 assert_ne!(penalty_2, penalty_1);
6391 let fee_2 = penalty_sum - node_txn[0].output[0].value;
6392 feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
6393 // Verify 25% bump heuristic
6394 assert!(feerate_2 * 100 >= feerate_1 * 125);
6398 assert_ne!(feerate_2, 0);
6400 // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
6401 connect_blocks(&nodes[1].block_notifier, 3, 118, true, header);
6403 let mut feerate_3 = 0;
6405 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6406 assert_eq!(node_txn.len(), 1);
6407 if node_txn[0].input[0].previous_output.txid == revoked_txid {
6408 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
6409 assert_eq!(node_txn[0].output.len(), 1);
6410 check_spends!(node_txn[0], revoked_txn[0].clone());
6411 penalty_3 = node_txn[0].txid();
6412 // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
6413 assert_ne!(penalty_3, penalty_2);
6414 let fee_3 = penalty_sum - node_txn[0].output[0].value;
6415 feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
6416 // Verify 25% bump heuristic
6417 assert!(feerate_3 * 100 >= feerate_2 * 125);
6421 assert_ne!(feerate_3, 0);
6423 nodes[1].node.get_and_clear_pending_events();
6424 nodes[1].node.get_and_clear_pending_msg_events();
6428 fn test_bump_penalty_txn_on_revoked_htlcs() {
6429 // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
6430 // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
6432 let nodes = create_network(2, &[None, None]);
6434 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
6435 // Lock HTLC in both directions
6436 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3_000_000).0;
6437 route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
6439 let revoked_local_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
6440 assert_eq!(revoked_local_txn[0].input.len(), 1);
6441 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
6443 // Revoke local commitment tx
6444 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
6446 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6447 // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
6448 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
6449 check_closed_broadcast!(nodes[1], false);
6451 let mut received = ::std::usize::MAX;
6452 let mut offered = ::std::usize::MAX;
6453 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6454 assert_eq!(revoked_htlc_txn.len(), 6);
6455 if revoked_htlc_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
6456 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
6457 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
6458 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
6459 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
6460 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0].clone());
6463 } else if revoked_htlc_txn[1].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
6464 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
6465 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0].clone());
6466 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
6467 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
6468 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
6473 // Broadcast set of revoked txn on A
6474 let header_128 = connect_blocks(&nodes[0].block_notifier, 128, 0, true, header.bitcoin_hash());
6475 let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6476 nodes[0].block_notifier.block_connected(&Block { header: header_129, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone(), revoked_htlc_txn[1].clone()] }, 129);
6482 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6483 assert_eq!(node_txn.len(), 9); // 3 penalty txn on revoked commitment tx * 2 (block-rescan) + A commitment tx + 2 penalty tnx on revoked HTLC txn
6484 // Verify claim tx are spending revoked HTLC txn
6485 assert_eq!(node_txn[7].input.len(), 1);
6486 assert_eq!(node_txn[7].output.len(), 1);
6487 check_spends!(node_txn[7], revoked_htlc_txn[0].clone());
6488 first = node_txn[7].txid();
6489 assert_eq!(node_txn[8].input.len(), 1);
6490 assert_eq!(node_txn[8].output.len(), 1);
6491 check_spends!(node_txn[8], revoked_htlc_txn[1].clone());
6492 second = node_txn[8].txid();
6493 // Store both feerates for later comparison
6494 let fee_1 = revoked_htlc_txn[0].output[0].value - node_txn[7].output[0].value;
6495 feerate_1 = fee_1 * 1000 / node_txn[7].get_weight() as u64;
6496 let fee_2 = revoked_htlc_txn[1].output[0].value - node_txn[8].output[0].value;
6497 feerate_2 = fee_2 * 1000 / node_txn[8].get_weight() as u64;
6501 // Connect three more block to see if bumped penalty are issued for HTLC txn
6502 let header_132 = connect_blocks(&nodes[0].block_notifier, 3, 129, true, header_129.bitcoin_hash());
6504 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6505 assert_eq!(node_txn.len(), 5); // 2 bumped penalty txn on offered/received HTLC outputs of revoked commitment tx + 1 penalty tx on to_local of revoked commitment tx + 2 bumped penalty tx on revoked HTLC txn
6507 check_spends!(node_txn[0], revoked_local_txn[0].clone());
6508 check_spends!(node_txn[1], revoked_local_txn[0].clone());
6510 let mut penalty_local = ::std::usize::MAX;
6511 let mut penalty_offered = ::std::usize::MAX;
6512 let mut penalty_received = ::std::usize::MAX;
6515 let iter_txn = node_txn[2..].iter();
6516 for (i, tx) in iter_txn.enumerate() {
6517 if tx.input[0].previous_output.txid == revoked_local_txn[0].txid() {
6518 penalty_local = 2 + i;
6519 } else if tx.input[0].previous_output.txid == revoked_htlc_txn[offered].txid() {
6520 penalty_offered = 2+ i;
6521 } else if tx.input[0].previous_output.txid == revoked_htlc_txn[received].txid() {
6522 penalty_received = 2 + i;
6526 check_spends!(node_txn[penalty_local], revoked_local_txn[0].clone());
6528 assert_eq!(node_txn[penalty_received].input.len(), 1);
6529 assert_eq!(node_txn[penalty_received].output.len(), 1);
6530 assert_eq!(node_txn[penalty_offered].input.len(), 1);
6531 assert_eq!(node_txn[penalty_offered].output.len(), 1);
6532 // Verify bumped tx is different and 25% bump heuristic
6533 check_spends!(node_txn[penalty_offered], revoked_htlc_txn[offered].clone());
6534 assert_ne!(first, node_txn[penalty_offered].txid());
6535 let fee = revoked_htlc_txn[offered].output[0].value - node_txn[penalty_offered].output[0].value;
6536 let new_feerate = fee * 1000 / node_txn[penalty_offered].get_weight() as u64;
6537 assert!(new_feerate * 100 > feerate_1 * 125);
6539 check_spends!(node_txn[penalty_received], revoked_htlc_txn[received].clone());
6540 assert_ne!(second, node_txn[penalty_received].txid());
6541 let fee = revoked_htlc_txn[received].output[0].value - node_txn[penalty_received].output[0].value;
6542 let new_feerate = fee * 1000 / node_txn[penalty_received].get_weight() as u64;
6543 assert!(new_feerate * 100 > feerate_2 * 125);
6544 let txn = vec![node_txn[2].clone(), node_txn[3].clone(), node_txn[4].clone()];
6548 // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
6549 let header_133 = BlockHeader { version: 0x20000000, prev_blockhash: header_132, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6550 nodes[0].block_notifier.block_connected(&Block { header: header_133, txdata: node_txn }, 133);
6551 let header_140 = connect_blocks(&nodes[0].block_notifier, 6, 134, true, header_133.bitcoin_hash());
6553 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6557 // Connect few more blocks and check only penalty transaction for to_local output have been issued
6558 connect_blocks(&nodes[0].block_notifier, 7, 140, true, header_140);
6560 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6561 assert_eq!(node_txn.len(), 2); //TODO: should be zero when we fix check_spend_remote_htlc
6564 check_closed_broadcast!(nodes[0], false);
6568 fn test_bump_penalty_txn_on_remote_commitment() {
6569 // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
6570 // we're able to claim outputs on remote commitment transaction before timelocks expiration
6573 // Provide preimage for one
6574 // Check aggregation
6576 let nodes = create_network(2, &[None, None]);
6578 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
6579 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
6580 route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
6582 // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
6583 let remote_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
6584 assert_eq!(remote_txn[0].output.len(), 4);
6585 assert_eq!(remote_txn[0].input.len(), 1);
6586 assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
6588 // Claim a HTLC without revocation (provide B monitor with preimage)
6589 nodes[1].node.claim_funds(payment_preimage, 3_000_000);
6590 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6591 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
6592 check_added_monitors!(nodes[1], 1);
6594 // One or more claim tx should have been broadcast, check it
6597 let feerate_timeout;
6598 let feerate_preimage;
6600 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6601 assert_eq!(node_txn.len(), 7); // 2 * claim tx (broadcasted from ChannelMonitor) * 2 (block-reparsing) + local commitment tx + local HTLC-timeout + HTLC-success (broadcasted from ChannelManager)
6602 assert_eq!(node_txn[0], node_txn[5]);
6603 assert_eq!(node_txn[1], node_txn[6]);
6604 assert_eq!(node_txn[0].input.len(), 1);
6605 assert_eq!(node_txn[1].input.len(), 1);
6606 check_spends!(node_txn[0], remote_txn[0].clone());
6607 check_spends!(node_txn[1], remote_txn[0].clone());
6608 check_spends!(node_txn[2], chan.3);
6609 check_spends!(node_txn[3], node_txn[2]);
6610 check_spends!(node_txn[4], node_txn[2]);
6611 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
6612 timeout = node_txn[0].txid();
6613 let index = node_txn[0].input[0].previous_output.vout;
6614 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
6615 feerate_timeout = fee * 1000 / node_txn[0].get_weight() as u64;
6617 preimage = node_txn[1].txid();
6618 let index = node_txn[1].input[0].previous_output.vout;
6619 let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
6620 feerate_preimage = fee * 1000 / node_txn[1].get_weight() as u64;
6622 timeout = node_txn[1].txid();
6623 let index = node_txn[1].input[0].previous_output.vout;
6624 let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
6625 feerate_timeout = fee * 1000 / node_txn[1].get_weight() as u64;
6627 preimage = node_txn[0].txid();
6628 let index = node_txn[0].input[0].previous_output.vout;
6629 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
6630 feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
6634 assert_ne!(feerate_timeout, 0);
6635 assert_ne!(feerate_preimage, 0);
6637 // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
6638 connect_blocks(&nodes[1].block_notifier, 15, 1, true, header.bitcoin_hash());
6640 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6641 assert_eq!(node_txn.len(), 2);
6642 assert_eq!(node_txn[0].input.len(), 1);
6643 assert_eq!(node_txn[1].input.len(), 1);
6644 check_spends!(node_txn[0], remote_txn[0].clone());
6645 check_spends!(node_txn[1], remote_txn[0].clone());
6646 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
6647 let index = node_txn[0].input[0].previous_output.vout;
6648 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
6649 let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
6650 assert!(new_feerate * 100 > feerate_timeout * 125);
6651 assert_ne!(timeout, node_txn[0].txid());
6653 let index = node_txn[1].input[0].previous_output.vout;
6654 let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
6655 let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
6656 assert!(new_feerate * 100 > feerate_preimage * 125);
6657 assert_ne!(preimage, node_txn[1].txid());
6659 let index = node_txn[1].input[0].previous_output.vout;
6660 let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
6661 let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
6662 assert!(new_feerate * 100 > feerate_timeout * 125);
6663 assert_ne!(timeout, node_txn[1].txid());
6665 let index = node_txn[0].input[0].previous_output.vout;
6666 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
6667 let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
6668 assert!(new_feerate * 100 > feerate_preimage * 125);
6669 assert_ne!(preimage, node_txn[0].txid());
6674 nodes[1].node.get_and_clear_pending_events();
6675 nodes[1].node.get_and_clear_pending_msg_events();
6679 fn test_set_outpoints_partial_claiming() {
6680 // - remote party claim tx, new bump tx
6681 // - disconnect remote claiming tx, new bump
6682 // - disconnect tx, see no tx anymore
6683 let nodes = create_network(2, &[None, None]);
6685 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
6686 let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
6687 let payment_preimage_2 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
6689 // Remote commitment txn with 4 outputs: to_local, to_remote, 2 outgoing HTLC
6690 let remote_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
6691 assert_eq!(remote_txn.len(), 3);
6692 assert_eq!(remote_txn[0].output.len(), 4);
6693 assert_eq!(remote_txn[0].input.len(), 1);
6694 assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
6695 check_spends!(remote_txn[1], remote_txn[0].clone());
6696 check_spends!(remote_txn[2], remote_txn[0].clone());
6698 // Connect blocks on node A to advance height towards TEST_FINAL_CLTV
6699 let prev_header_100 = connect_blocks(&nodes[1].block_notifier, 100, 0, false, Default::default());
6700 // Provide node A with both preimage
6701 nodes[0].node.claim_funds(payment_preimage_1, 3_000_000);
6702 nodes[0].node.claim_funds(payment_preimage_2, 3_000_000);
6703 check_added_monitors!(nodes[0], 2);
6704 nodes[0].node.get_and_clear_pending_events();
6705 nodes[0].node.get_and_clear_pending_msg_events();
6707 // Connect blocks on node A commitment transaction
6708 let header = BlockHeader { version: 0x20000000, prev_blockhash: prev_header_100, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6709 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 101);
6710 // Verify node A broadcast tx claiming both HTLCs
6712 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6713 assert_eq!(node_txn.len(), 5);
6714 assert_eq!(node_txn[0], node_txn[4]);
6715 check_spends!(node_txn[0], remote_txn[0].clone());
6716 check_spends!(node_txn[1], chan.3.clone());
6717 check_spends!(node_txn[2], node_txn[1]);
6718 check_spends!(node_txn[3], node_txn[1]);
6719 assert_eq!(node_txn[0].input.len(), 2);
6722 nodes[0].node.get_and_clear_pending_msg_events();
6724 // Connect blocks on node B
6725 connect_blocks(&nodes[1].block_notifier, 135, 0, false, Default::default());
6726 // Verify node B broadcast 2 HTLC-timeout txn
6727 let partial_claim_tx = {
6728 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6729 assert_eq!(node_txn.len(), 3);
6730 check_spends!(node_txn[1], node_txn[0].clone());
6731 check_spends!(node_txn[2], node_txn[0].clone());
6732 assert_eq!(node_txn[1].input.len(), 1);
6733 assert_eq!(node_txn[2].input.len(), 1);
6736 nodes[1].node.get_and_clear_pending_msg_events();
6738 // Broadcast partial claim on node A, should regenerate a claiming tx with HTLC dropped
6739 let header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6740 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![partial_claim_tx.clone()] }, 102);
6742 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6743 assert_eq!(node_txn.len(), 1);
6744 check_spends!(node_txn[0], remote_txn[0].clone());
6745 assert_eq!(node_txn[0].input.len(), 1); //dropped HTLC
6748 nodes[0].node.get_and_clear_pending_msg_events();
6750 // Disconnect last block on node A, should regenerate a claiming tx with HTLC dropped
6751 nodes[0].block_notifier.block_disconnected(&header, 102);
6753 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6754 assert_eq!(node_txn.len(), 1);
6755 check_spends!(node_txn[0], remote_txn[0].clone());
6756 assert_eq!(node_txn[0].input.len(), 2); //resurrected HTLC
6760 //// Disconnect one more block and then reconnect multiple no transaction should be generated
6761 nodes[0].block_notifier.block_disconnected(&header, 101);
6762 connect_blocks(&nodes[1].block_notifier, 15, 101, false, prev_header_100);
6764 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6765 assert_eq!(node_txn.len(), 0);
6771 fn test_bump_txn_sanitize_tracking_maps() {
6772 // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
6773 // verify we clean then right after expiration of ANTI_REORG_DELAY.
6775 let nodes = create_network(2, &[None, None]);
6777 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
6778 // Lock HTLC in both directions
6779 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
6780 route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
6782 let revoked_local_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
6783 assert_eq!(revoked_local_txn[0].input.len(), 1);
6784 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
6786 // Revoke local commitment tx
6787 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 9_000_000);
6789 // Broadcast set of revoked txn on A
6790 let header_128 = connect_blocks(&nodes[0].block_notifier, 128, 0, false, Default::default());
6791 let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6792 nodes[0].block_notifier.block_connected(&Block { header: header_129, txdata: vec![revoked_local_txn[0].clone()] }, 129);
6793 check_closed_broadcast!(nodes[0], false);
6795 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6796 assert_eq!(node_txn.len(), 7);
6797 check_spends!(node_txn[0], revoked_local_txn[0].clone());
6798 check_spends!(node_txn[1], revoked_local_txn[0].clone());
6799 check_spends!(node_txn[2], revoked_local_txn[0].clone());
6800 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
6804 let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6805 nodes[0].block_notifier.block_connected(&Block { header: header_130, txdata: penalty_txn }, 130);
6806 connect_blocks(&nodes[0].block_notifier, 5, 130, false, header_130.bitcoin_hash());
6808 let monitors = nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap();
6809 if let Some(monitor) = monitors.get(&OutPoint::new(chan.3.txid(), 0)) {
6810 assert!(monitor.pending_claim_requests.is_empty());
6811 assert!(monitor.claimable_outpoints.is_empty());