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, NodeFeatures};
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(), &msgs::Init { features: InitFeatures::empty() });
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(), &msgs::Init { features: InitFeatures::empty() });
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(), &msgs::Init { features: InitFeatures::empty() });
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(), &msgs::Init { features: InitFeatures::empty() });
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 node_features: NodeFeatures::empty(),
1033 short_channel_id: chan_2.0.contents.short_channel_id,
1034 channel_features: ChannelFeatures::empty(),
1036 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
1038 hops.push(RouteHop {
1039 pubkey: nodes[3].node.get_our_node_id(),
1040 node_features: NodeFeatures::empty(),
1041 short_channel_id: chan_3.0.contents.short_channel_id,
1042 channel_features: ChannelFeatures::empty(),
1044 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
1046 hops.push(RouteHop {
1047 pubkey: nodes[1].node.get_our_node_id(),
1048 node_features: NodeFeatures::empty(),
1049 short_channel_id: chan_4.0.contents.short_channel_id,
1050 channel_features: ChannelFeatures::empty(),
1052 cltv_expiry_delta: TEST_FINAL_CLTV,
1054 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;
1055 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;
1056 let payment_preimage_1 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
1058 let mut hops = Vec::with_capacity(3);
1059 hops.push(RouteHop {
1060 pubkey: nodes[3].node.get_our_node_id(),
1061 node_features: NodeFeatures::empty(),
1062 short_channel_id: chan_4.0.contents.short_channel_id,
1063 channel_features: ChannelFeatures::empty(),
1065 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
1067 hops.push(RouteHop {
1068 pubkey: nodes[2].node.get_our_node_id(),
1069 node_features: NodeFeatures::empty(),
1070 short_channel_id: chan_3.0.contents.short_channel_id,
1071 channel_features: ChannelFeatures::empty(),
1073 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
1075 hops.push(RouteHop {
1076 pubkey: nodes[1].node.get_our_node_id(),
1077 node_features: NodeFeatures::empty(),
1078 short_channel_id: chan_2.0.contents.short_channel_id,
1079 channel_features: ChannelFeatures::empty(),
1081 cltv_expiry_delta: TEST_FINAL_CLTV,
1083 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;
1084 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;
1085 let payment_hash_2 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1087 // Claim the rebalances...
1088 fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1089 claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1, 1_000_000);
1091 // Add a duplicate new channel from 2 to 4
1092 let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::supported(), InitFeatures::supported());
1094 // Send some payments across both channels
1095 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1096 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1097 let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1100 route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
1101 let events = nodes[0].node.get_and_clear_pending_msg_events();
1102 assert_eq!(events.len(), 0);
1103 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);
1105 //TODO: Test that routes work again here as we've been notified that the channel is full
1107 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3, 3_000_000);
1108 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4, 3_000_000);
1109 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5, 3_000_000);
1111 // Close down the channels...
1112 close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1113 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1114 close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1115 close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1116 close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
1120 fn holding_cell_htlc_counting() {
1121 // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1122 // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1123 // commitment dance rounds.
1124 let mut nodes = create_network(3, &[None, None, None]);
1125 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1126 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
1128 let mut payments = Vec::new();
1129 for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1130 let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
1131 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1132 nodes[1].node.send_payment(route, payment_hash).unwrap();
1133 payments.push((payment_preimage, payment_hash));
1135 check_added_monitors!(nodes[1], 1);
1137 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1138 assert_eq!(events.len(), 1);
1139 let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1140 assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1142 // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1143 // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1145 let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
1146 let (_, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
1147 if let APIError::ChannelUnavailable { err } = nodes[1].node.send_payment(route, payment_hash_1).unwrap_err() {
1148 assert_eq!(err, "Cannot push more than their max accepted HTLCs");
1149 } else { panic!("Unexpected event"); }
1150 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1151 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1153 // This should also be true if we try to forward a payment.
1154 let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
1155 let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
1156 nodes[0].node.send_payment(route, payment_hash_2).unwrap();
1157 check_added_monitors!(nodes[0], 1);
1159 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1160 assert_eq!(events.len(), 1);
1161 let payment_event = SendEvent::from_event(events.pop().unwrap());
1162 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1164 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1165 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1166 // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1167 // fails), the second will process the resulting failure and fail the HTLC backward.
1168 expect_pending_htlcs_forwardable!(nodes[1]);
1169 expect_pending_htlcs_forwardable!(nodes[1]);
1170 check_added_monitors!(nodes[1], 1);
1172 let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1173 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1174 commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1176 let events = nodes[0].node.get_and_clear_pending_msg_events();
1177 assert_eq!(events.len(), 1);
1179 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
1180 assert_eq!(msg.contents.short_channel_id, chan_2.0.contents.short_channel_id);
1182 _ => panic!("Unexpected event"),
1185 let events = nodes[0].node.get_and_clear_pending_events();
1186 assert_eq!(events.len(), 1);
1188 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
1189 assert_eq!(payment_hash, payment_hash_2);
1190 assert!(!rejected_by_dest);
1192 _ => panic!("Unexpected event"),
1195 // Now forward all the pending HTLCs and claim them back
1196 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1197 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1198 check_added_monitors!(nodes[2], 1);
1200 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1201 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1202 check_added_monitors!(nodes[1], 1);
1203 let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1205 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1206 check_added_monitors!(nodes[1], 1);
1207 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1209 for ref update in as_updates.update_add_htlcs.iter() {
1210 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1212 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1213 check_added_monitors!(nodes[2], 1);
1214 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1215 check_added_monitors!(nodes[2], 1);
1216 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1218 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1219 check_added_monitors!(nodes[1], 1);
1220 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1221 check_added_monitors!(nodes[1], 1);
1222 let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1224 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1225 check_added_monitors!(nodes[2], 1);
1227 expect_pending_htlcs_forwardable!(nodes[2]);
1229 let events = nodes[2].node.get_and_clear_pending_events();
1230 assert_eq!(events.len(), payments.len());
1231 for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1233 &Event::PaymentReceived { ref payment_hash, .. } => {
1234 assert_eq!(*payment_hash, *hash);
1236 _ => panic!("Unexpected event"),
1240 for (preimage, _) in payments.drain(..) {
1241 claim_payment(&nodes[1], &[&nodes[2]], preimage, 100_000);
1244 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000, 1_000_000);
1248 fn duplicate_htlc_test() {
1249 // Test that we accept duplicate payment_hash HTLCs across the network and that
1250 // claiming/failing them are all separate and don't affect each other
1251 let mut nodes = create_network(6, &[None, None, None, None, None, None]);
1253 // Create some initial channels to route via 3 to 4/5 from 0/1/2
1254 create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::supported(), InitFeatures::supported());
1255 create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::supported(), InitFeatures::supported());
1256 create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
1257 create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::supported(), InitFeatures::supported());
1258 create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::supported(), InitFeatures::supported());
1260 let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1262 *nodes[0].network_payment_count.borrow_mut() -= 1;
1263 assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1265 *nodes[0].network_payment_count.borrow_mut() -= 1;
1266 assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1268 claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage, 1_000_000);
1269 fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1270 claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage, 1_000_000);
1274 fn test_duplicate_htlc_different_direction_onchain() {
1275 // Test that ChannelMonitor doesn't generate 2 preimage txn
1276 // when we have 2 HTLCs with same preimage that go across a node
1277 // in opposite directions.
1278 let nodes = create_network(2, &[None, None]);
1280 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1283 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
1285 let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1287 let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 800_000, TEST_FINAL_CLTV).unwrap();
1288 send_along_route_with_hash(&nodes[1], route, &vec!(&nodes[0])[..], 800_000, payment_hash);
1290 // Provide preimage to node 0 by claiming payment
1291 nodes[0].node.claim_funds(payment_preimage, 800_000);
1292 check_added_monitors!(nodes[0], 1);
1294 // Broadcast node 1 commitment txn
1295 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();
1297 assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1298 let mut has_both_htlcs = 0; // check htlcs match ones committed
1299 for outp in remote_txn[0].output.iter() {
1300 if outp.value == 800_000 / 1000 {
1301 has_both_htlcs += 1;
1302 } else if outp.value == 900_000 / 1000 {
1303 has_both_htlcs += 1;
1306 assert_eq!(has_both_htlcs, 2);
1308 let header = BlockHeader { version: 0x2000_0000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1309 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
1311 // Check we only broadcast 1 timeout tx
1312 let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1313 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()) };
1314 assert_eq!(claim_txn.len(), 7);
1315 check_spends!(claim_txn[2], chan_1.3);
1316 check_spends!(claim_txn[3], claim_txn[2]);
1317 assert_eq!(claim_txn[0], claim_txn[5]);
1318 assert_eq!(claim_txn[1], claim_txn[6]);
1319 assert_eq!(htlc_pair.0.input.len(), 1);
1320 assert_eq!(htlc_pair.0.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1321 check_spends!(htlc_pair.0, remote_txn[0].clone());
1322 assert_eq!(htlc_pair.1.input.len(), 1);
1323 assert_eq!(htlc_pair.1.input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1324 check_spends!(htlc_pair.1, remote_txn[0].clone());
1326 let events = nodes[0].node.get_and_clear_pending_msg_events();
1327 assert_eq!(events.len(), 2);
1330 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1331 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, .. } } => {
1332 assert!(update_add_htlcs.is_empty());
1333 assert!(update_fail_htlcs.is_empty());
1334 assert_eq!(update_fulfill_htlcs.len(), 1);
1335 assert!(update_fail_malformed_htlcs.is_empty());
1336 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1338 _ => panic!("Unexpected event"),
1343 fn do_channel_reserve_test(test_recv: bool) {
1345 let mut nodes = create_network(3, &[None, None, None]);
1346 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1900, 1001, InitFeatures::supported(), InitFeatures::supported());
1347 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1900, 1001, InitFeatures::supported(), InitFeatures::supported());
1349 let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1350 let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1352 let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1353 let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1355 macro_rules! get_route_and_payment_hash {
1356 ($recv_value: expr) => {{
1357 let route = nodes[0].router.get_route(&nodes.last().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV).unwrap();
1358 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1359 (route, payment_hash, payment_preimage)
1363 macro_rules! expect_forward {
1365 let mut events = $node.node.get_and_clear_pending_msg_events();
1366 assert_eq!(events.len(), 1);
1367 check_added_monitors!($node, 1);
1368 let payment_event = SendEvent::from_event(events.remove(0));
1373 let feemsat = 239; // somehow we know?
1374 let total_fee_msat = (nodes.len() - 2) as u64 * 239;
1376 let recv_value_0 = stat01.their_max_htlc_value_in_flight_msat - total_fee_msat;
1378 // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1380 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_0 + 1);
1381 assert!(route.hops.iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1382 let err = nodes[0].node.send_payment(route, our_payment_hash).err().unwrap();
1384 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight our peer will accept"),
1385 _ => panic!("Unknown error variants"),
1387 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1388 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);
1391 let mut htlc_id = 0;
1392 // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1393 // nodes[0]'s wealth
1395 let amt_msat = recv_value_0 + total_fee_msat;
1396 if stat01.value_to_self_msat - amt_msat < stat01.channel_reserve_msat {
1399 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0, recv_value_0);
1402 let (stat01_, stat11_, stat12_, stat22_) = (
1403 get_channel_value_stat!(nodes[0], chan_1.2),
1404 get_channel_value_stat!(nodes[1], chan_1.2),
1405 get_channel_value_stat!(nodes[1], chan_2.2),
1406 get_channel_value_stat!(nodes[2], chan_2.2),
1409 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1410 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1411 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1412 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1413 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1417 let recv_value = stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat;
1418 // attempt to get channel_reserve violation
1419 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value + 1);
1420 let err = nodes[0].node.send_payment(route.clone(), our_payment_hash).err().unwrap();
1422 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over their reserve value"),
1423 _ => panic!("Unknown error variants"),
1425 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1426 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over their reserve value".to_string(), 1);
1429 // adding pending output
1430 let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat)/2;
1431 let amt_msat_1 = recv_value_1 + total_fee_msat;
1433 let (route_1, our_payment_hash_1, our_payment_preimage_1) = get_route_and_payment_hash!(recv_value_1);
1434 let payment_event_1 = {
1435 nodes[0].node.send_payment(route_1, our_payment_hash_1).unwrap();
1436 check_added_monitors!(nodes[0], 1);
1438 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1439 assert_eq!(events.len(), 1);
1440 SendEvent::from_event(events.remove(0))
1442 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1444 // channel reserve test with htlc pending output > 0
1445 let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat;
1447 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
1448 match nodes[0].node.send_payment(route, our_payment_hash).err().unwrap() {
1449 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over their reserve value"),
1450 _ => panic!("Unknown error variants"),
1452 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1453 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over their reserve value".to_string(), 2);
1457 // test channel_reserve test on nodes[1] side
1458 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
1460 // Need to manually create update_add_htlc message to go around the channel reserve check in send_htlc()
1461 let secp_ctx = Secp256k1::new();
1462 let session_priv = SecretKey::from_slice(&{
1463 let mut session_key = [0; 32];
1464 let mut rng = thread_rng();
1465 rng.fill_bytes(&mut session_key);
1467 }).expect("RNG is bad!");
1469 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1470 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route, &session_priv).unwrap();
1471 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
1472 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
1473 let msg = msgs::UpdateAddHTLC {
1474 channel_id: chan_1.2,
1476 amount_msat: htlc_msat,
1477 payment_hash: our_payment_hash,
1478 cltv_expiry: htlc_cltv,
1479 onion_routing_packet: onion_packet,
1483 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1484 // If we send a garbage message, the channel should get closed, making the rest of this test case fail.
1485 assert_eq!(nodes[1].node.list_channels().len(), 1);
1486 assert_eq!(nodes[1].node.list_channels().len(), 1);
1487 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1488 assert_eq!(err_msg.data, "Remote HTLC add would put them over their reserve value");
1493 // split the rest to test holding cell
1494 let recv_value_21 = recv_value_2/2;
1495 let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat;
1497 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
1498 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);
1501 // now see if they go through on both sides
1502 let (route_21, our_payment_hash_21, our_payment_preimage_21) = get_route_and_payment_hash!(recv_value_21);
1503 // but this will stuck in the holding cell
1504 nodes[0].node.send_payment(route_21, our_payment_hash_21).unwrap();
1505 check_added_monitors!(nodes[0], 0);
1506 let events = nodes[0].node.get_and_clear_pending_events();
1507 assert_eq!(events.len(), 0);
1509 // test with outbound holding cell amount > 0
1511 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_22+1);
1512 match nodes[0].node.send_payment(route, our_payment_hash).err().unwrap() {
1513 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over their reserve value"),
1514 _ => panic!("Unknown error variants"),
1516 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1517 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over their reserve value".to_string(), 3);
1520 let (route_22, our_payment_hash_22, our_payment_preimage_22) = get_route_and_payment_hash!(recv_value_22);
1521 // this will also stuck in the holding cell
1522 nodes[0].node.send_payment(route_22, our_payment_hash_22).unwrap();
1523 check_added_monitors!(nodes[0], 0);
1524 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1525 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1527 // flush the pending htlc
1528 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
1529 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1530 check_added_monitors!(nodes[1], 1);
1532 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
1533 check_added_monitors!(nodes[0], 1);
1534 let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1536 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
1537 let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1538 // No commitment_signed so get_event_msg's assert(len == 1) passes
1539 check_added_monitors!(nodes[0], 1);
1541 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
1542 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1543 check_added_monitors!(nodes[1], 1);
1545 expect_pending_htlcs_forwardable!(nodes[1]);
1547 let ref payment_event_11 = expect_forward!(nodes[1]);
1548 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
1549 commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
1551 expect_pending_htlcs_forwardable!(nodes[2]);
1552 expect_payment_received!(nodes[2], our_payment_hash_1, recv_value_1);
1554 // flush the htlcs in the holding cell
1555 assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
1556 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
1557 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
1558 commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
1559 expect_pending_htlcs_forwardable!(nodes[1]);
1561 let ref payment_event_3 = expect_forward!(nodes[1]);
1562 assert_eq!(payment_event_3.msgs.len(), 2);
1563 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
1564 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
1566 commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
1567 expect_pending_htlcs_forwardable!(nodes[2]);
1569 let events = nodes[2].node.get_and_clear_pending_events();
1570 assert_eq!(events.len(), 2);
1572 Event::PaymentReceived { ref payment_hash, amt } => {
1573 assert_eq!(our_payment_hash_21, *payment_hash);
1574 assert_eq!(recv_value_21, amt);
1576 _ => panic!("Unexpected event"),
1579 Event::PaymentReceived { ref payment_hash, amt } => {
1580 assert_eq!(our_payment_hash_22, *payment_hash);
1581 assert_eq!(recv_value_22, amt);
1583 _ => panic!("Unexpected event"),
1586 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1, recv_value_1);
1587 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21, recv_value_21);
1588 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22, recv_value_22);
1590 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);
1591 let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
1592 assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
1593 assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat);
1595 let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
1596 assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22);
1600 fn channel_reserve_test() {
1601 do_channel_reserve_test(false);
1602 do_channel_reserve_test(true);
1606 fn channel_reserve_in_flight_removes() {
1607 // In cases where one side claims an HTLC, it thinks it has additional available funds that it
1608 // can send to its counterparty, but due to update ordering, the other side may not yet have
1609 // considered those HTLCs fully removed.
1610 // This tests that we don't count HTLCs which will not be included in the next remote
1611 // commitment transaction towards the reserve value (as it implies no commitment transaction
1612 // will be generated which violates the remote reserve value).
1613 // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
1615 // * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
1616 // you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
1617 // you only consider the value of the first HTLC, it may not),
1618 // * start routing a third HTLC from A to B,
1619 // * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
1620 // the other claim in its holding cell, as it immediately goes into AwaitingRAA),
1621 // * deliver the first fulfill from B
1622 // * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
1624 // * deliver A's response CS and RAA.
1625 // This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
1626 // removed it fully. B now has the push_msat plus the first two HTLCs in value.
1627 // * Now B happily sends another HTLC, potentially violating its reserve value from A's point
1628 // of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
1629 let mut nodes = create_network(2, &[None, None]);
1630 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1632 let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
1633 // Route the first two HTLCs.
1634 let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
1635 let (payment_preimage_2, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
1637 // Start routing the third HTLC (this is just used to get everyone in the right state).
1638 let (payment_preimage_3, payment_hash_3) = get_payment_preimage_hash!(nodes[0]);
1640 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
1641 nodes[0].node.send_payment(route, payment_hash_3).unwrap();
1642 check_added_monitors!(nodes[0], 1);
1643 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1644 assert_eq!(events.len(), 1);
1645 SendEvent::from_event(events.remove(0))
1648 // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
1649 // initial fulfill/CS.
1650 assert!(nodes[1].node.claim_funds(payment_preimage_1, b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000));
1651 check_added_monitors!(nodes[1], 1);
1652 let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1654 // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
1655 // remove the second HTLC when we send the HTLC back from B to A.
1656 assert!(nodes[1].node.claim_funds(payment_preimage_2, 20000));
1657 check_added_monitors!(nodes[1], 1);
1658 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1660 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
1661 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
1662 check_added_monitors!(nodes[0], 1);
1663 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1664 expect_payment_sent!(nodes[0], payment_preimage_1);
1666 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
1667 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
1668 check_added_monitors!(nodes[1], 1);
1669 // B is already AwaitingRAA, so cant generate a CS here
1670 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1672 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1673 check_added_monitors!(nodes[1], 1);
1674 let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1676 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1677 check_added_monitors!(nodes[0], 1);
1678 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1680 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1681 check_added_monitors!(nodes[1], 1);
1682 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1684 // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
1685 // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
1686 // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
1687 // can no longer broadcast a commitment transaction with it and B has the preimage so can go
1688 // on-chain as necessary).
1689 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
1690 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
1691 check_added_monitors!(nodes[0], 1);
1692 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1693 expect_payment_sent!(nodes[0], payment_preimage_2);
1695 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1696 check_added_monitors!(nodes[1], 1);
1697 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1699 expect_pending_htlcs_forwardable!(nodes[1]);
1700 expect_payment_received!(nodes[1], payment_hash_3, 100000);
1702 // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
1703 // resolve the second HTLC from A's point of view.
1704 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1705 check_added_monitors!(nodes[0], 1);
1706 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1708 // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
1709 // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
1710 let (payment_preimage_4, payment_hash_4) = get_payment_preimage_hash!(nodes[1]);
1712 let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &[], 10000, TEST_FINAL_CLTV).unwrap();
1713 nodes[1].node.send_payment(route, payment_hash_4).unwrap();
1714 check_added_monitors!(nodes[1], 1);
1715 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1716 assert_eq!(events.len(), 1);
1717 SendEvent::from_event(events.remove(0))
1720 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
1721 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
1722 check_added_monitors!(nodes[0], 1);
1723 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1725 // Now just resolve all the outstanding messages/HTLCs for completeness...
1727 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1728 check_added_monitors!(nodes[1], 1);
1729 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1731 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1732 check_added_monitors!(nodes[1], 1);
1734 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1735 check_added_monitors!(nodes[0], 1);
1736 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1738 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1739 check_added_monitors!(nodes[1], 1);
1740 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1742 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1743 check_added_monitors!(nodes[0], 1);
1745 expect_pending_htlcs_forwardable!(nodes[0]);
1746 expect_payment_received!(nodes[0], payment_hash_4, 10000);
1748 claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4, 10_000);
1749 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3, 100_000);
1753 fn channel_monitor_network_test() {
1754 // Simple test which builds a network of ChannelManagers, connects them to each other, and
1755 // tests that ChannelMonitor is able to recover from various states.
1756 let nodes = create_network(5, &[None, None, None, None, None]);
1758 // Create some initial channels
1759 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1760 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
1761 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
1762 let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::supported(), InitFeatures::supported());
1764 // Rebalance the network a bit by relaying one payment through all the channels...
1765 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1766 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1767 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1768 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1770 // Simple case with no pending HTLCs:
1771 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
1773 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
1774 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1775 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
1776 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
1778 get_announce_close_broadcast_events(&nodes, 0, 1);
1779 assert_eq!(nodes[0].node.list_channels().len(), 0);
1780 assert_eq!(nodes[1].node.list_channels().len(), 1);
1782 // One pending HTLC is discarded by the force-close:
1783 let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
1785 // Simple case of one pending HTLC to HTLC-Timeout
1786 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
1788 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
1789 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1790 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
1791 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
1793 get_announce_close_broadcast_events(&nodes, 1, 2);
1794 assert_eq!(nodes[1].node.list_channels().len(), 0);
1795 assert_eq!(nodes[2].node.list_channels().len(), 1);
1797 macro_rules! claim_funds {
1798 ($node: expr, $prev_node: expr, $preimage: expr, $amount: expr) => {
1800 assert!($node.node.claim_funds($preimage, $amount));
1801 check_added_monitors!($node, 1);
1803 let events = $node.node.get_and_clear_pending_msg_events();
1804 assert_eq!(events.len(), 1);
1806 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
1807 assert!(update_add_htlcs.is_empty());
1808 assert!(update_fail_htlcs.is_empty());
1809 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
1811 _ => panic!("Unexpected event"),
1817 // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
1818 // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
1819 nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
1820 let node2_commitment_txid;
1822 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
1823 node2_commitment_txid = node_txn[0].txid();
1825 // Claim the payment on nodes[3], giving it knowledge of the preimage
1826 claim_funds!(nodes[3], nodes[2], payment_preimage_1, 3_000_000);
1828 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1829 nodes[3].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 1);
1831 check_preimage_claim(&nodes[3], &node_txn);
1833 get_announce_close_broadcast_events(&nodes, 2, 3);
1834 assert_eq!(nodes[2].node.list_channels().len(), 0);
1835 assert_eq!(nodes[3].node.list_channels().len(), 1);
1837 { // Cheat and reset nodes[4]'s height to 1
1838 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1839 nodes[4].block_notifier.block_connected(&Block { header, txdata: vec![] }, 1);
1842 assert_eq!(nodes[3].node.latest_block_height.load(Ordering::Acquire), 1);
1843 assert_eq!(nodes[4].node.latest_block_height.load(Ordering::Acquire), 1);
1844 // One pending HTLC to time out:
1845 let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
1846 // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
1850 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1851 nodes[3].block_notifier.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
1852 for i in 3..TEST_FINAL_CLTV + 2 + LATENCY_GRACE_PERIOD_BLOCKS + 1 {
1853 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1854 nodes[3].block_notifier.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
1857 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
1859 let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
1860 node_txn.retain(|tx| {
1861 if tx.input[0].previous_output.txid == node2_commitment_txid {
1867 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
1869 // Claim the payment on nodes[4], giving it knowledge of the preimage
1870 claim_funds!(nodes[4], nodes[3], payment_preimage_2, 3_000_000);
1872 header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1874 nodes[4].block_notifier.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
1875 for i in 3..TEST_FINAL_CLTV + 2 - CLTV_CLAIM_BUFFER + 1 {
1876 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1877 nodes[4].block_notifier.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
1880 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
1882 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1883 nodes[4].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, TEST_FINAL_CLTV - 5);
1885 check_preimage_claim(&nodes[4], &node_txn);
1887 get_announce_close_broadcast_events(&nodes, 3, 4);
1888 assert_eq!(nodes[3].node.list_channels().len(), 0);
1889 assert_eq!(nodes[4].node.list_channels().len(), 0);
1893 fn test_justice_tx() {
1894 // Test justice txn built on revoked HTLC-Success tx, against both sides
1895 let mut alice_config = UserConfig::default();
1896 alice_config.channel_options.announced_channel = true;
1897 alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
1898 alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
1899 let mut bob_config = UserConfig::default();
1900 bob_config.channel_options.announced_channel = true;
1901 bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
1902 bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
1903 let cfgs = [Some(alice_config), Some(bob_config)];
1904 let nodes = create_network(2, &cfgs);
1905 // Create some new channels:
1906 let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1908 // A pending HTLC which will be revoked:
1909 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
1910 // Get the will-be-revoked local txn from nodes[0]
1911 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();
1912 assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
1913 assert_eq!(revoked_local_txn[0].input.len(), 1);
1914 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
1915 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
1916 assert_eq!(revoked_local_txn[1].input.len(), 1);
1917 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
1918 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
1919 // Revoke the old state
1920 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 3_000_000);
1923 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1924 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
1926 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
1927 assert_eq!(node_txn.len(), 3);
1928 assert_eq!(node_txn.pop().unwrap(), node_txn[0]); // An outpoint registration will result in a 2nd block_connected
1929 assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
1931 check_spends!(node_txn[0], revoked_local_txn[0].clone());
1932 node_txn.swap_remove(0);
1933 node_txn.truncate(1);
1935 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
1937 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
1938 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
1939 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1940 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
1941 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
1943 get_announce_close_broadcast_events(&nodes, 0, 1);
1945 assert_eq!(nodes[0].node.list_channels().len(), 0);
1946 assert_eq!(nodes[1].node.list_channels().len(), 0);
1948 // We test justice_tx build by A on B's revoked HTLC-Success tx
1949 // Create some new channels:
1950 let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1952 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
1956 // A pending HTLC which will be revoked:
1957 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
1958 // Get the will-be-revoked local txn from B
1959 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();
1960 assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
1961 assert_eq!(revoked_local_txn[0].input.len(), 1);
1962 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
1963 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
1964 // Revoke the old state
1965 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4, 3_000_000);
1967 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1968 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
1970 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
1971 assert_eq!(node_txn.len(), 3);
1972 assert_eq!(node_txn.pop().unwrap(), node_txn[0]); // An outpoint registration will result in a 2nd block_connected
1973 assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
1975 check_spends!(node_txn[0], revoked_local_txn[0].clone());
1976 node_txn.swap_remove(0);
1978 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
1980 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
1981 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
1982 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1983 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
1984 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
1986 get_announce_close_broadcast_events(&nodes, 0, 1);
1987 assert_eq!(nodes[0].node.list_channels().len(), 0);
1988 assert_eq!(nodes[1].node.list_channels().len(), 0);
1992 fn revoked_output_claim() {
1993 // Simple test to ensure a node will claim a revoked output when a stale remote commitment
1994 // transaction is broadcast by its counterparty
1995 let nodes = create_network(2, &[None, None]);
1996 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1997 // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
1998 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();
1999 assert_eq!(revoked_local_txn.len(), 1);
2000 // Only output is the full channel value back to nodes[0]:
2001 assert_eq!(revoked_local_txn[0].output.len(), 1);
2002 // Send a payment through, updating everyone's latest commitment txn
2003 send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000, 5_000_000);
2005 // Inform nodes[1] that nodes[0] broadcast a stale tx
2006 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2007 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2008 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2009 assert_eq!(node_txn.len(), 3); // nodes[1] will broadcast justice tx twice, and its own local state once
2011 assert_eq!(node_txn[0], node_txn[2]);
2013 check_spends!(node_txn[0], revoked_local_txn[0].clone());
2014 check_spends!(node_txn[1], chan_1.3.clone());
2016 // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2017 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2018 get_announce_close_broadcast_events(&nodes, 0, 1);
2022 fn claim_htlc_outputs_shared_tx() {
2023 // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2024 let nodes = create_network(2, &[None, None]);
2026 // Create some new channel:
2027 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2029 // Rebalance the network to generate htlc in the two directions
2030 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2031 // 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
2032 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2033 let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2035 // Get the will-be-revoked local txn from node[0]
2036 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();
2037 assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2038 assert_eq!(revoked_local_txn[0].input.len(), 1);
2039 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2040 assert_eq!(revoked_local_txn[1].input.len(), 1);
2041 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2042 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2043 check_spends!(revoked_local_txn[1], revoked_local_txn[0].clone());
2045 //Revoke the old state
2046 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2049 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2050 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2051 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2052 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2054 let events = nodes[1].node.get_and_clear_pending_events();
2055 assert_eq!(events.len(), 1);
2057 Event::PaymentFailed { payment_hash, .. } => {
2058 assert_eq!(payment_hash, payment_hash_2);
2060 _ => panic!("Unexpected event"),
2063 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2064 assert_eq!(node_txn.len(), 4);
2066 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2067 check_spends!(node_txn[0], revoked_local_txn[0].clone());
2069 assert_eq!(node_txn[0], node_txn[3]); // justice tx is duplicated due to block re-scanning
2071 let mut witness_lens = BTreeSet::new();
2072 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2073 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2074 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2075 assert_eq!(witness_lens.len(), 3);
2076 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2077 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2078 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2080 // Next nodes[1] broadcasts its current local tx state:
2081 assert_eq!(node_txn[1].input.len(), 1);
2082 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2084 assert_eq!(node_txn[2].input.len(), 1);
2085 let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
2086 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2087 assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
2088 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2089 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
2091 get_announce_close_broadcast_events(&nodes, 0, 1);
2092 assert_eq!(nodes[0].node.list_channels().len(), 0);
2093 assert_eq!(nodes[1].node.list_channels().len(), 0);
2097 fn claim_htlc_outputs_single_tx() {
2098 // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2099 let nodes = create_network(2, &[None, None]);
2101 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2103 // Rebalance the network to generate htlc in the two directions
2104 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2105 // 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
2106 // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2107 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2108 let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2110 // Get the will-be-revoked local txn from node[0]
2111 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();
2113 //Revoke the old state
2114 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2117 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2118 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2119 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2120 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
2122 let events = nodes[1].node.get_and_clear_pending_events();
2123 assert_eq!(events.len(), 1);
2125 Event::PaymentFailed { payment_hash, .. } => {
2126 assert_eq!(payment_hash, payment_hash_2);
2128 _ => panic!("Unexpected event"),
2131 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2132 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)
2134 assert_eq!(node_txn[0], node_txn[7]);
2135 assert_eq!(node_txn[1], node_txn[8]);
2136 assert_eq!(node_txn[2], node_txn[9]);
2137 assert_eq!(node_txn[3], node_txn[10]);
2138 assert_eq!(node_txn[4], node_txn[11]);
2139 assert_eq!(node_txn[3], node_txn[5]); //local commitment tx + htlc timeout tx broadcasted by ChannelManger
2140 assert_eq!(node_txn[4], node_txn[6]);
2142 assert_eq!(node_txn[0].input.len(), 1);
2143 assert_eq!(node_txn[1].input.len(), 1);
2144 assert_eq!(node_txn[2].input.len(), 1);
2146 fn get_txout(out_point: &BitcoinOutPoint, tx: &Transaction) -> Option<TxOut> {
2147 if out_point.txid == tx.txid() {
2148 tx.output.get(out_point.vout as usize).cloned()
2153 node_txn[0].verify(|out|get_txout(out, &revoked_local_txn[0])).unwrap();
2154 node_txn[1].verify(|out|get_txout(out, &revoked_local_txn[0])).unwrap();
2155 node_txn[2].verify(|out|get_txout(out, &revoked_local_txn[0])).unwrap();
2157 let mut witness_lens = BTreeSet::new();
2158 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2159 witness_lens.insert(node_txn[1].input[0].witness.last().unwrap().len());
2160 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2161 assert_eq!(witness_lens.len(), 3);
2162 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2163 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2164 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2166 assert_eq!(node_txn[3].input.len(), 1);
2167 check_spends!(node_txn[3], chan_1.3.clone());
2169 assert_eq!(node_txn[4].input.len(), 1);
2170 let witness_script = node_txn[4].input[0].witness.last().unwrap();
2171 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2172 assert_eq!(node_txn[4].input[0].previous_output.txid, node_txn[3].txid());
2173 assert_ne!(node_txn[4].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2174 assert_ne!(node_txn[4].input[0].previous_output.txid, node_txn[1].input[0].previous_output.txid);
2176 get_announce_close_broadcast_events(&nodes, 0, 1);
2177 assert_eq!(nodes[0].node.list_channels().len(), 0);
2178 assert_eq!(nodes[1].node.list_channels().len(), 0);
2182 fn test_htlc_on_chain_success() {
2183 // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2184 // ChainWatchInterface and pass the preimage backward accordingly. So here we test that ChannelManager is
2185 // broadcasting the right event to other nodes in payment path.
2186 // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2187 // A --------------------> B ----------------------> C (preimage)
2188 // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2189 // commitment transaction was broadcast.
2190 // Then, B should learn the preimage from said transactions, attempting to claim backwards
2192 // B should be able to claim via preimage if A then broadcasts its local tx.
2193 // Finally, when A sees B's latest local commitment transaction it should be able to claim
2194 // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2195 // PaymentSent event).
2197 let nodes = create_network(3, &[None, None, None]);
2199 // Create some initial channels
2200 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2201 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2203 // Rebalance the network a bit by relaying one payment through all the channels...
2204 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2205 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2207 let (our_payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2208 let (our_payment_preimage_2, _payment_hash_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2209 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2211 // Broadcast legit commitment tx from C on B's chain
2212 // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2213 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();
2214 assert_eq!(commitment_tx.len(), 1);
2215 check_spends!(commitment_tx[0], chan_2.3.clone());
2216 nodes[2].node.claim_funds(our_payment_preimage, 3_000_000);
2217 nodes[2].node.claim_funds(our_payment_preimage_2, 3_000_000);
2218 check_added_monitors!(nodes[2], 2);
2219 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2220 assert!(updates.update_add_htlcs.is_empty());
2221 assert!(updates.update_fail_htlcs.is_empty());
2222 assert!(updates.update_fail_malformed_htlcs.is_empty());
2223 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2225 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2226 check_closed_broadcast!(nodes[2], false);
2227 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)
2228 assert_eq!(node_txn.len(), 7);
2229 assert_eq!(node_txn[0], node_txn[3]);
2230 assert_eq!(node_txn[1], node_txn[4]);
2231 assert_eq!(node_txn[0], node_txn[5]);
2232 assert_eq!(node_txn[1], node_txn[6]);
2233 assert_eq!(node_txn[2], commitment_tx[0]);
2234 check_spends!(node_txn[0], commitment_tx[0].clone());
2235 check_spends!(node_txn[1], commitment_tx[0].clone());
2236 assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2237 assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2238 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2239 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2240 assert_eq!(node_txn[0].lock_time, 0);
2241 assert_eq!(node_txn[1].lock_time, 0);
2243 // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2244 nodes[1].block_notifier.block_connected(&Block { header, txdata: node_txn}, 1);
2245 let events = nodes[1].node.get_and_clear_pending_msg_events();
2247 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
2248 assert_eq!(added_monitors.len(), 2);
2249 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2250 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2251 added_monitors.clear();
2253 assert_eq!(events.len(), 2);
2255 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2256 _ => panic!("Unexpected event"),
2259 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, .. } } => {
2260 assert!(update_add_htlcs.is_empty());
2261 assert!(update_fail_htlcs.is_empty());
2262 assert_eq!(update_fulfill_htlcs.len(), 1);
2263 assert!(update_fail_malformed_htlcs.is_empty());
2264 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2266 _ => panic!("Unexpected event"),
2268 macro_rules! check_tx_local_broadcast {
2269 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2270 // ChannelManager : 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor : 2 (timeout tx) * 2 (block-rescan)
2271 let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2272 assert_eq!(node_txn.len(), 7);
2273 assert_eq!(node_txn[0], node_txn[5]);
2274 assert_eq!(node_txn[1], node_txn[6]);
2275 check_spends!(node_txn[0], $commitment_tx.clone());
2276 check_spends!(node_txn[1], $commitment_tx.clone());
2277 assert_ne!(node_txn[0].lock_time, 0);
2278 assert_ne!(node_txn[1].lock_time, 0);
2280 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2281 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2282 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2283 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2285 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2286 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2287 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2288 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2290 check_spends!(node_txn[2], $chan_tx.clone());
2291 check_spends!(node_txn[3], node_txn[2].clone());
2292 check_spends!(node_txn[4], node_txn[2].clone());
2293 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), 71);
2294 assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2295 assert_eq!(node_txn[4].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2296 assert!(node_txn[3].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2297 assert!(node_txn[4].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2298 assert_ne!(node_txn[3].lock_time, 0);
2299 assert_ne!(node_txn[4].lock_time, 0);
2303 // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2304 // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2305 // timeout-claim of the output that nodes[2] just claimed via success.
2306 check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2308 // Broadcast legit commitment tx from A on B's chain
2309 // Broadcast preimage tx by B on offered output from A commitment tx on A's chain
2310 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();
2311 check_spends!(commitment_tx[0], chan_1.3.clone());
2312 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2313 check_closed_broadcast!(nodes[1], false);
2314 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)
2315 assert_eq!(node_txn.len(), 5);
2316 assert_eq!(node_txn[0], node_txn[4]);
2317 check_spends!(node_txn[0], commitment_tx[0].clone());
2318 assert_eq!(node_txn[0].input.len(), 2);
2319 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2320 assert_eq!(node_txn[0].input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2321 assert_eq!(node_txn[0].lock_time, 0);
2322 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2323 check_spends!(node_txn[1], chan_1.3.clone());
2324 assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2325 check_spends!(node_txn[2], node_txn[1]);
2326 check_spends!(node_txn[3], node_txn[1]);
2327 // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2328 // we already checked the same situation with A.
2330 // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2331 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone(), node_txn[0].clone()] }, 1);
2332 check_closed_broadcast!(nodes[0], false);
2333 let events = nodes[0].node.get_and_clear_pending_events();
2334 assert_eq!(events.len(), 2);
2335 let mut first_claimed = false;
2336 for event in events {
2338 Event::PaymentSent { payment_preimage } => {
2339 if payment_preimage == our_payment_preimage {
2340 assert!(!first_claimed);
2341 first_claimed = true;
2343 assert_eq!(payment_preimage, our_payment_preimage_2);
2346 _ => panic!("Unexpected event"),
2349 check_tx_local_broadcast!(nodes[0], true, commitment_tx[0], chan_1.3);
2353 fn test_htlc_on_chain_timeout() {
2354 // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2355 // ChainWatchInterface and timeout the HTLC backward accordingly. So here we test that ChannelManager is
2356 // broadcasting the right event to other nodes in payment path.
2357 // A ------------------> B ----------------------> C (timeout)
2358 // B's commitment tx C's commitment tx
2360 // B's HTLC timeout tx B's timeout tx
2362 let nodes = create_network(3, &[None, None, None]);
2364 // Create some intial channels
2365 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2366 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2368 // Rebalance the network a bit by relaying one payment thorugh all the channels...
2369 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2370 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2372 let (_payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2373 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2375 // Broadcast legit commitment tx from C on B's chain
2376 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();
2377 check_spends!(commitment_tx[0], chan_2.3.clone());
2378 nodes[2].node.fail_htlc_backwards(&payment_hash);
2379 check_added_monitors!(nodes[2], 0);
2380 expect_pending_htlcs_forwardable!(nodes[2]);
2381 check_added_monitors!(nodes[2], 1);
2383 let events = nodes[2].node.get_and_clear_pending_msg_events();
2384 assert_eq!(events.len(), 1);
2386 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, .. } } => {
2387 assert!(update_add_htlcs.is_empty());
2388 assert!(!update_fail_htlcs.is_empty());
2389 assert!(update_fulfill_htlcs.is_empty());
2390 assert!(update_fail_malformed_htlcs.is_empty());
2391 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2393 _ => panic!("Unexpected event"),
2395 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2396 check_closed_broadcast!(nodes[2], false);
2397 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2398 assert_eq!(node_txn.len(), 1);
2399 check_spends!(node_txn[0], chan_2.3.clone());
2400 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2402 // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2403 // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2404 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2407 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2408 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)
2409 assert_eq!(node_txn[0], node_txn[5]);
2410 assert_eq!(node_txn[1], node_txn[6]);
2411 assert_eq!(node_txn[2], node_txn[7]);
2412 check_spends!(node_txn[0], commitment_tx[0].clone());
2413 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2414 check_spends!(node_txn[1], chan_2.3.clone());
2415 check_spends!(node_txn[2], node_txn[1].clone());
2416 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2417 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2418 check_spends!(node_txn[3], chan_2.3.clone());
2419 check_spends!(node_txn[4], node_txn[3].clone());
2420 assert_eq!(node_txn[3].input[0].witness.clone().last().unwrap().len(), 71);
2421 assert_eq!(node_txn[4].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2422 timeout_tx = node_txn[0].clone();
2426 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![timeout_tx]}, 1);
2427 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2428 check_added_monitors!(nodes[1], 0);
2429 check_closed_broadcast!(nodes[1], false);
2431 expect_pending_htlcs_forwardable!(nodes[1]);
2432 check_added_monitors!(nodes[1], 1);
2433 let events = nodes[1].node.get_and_clear_pending_msg_events();
2434 assert_eq!(events.len(), 1);
2436 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, .. } } => {
2437 assert!(update_add_htlcs.is_empty());
2438 assert!(!update_fail_htlcs.is_empty());
2439 assert!(update_fulfill_htlcs.is_empty());
2440 assert!(update_fail_malformed_htlcs.is_empty());
2441 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2443 _ => panic!("Unexpected event"),
2445 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
2446 assert_eq!(node_txn.len(), 0);
2448 // Broadcast legit commitment tx from B on A's chain
2449 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();
2450 check_spends!(commitment_tx[0], chan_1.3.clone());
2452 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2453 check_closed_broadcast!(nodes[0], false);
2454 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
2455 assert_eq!(node_txn.len(), 4);
2456 assert_eq!(node_txn[0], node_txn[3]);
2457 check_spends!(node_txn[0], commitment_tx[0].clone());
2458 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2459 check_spends!(node_txn[1], chan_1.3.clone());
2460 check_spends!(node_txn[2], node_txn[1].clone());
2461 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2462 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2466 fn test_simple_commitment_revoked_fail_backward() {
2467 // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
2468 // and fail backward accordingly.
2470 let nodes = create_network(3, &[None, None, None]);
2472 // Create some initial channels
2473 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2474 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2476 let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2477 // Get the will-be-revoked local txn from nodes[2]
2478 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();
2479 // Revoke the old state
2480 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, 3_000_000);
2482 route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2484 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2485 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2486 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2487 check_added_monitors!(nodes[1], 0);
2488 check_closed_broadcast!(nodes[1], false);
2490 expect_pending_htlcs_forwardable!(nodes[1]);
2491 check_added_monitors!(nodes[1], 1);
2492 let events = nodes[1].node.get_and_clear_pending_msg_events();
2493 assert_eq!(events.len(), 1);
2495 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, .. } } => {
2496 assert!(update_add_htlcs.is_empty());
2497 assert_eq!(update_fail_htlcs.len(), 1);
2498 assert!(update_fulfill_htlcs.is_empty());
2499 assert!(update_fail_malformed_htlcs.is_empty());
2500 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2502 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
2503 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2505 let events = nodes[0].node.get_and_clear_pending_msg_events();
2506 assert_eq!(events.len(), 1);
2508 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
2509 _ => panic!("Unexpected event"),
2511 let events = nodes[0].node.get_and_clear_pending_events();
2512 assert_eq!(events.len(), 1);
2514 Event::PaymentFailed { .. } => {},
2515 _ => panic!("Unexpected event"),
2518 _ => panic!("Unexpected event"),
2522 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
2523 // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
2524 // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
2525 // commitment transaction anymore.
2526 // To do this, we have the peer which will broadcast a revoked commitment transaction send
2527 // a number of update_fail/commitment_signed updates without ever sending the RAA in
2528 // response to our commitment_signed. This is somewhat misbehavior-y, though not
2529 // technically disallowed and we should probably handle it reasonably.
2530 // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
2531 // failed/fulfilled backwards must be in at least one of the latest two remote commitment
2533 // * Once we move it out of our holding cell/add it, we will immediately include it in a
2534 // commitment_signed (implying it will be in the latest remote commitment transaction).
2535 // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
2536 // and once they revoke the previous commitment transaction (allowing us to send a new
2537 // commitment_signed) we will be free to fail/fulfill the HTLC backwards.
2538 let mut nodes = create_network(3, &[None, None, None]);
2540 // Create some initial channels
2541 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2542 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2544 let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], if no_to_remote { 10_000 } else { 3_000_000 });
2545 // Get the will-be-revoked local txn from nodes[2]
2546 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();
2547 assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
2548 // Revoke the old state
2549 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, if no_to_remote { 10_000 } else { 3_000_000});
2551 let value = if use_dust {
2552 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
2553 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
2554 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().our_dust_limit_satoshis * 1000
2557 let (_, first_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2558 let (_, second_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2559 let (_, third_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2561 assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash));
2562 expect_pending_htlcs_forwardable!(nodes[2]);
2563 check_added_monitors!(nodes[2], 1);
2564 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2565 assert!(updates.update_add_htlcs.is_empty());
2566 assert!(updates.update_fulfill_htlcs.is_empty());
2567 assert!(updates.update_fail_malformed_htlcs.is_empty());
2568 assert_eq!(updates.update_fail_htlcs.len(), 1);
2569 assert!(updates.update_fee.is_none());
2570 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2571 let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
2572 // Drop the last RAA from 3 -> 2
2574 assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash));
2575 expect_pending_htlcs_forwardable!(nodes[2]);
2576 check_added_monitors!(nodes[2], 1);
2577 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2578 assert!(updates.update_add_htlcs.is_empty());
2579 assert!(updates.update_fulfill_htlcs.is_empty());
2580 assert!(updates.update_fail_malformed_htlcs.is_empty());
2581 assert_eq!(updates.update_fail_htlcs.len(), 1);
2582 assert!(updates.update_fee.is_none());
2583 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2584 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2585 check_added_monitors!(nodes[1], 1);
2586 // Note that nodes[1] is in AwaitingRAA, so won't send a CS
2587 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2588 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2589 check_added_monitors!(nodes[2], 1);
2591 assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash));
2592 expect_pending_htlcs_forwardable!(nodes[2]);
2593 check_added_monitors!(nodes[2], 1);
2594 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2595 assert!(updates.update_add_htlcs.is_empty());
2596 assert!(updates.update_fulfill_htlcs.is_empty());
2597 assert!(updates.update_fail_malformed_htlcs.is_empty());
2598 assert_eq!(updates.update_fail_htlcs.len(), 1);
2599 assert!(updates.update_fee.is_none());
2600 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2601 // At this point first_payment_hash has dropped out of the latest two commitment
2602 // transactions that nodes[1] is tracking...
2603 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2604 check_added_monitors!(nodes[1], 1);
2605 // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
2606 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2607 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2608 check_added_monitors!(nodes[2], 1);
2610 // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
2611 // on nodes[2]'s RAA.
2612 let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
2613 let (_, fourth_payment_hash) = get_payment_preimage_hash!(nodes[0]);
2614 nodes[1].node.send_payment(route, fourth_payment_hash).unwrap();
2615 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2616 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2617 check_added_monitors!(nodes[1], 0);
2620 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
2621 // One monitor for the new revocation preimage, no second on as we won't generate a new
2622 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
2623 check_added_monitors!(nodes[1], 1);
2624 let events = nodes[1].node.get_and_clear_pending_events();
2625 assert_eq!(events.len(), 1);
2627 Event::PendingHTLCsForwardable { .. } => { },
2628 _ => panic!("Unexpected event"),
2630 // Deliberately don't process the pending fail-back so they all fail back at once after
2631 // block connection just like the !deliver_bs_raa case
2634 let mut failed_htlcs = HashSet::new();
2635 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2637 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2638 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2639 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2641 let events = nodes[1].node.get_and_clear_pending_events();
2642 assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
2644 Event::PaymentFailed { ref payment_hash, .. } => {
2645 assert_eq!(*payment_hash, fourth_payment_hash);
2647 _ => panic!("Unexpected event"),
2649 if !deliver_bs_raa {
2651 Event::PendingHTLCsForwardable { .. } => { },
2652 _ => panic!("Unexpected event"),
2655 nodes[1].node.process_pending_htlc_forwards();
2656 check_added_monitors!(nodes[1], 1);
2658 let events = nodes[1].node.get_and_clear_pending_msg_events();
2659 assert_eq!(events.len(), if deliver_bs_raa { 3 } else { 2 });
2660 match events[if deliver_bs_raa { 1 } else { 0 }] {
2661 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
2662 _ => panic!("Unexpected event"),
2666 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, .. } } => {
2667 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
2668 assert_eq!(update_add_htlcs.len(), 1);
2669 assert!(update_fulfill_htlcs.is_empty());
2670 assert!(update_fail_htlcs.is_empty());
2671 assert!(update_fail_malformed_htlcs.is_empty());
2673 _ => panic!("Unexpected event"),
2676 match events[if deliver_bs_raa { 2 } else { 1 }] {
2677 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, .. } } => {
2678 assert!(update_add_htlcs.is_empty());
2679 assert_eq!(update_fail_htlcs.len(), 3);
2680 assert!(update_fulfill_htlcs.is_empty());
2681 assert!(update_fail_malformed_htlcs.is_empty());
2682 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2684 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
2685 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
2686 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
2688 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2690 let events = nodes[0].node.get_and_clear_pending_msg_events();
2691 // If we delivered B's RAA we got an unknown preimage error, not something
2692 // that we should update our routing table for.
2693 assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
2694 for event in events {
2696 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
2697 _ => panic!("Unexpected event"),
2700 let events = nodes[0].node.get_and_clear_pending_events();
2701 assert_eq!(events.len(), 3);
2703 Event::PaymentFailed { ref payment_hash, .. } => {
2704 assert!(failed_htlcs.insert(payment_hash.0));
2706 _ => panic!("Unexpected event"),
2709 Event::PaymentFailed { ref payment_hash, .. } => {
2710 assert!(failed_htlcs.insert(payment_hash.0));
2712 _ => panic!("Unexpected event"),
2715 Event::PaymentFailed { ref payment_hash, .. } => {
2716 assert!(failed_htlcs.insert(payment_hash.0));
2718 _ => panic!("Unexpected event"),
2721 _ => panic!("Unexpected event"),
2724 assert!(failed_htlcs.contains(&first_payment_hash.0));
2725 assert!(failed_htlcs.contains(&second_payment_hash.0));
2726 assert!(failed_htlcs.contains(&third_payment_hash.0));
2730 fn test_commitment_revoked_fail_backward_exhaustive_a() {
2731 do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
2732 do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
2733 do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
2734 do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
2738 fn test_commitment_revoked_fail_backward_exhaustive_b() {
2739 do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
2740 do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
2741 do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
2742 do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
2746 fn test_htlc_ignore_latest_remote_commitment() {
2747 // Test that HTLC transactions spending the latest remote commitment transaction are simply
2748 // ignored if we cannot claim them. This originally tickled an invalid unwrap().
2749 let nodes = create_network(2, &[None, None]);
2750 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2752 route_payment(&nodes[0], &[&nodes[1]], 10000000);
2753 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id);
2754 check_closed_broadcast!(nodes[0], false);
2756 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2757 assert_eq!(node_txn.len(), 2);
2759 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2760 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
2761 check_closed_broadcast!(nodes[1], false);
2763 // Duplicate the block_connected call since this may happen due to other listeners
2764 // registering new transactions
2765 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
2769 fn test_force_close_fail_back() {
2770 // Check which HTLCs are failed-backwards on channel force-closure
2771 let mut nodes = create_network(3, &[None, None, None]);
2772 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2773 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2775 let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, 42).unwrap();
2777 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
2779 let mut payment_event = {
2780 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
2781 check_added_monitors!(nodes[0], 1);
2783 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2784 assert_eq!(events.len(), 1);
2785 SendEvent::from_event(events.remove(0))
2788 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
2789 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
2791 expect_pending_htlcs_forwardable!(nodes[1]);
2793 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
2794 assert_eq!(events_2.len(), 1);
2795 payment_event = SendEvent::from_event(events_2.remove(0));
2796 assert_eq!(payment_event.msgs.len(), 1);
2798 check_added_monitors!(nodes[1], 1);
2799 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
2800 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
2801 check_added_monitors!(nodes[2], 1);
2802 let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2804 // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
2805 // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
2806 // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
2808 nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id);
2809 check_closed_broadcast!(nodes[2], false);
2811 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
2812 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
2813 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
2814 // back to nodes[1] upon timeout otherwise.
2815 assert_eq!(node_txn.len(), 1);
2819 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2820 nodes[1].block_notifier.block_connected_checked(&header, 1, &[&tx], &[1]);
2822 // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
2823 check_closed_broadcast!(nodes[1], false);
2825 // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
2827 let mut monitors = nodes[2].chan_monitor.simple_monitor.monitors.lock().unwrap();
2828 monitors.get_mut(&OutPoint::new(Sha256dHash::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), 0)).unwrap()
2829 .provide_payment_preimage(&our_payment_hash, &our_payment_preimage);
2831 nodes[2].block_notifier.block_connected_checked(&header, 1, &[&tx], &[1]);
2832 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
2833 assert_eq!(node_txn.len(), 1);
2834 assert_eq!(node_txn[0].input.len(), 1);
2835 assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
2836 assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
2837 assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
2839 check_spends!(node_txn[0], tx);
2843 fn test_unconf_chan() {
2844 // After creating a chan between nodes, we disconnect all blocks previously seen to force a channel close on nodes[0] side
2845 let nodes = create_network(2, &[None, None]);
2846 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2848 let channel_state = nodes[0].node.channel_state.lock().unwrap();
2849 assert_eq!(channel_state.by_id.len(), 1);
2850 assert_eq!(channel_state.short_to_id.len(), 1);
2851 mem::drop(channel_state);
2853 let mut headers = Vec::new();
2854 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2855 headers.push(header.clone());
2857 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2858 headers.push(header.clone());
2860 let mut height = 99;
2861 while !headers.is_empty() {
2862 nodes[0].node.block_disconnected(&headers.pop().unwrap(), height);
2865 check_closed_broadcast!(nodes[0], false);
2866 let channel_state = nodes[0].node.channel_state.lock().unwrap();
2867 assert_eq!(channel_state.by_id.len(), 0);
2868 assert_eq!(channel_state.short_to_id.len(), 0);
2872 fn test_simple_peer_disconnect() {
2873 // Test that we can reconnect when there are no lost messages
2874 let nodes = create_network(3, &[None, None, None]);
2875 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2876 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2878 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2879 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2880 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
2882 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
2883 let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
2884 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
2885 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1, 1_000_000);
2887 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2888 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2889 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
2891 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
2892 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
2893 let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
2894 let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
2896 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2897 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2899 claim_payment_along_route(&nodes[0], &vec!(&nodes[1], &nodes[2]), true, payment_preimage_3, 1_000_000);
2900 fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
2902 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
2904 let events = nodes[0].node.get_and_clear_pending_events();
2905 assert_eq!(events.len(), 2);
2907 Event::PaymentSent { payment_preimage } => {
2908 assert_eq!(payment_preimage, payment_preimage_3);
2910 _ => panic!("Unexpected event"),
2913 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
2914 assert_eq!(payment_hash, payment_hash_5);
2915 assert!(rejected_by_dest);
2917 _ => panic!("Unexpected event"),
2921 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4, 1_000_000);
2922 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
2925 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
2926 // Test that we can reconnect when in-flight HTLC updates get dropped
2927 let mut nodes = create_network(2, &[None, None]);
2928 if messages_delivered == 0 {
2929 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
2930 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
2932 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2935 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();
2936 let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
2938 let payment_event = {
2939 nodes[0].node.send_payment(route.clone(), payment_hash_1).unwrap();
2940 check_added_monitors!(nodes[0], 1);
2942 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2943 assert_eq!(events.len(), 1);
2944 SendEvent::from_event(events.remove(0))
2946 assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
2948 if messages_delivered < 2 {
2949 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
2951 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
2952 if messages_delivered >= 3 {
2953 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
2954 check_added_monitors!(nodes[1], 1);
2955 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2957 if messages_delivered >= 4 {
2958 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
2959 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2960 check_added_monitors!(nodes[0], 1);
2962 if messages_delivered >= 5 {
2963 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
2964 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2965 // No commitment_signed so get_event_msg's assert(len == 1) passes
2966 check_added_monitors!(nodes[0], 1);
2968 if messages_delivered >= 6 {
2969 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
2970 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2971 check_added_monitors!(nodes[1], 1);
2978 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2979 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2980 if messages_delivered < 3 {
2981 // Even if the funding_locked messages get exchanged, as long as nothing further was
2982 // received on either side, both sides will need to resend them.
2983 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
2984 } else if messages_delivered == 3 {
2985 // nodes[0] still wants its RAA + commitment_signed
2986 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
2987 } else if messages_delivered == 4 {
2988 // nodes[0] still wants its commitment_signed
2989 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
2990 } else if messages_delivered == 5 {
2991 // nodes[1] still wants its final RAA
2992 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
2993 } else if messages_delivered == 6 {
2994 // Everything was delivered...
2995 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
2998 let events_1 = nodes[1].node.get_and_clear_pending_events();
2999 assert_eq!(events_1.len(), 1);
3001 Event::PendingHTLCsForwardable { .. } => { },
3002 _ => panic!("Unexpected event"),
3005 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3006 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3007 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3009 nodes[1].node.process_pending_htlc_forwards();
3011 let events_2 = nodes[1].node.get_and_clear_pending_events();
3012 assert_eq!(events_2.len(), 1);
3014 Event::PaymentReceived { ref payment_hash, amt } => {
3015 assert_eq!(payment_hash_1, *payment_hash);
3016 assert_eq!(amt, 1000000);
3018 _ => panic!("Unexpected event"),
3021 nodes[1].node.claim_funds(payment_preimage_1, 1_000_000);
3022 check_added_monitors!(nodes[1], 1);
3024 let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3025 assert_eq!(events_3.len(), 1);
3026 let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3027 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3028 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3029 assert!(updates.update_add_htlcs.is_empty());
3030 assert!(updates.update_fail_htlcs.is_empty());
3031 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3032 assert!(updates.update_fail_malformed_htlcs.is_empty());
3033 assert!(updates.update_fee.is_none());
3034 (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3036 _ => panic!("Unexpected event"),
3039 if messages_delivered >= 1 {
3040 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3042 let events_4 = nodes[0].node.get_and_clear_pending_events();
3043 assert_eq!(events_4.len(), 1);
3045 Event::PaymentSent { ref payment_preimage } => {
3046 assert_eq!(payment_preimage_1, *payment_preimage);
3048 _ => panic!("Unexpected event"),
3051 if messages_delivered >= 2 {
3052 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3053 check_added_monitors!(nodes[0], 1);
3054 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3056 if messages_delivered >= 3 {
3057 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3058 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3059 check_added_monitors!(nodes[1], 1);
3061 if messages_delivered >= 4 {
3062 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3063 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3064 // No commitment_signed so get_event_msg's assert(len == 1) passes
3065 check_added_monitors!(nodes[1], 1);
3067 if messages_delivered >= 5 {
3068 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3069 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3070 check_added_monitors!(nodes[0], 1);
3077 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3078 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3079 if messages_delivered < 2 {
3080 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3081 //TODO: Deduplicate PaymentSent events, then enable this if:
3082 //if messages_delivered < 1 {
3083 let events_4 = nodes[0].node.get_and_clear_pending_events();
3084 assert_eq!(events_4.len(), 1);
3086 Event::PaymentSent { ref payment_preimage } => {
3087 assert_eq!(payment_preimage_1, *payment_preimage);
3089 _ => panic!("Unexpected event"),
3092 } else if messages_delivered == 2 {
3093 // nodes[0] still wants its RAA + commitment_signed
3094 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3095 } else if messages_delivered == 3 {
3096 // nodes[0] still wants its commitment_signed
3097 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3098 } else if messages_delivered == 4 {
3099 // nodes[1] still wants its final RAA
3100 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3101 } else if messages_delivered == 5 {
3102 // Everything was delivered...
3103 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3106 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3107 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3108 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3110 // Channel should still work fine...
3111 let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3112 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3116 fn test_drop_messages_peer_disconnect_a() {
3117 do_test_drop_messages_peer_disconnect(0);
3118 do_test_drop_messages_peer_disconnect(1);
3119 do_test_drop_messages_peer_disconnect(2);
3120 do_test_drop_messages_peer_disconnect(3);
3124 fn test_drop_messages_peer_disconnect_b() {
3125 do_test_drop_messages_peer_disconnect(4);
3126 do_test_drop_messages_peer_disconnect(5);
3127 do_test_drop_messages_peer_disconnect(6);
3131 fn test_funding_peer_disconnect() {
3132 // Test that we can lock in our funding tx while disconnected
3133 let nodes = create_network(2, &[None, None]);
3134 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
3136 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3137 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3139 confirm_transaction(&nodes[0].block_notifier, &nodes[0].chain_monitor, &tx, tx.version);
3140 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3141 assert_eq!(events_1.len(), 1);
3143 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3144 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3146 _ => panic!("Unexpected event"),
3149 reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3151 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3152 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3154 confirm_transaction(&nodes[1].block_notifier, &nodes[1].chain_monitor, &tx, tx.version);
3155 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3156 assert_eq!(events_2.len(), 2);
3157 let funding_locked = match events_2[0] {
3158 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3159 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3162 _ => panic!("Unexpected event"),
3164 let bs_announcement_sigs = match events_2[1] {
3165 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3166 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3169 _ => panic!("Unexpected event"),
3172 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3174 nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3175 nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3176 let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3177 assert_eq!(events_3.len(), 2);
3178 let as_announcement_sigs = match events_3[0] {
3179 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3180 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3183 _ => panic!("Unexpected event"),
3185 let (as_announcement, as_update) = match events_3[1] {
3186 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3187 (msg.clone(), update_msg.clone())
3189 _ => panic!("Unexpected event"),
3192 nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3193 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3194 assert_eq!(events_4.len(), 1);
3195 let (_, bs_update) = match events_4[0] {
3196 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3197 (msg.clone(), update_msg.clone())
3199 _ => panic!("Unexpected event"),
3202 nodes[0].router.handle_channel_announcement(&as_announcement).unwrap();
3203 nodes[0].router.handle_channel_update(&bs_update).unwrap();
3204 nodes[0].router.handle_channel_update(&as_update).unwrap();
3206 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
3207 let (payment_preimage, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3208 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage, 1_000_000);
3212 fn test_drop_messages_peer_disconnect_dual_htlc() {
3213 // Test that we can handle reconnecting when both sides of a channel have pending
3214 // commitment_updates when we disconnect.
3215 let mut nodes = create_network(2, &[None, None]);
3216 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3218 let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3220 // Now try to send a second payment which will fail to send
3221 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
3222 let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
3224 nodes[0].node.send_payment(route.clone(), payment_hash_2).unwrap();
3225 check_added_monitors!(nodes[0], 1);
3227 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3228 assert_eq!(events_1.len(), 1);
3230 MessageSendEvent::UpdateHTLCs { .. } => {},
3231 _ => panic!("Unexpected event"),
3234 assert!(nodes[1].node.claim_funds(payment_preimage_1, 1_000_000));
3235 check_added_monitors!(nodes[1], 1);
3237 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3238 assert_eq!(events_2.len(), 1);
3240 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 } } => {
3241 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3242 assert!(update_add_htlcs.is_empty());
3243 assert_eq!(update_fulfill_htlcs.len(), 1);
3244 assert!(update_fail_htlcs.is_empty());
3245 assert!(update_fail_malformed_htlcs.is_empty());
3246 assert!(update_fee.is_none());
3248 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3249 let events_3 = nodes[0].node.get_and_clear_pending_events();
3250 assert_eq!(events_3.len(), 1);
3252 Event::PaymentSent { ref payment_preimage } => {
3253 assert_eq!(*payment_preimage, payment_preimage_1);
3255 _ => panic!("Unexpected event"),
3258 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
3259 let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3260 // No commitment_signed so get_event_msg's assert(len == 1) passes
3261 check_added_monitors!(nodes[0], 1);
3263 _ => panic!("Unexpected event"),
3266 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3267 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3269 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3270 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3271 assert_eq!(reestablish_1.len(), 1);
3272 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3273 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3274 assert_eq!(reestablish_2.len(), 1);
3276 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3277 let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3278 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3279 let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3281 assert!(as_resp.0.is_none());
3282 assert!(bs_resp.0.is_none());
3284 assert!(bs_resp.1.is_none());
3285 assert!(bs_resp.2.is_none());
3287 assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3289 assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3290 assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3291 assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3292 assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3293 assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3294 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
3295 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
3296 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3297 // No commitment_signed so get_event_msg's assert(len == 1) passes
3298 check_added_monitors!(nodes[1], 1);
3300 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
3301 let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3302 assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
3303 assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
3304 assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
3305 assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
3306 assert!(bs_second_commitment_signed.update_fee.is_none());
3307 check_added_monitors!(nodes[1], 1);
3309 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3310 let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3311 assert!(as_commitment_signed.update_add_htlcs.is_empty());
3312 assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
3313 assert!(as_commitment_signed.update_fail_htlcs.is_empty());
3314 assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
3315 assert!(as_commitment_signed.update_fee.is_none());
3316 check_added_monitors!(nodes[0], 1);
3318 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
3319 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3320 // No commitment_signed so get_event_msg's assert(len == 1) passes
3321 check_added_monitors!(nodes[0], 1);
3323 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
3324 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3325 // No commitment_signed so get_event_msg's assert(len == 1) passes
3326 check_added_monitors!(nodes[1], 1);
3328 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3329 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3330 check_added_monitors!(nodes[1], 1);
3332 expect_pending_htlcs_forwardable!(nodes[1]);
3334 let events_5 = nodes[1].node.get_and_clear_pending_events();
3335 assert_eq!(events_5.len(), 1);
3337 Event::PaymentReceived { ref payment_hash, amt: _ } => {
3338 assert_eq!(payment_hash_2, *payment_hash);
3340 _ => panic!("Unexpected event"),
3343 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
3344 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3345 check_added_monitors!(nodes[0], 1);
3347 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3351 fn test_invalid_channel_announcement() {
3352 //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
3353 let secp_ctx = Secp256k1::new();
3354 let nodes = create_network(2, &[None, None]);
3356 let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::supported(), InitFeatures::supported());
3358 let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
3359 let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
3360 let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
3361 let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
3363 nodes[0].router.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap(), is_permanent: false } );
3365 let as_bitcoin_key = PublicKey::from_secret_key(&secp_ctx, &as_chan.get_local_keys().inner.funding_key);
3366 let bs_bitcoin_key = PublicKey::from_secret_key(&secp_ctx, &bs_chan.get_local_keys().inner.funding_key);
3368 let as_network_key = nodes[0].node.get_our_node_id();
3369 let bs_network_key = nodes[1].node.get_our_node_id();
3371 let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
3373 let mut chan_announcement;
3375 macro_rules! dummy_unsigned_msg {
3377 msgs::UnsignedChannelAnnouncement {
3378 features: ChannelFeatures::supported(),
3379 chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
3380 short_channel_id: as_chan.get_short_channel_id().unwrap(),
3381 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
3382 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
3383 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
3384 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
3385 excess_data: Vec::new(),
3390 macro_rules! sign_msg {
3391 ($unsigned_msg: expr) => {
3392 let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
3393 let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_local_keys().inner.funding_key);
3394 let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_local_keys().inner.funding_key);
3395 let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
3396 let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
3397 chan_announcement = msgs::ChannelAnnouncement {
3398 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
3399 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
3400 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
3401 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
3402 contents: $unsigned_msg
3407 let unsigned_msg = dummy_unsigned_msg!();
3408 sign_msg!(unsigned_msg);
3409 assert_eq!(nodes[0].router.handle_channel_announcement(&chan_announcement).unwrap(), true);
3410 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 } );
3412 // Configured with Network::Testnet
3413 let mut unsigned_msg = dummy_unsigned_msg!();
3414 unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.bitcoin_hash();
3415 sign_msg!(unsigned_msg);
3416 assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
3418 let mut unsigned_msg = dummy_unsigned_msg!();
3419 unsigned_msg.chain_hash = Sha256dHash::hash(&[1,2,3,4,5,6,7,8,9]);
3420 sign_msg!(unsigned_msg);
3421 assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
3425 fn test_no_txn_manager_serialize_deserialize() {
3426 let mut nodes = create_network(2, &[None, None]);
3428 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
3430 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3432 let nodes_0_serialized = nodes[0].node.encode();
3433 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3434 nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
3436 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 })));
3437 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3438 let (_, mut chan_0_monitor) = <(Sha256dHash, ChannelMonitor)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
3439 assert!(chan_0_monitor_read.is_empty());
3441 let mut nodes_0_read = &nodes_0_serialized[..];
3442 let config = UserConfig::default();
3443 let keys_manager = Arc::new(test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
3444 let (_, nodes_0_deserialized) = {
3445 let mut channel_monitors = HashMap::new();
3446 channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &mut chan_0_monitor);
3447 <(Sha256dHash, ChannelManager<EnforcingChannelKeys>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3448 default_config: config,
3450 fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
3451 monitor: nodes[0].chan_monitor.clone(),
3452 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3453 logger: Arc::new(test_utils::TestLogger::new()),
3454 channel_monitors: &mut channel_monitors,
3457 assert!(nodes_0_read.is_empty());
3459 assert!(nodes[0].chan_monitor.add_update_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
3460 nodes[0].node = Arc::new(nodes_0_deserialized);
3461 let nodes_0_as_listener: Arc<ChainListener> = nodes[0].node.clone();
3462 nodes[0].block_notifier.register_listener(Arc::downgrade(&nodes_0_as_listener));
3463 assert_eq!(nodes[0].node.list_channels().len(), 1);
3464 check_added_monitors!(nodes[0], 1);
3466 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3467 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3468 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3469 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3471 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3472 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3473 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3474 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3476 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
3477 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
3478 for node in nodes.iter() {
3479 assert!(node.router.handle_channel_announcement(&announcement).unwrap());
3480 node.router.handle_channel_update(&as_update).unwrap();
3481 node.router.handle_channel_update(&bs_update).unwrap();
3484 send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
3488 fn test_simple_manager_serialize_deserialize() {
3489 let mut nodes = create_network(2, &[None, None]);
3490 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3492 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3493 let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3495 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3497 let nodes_0_serialized = nodes[0].node.encode();
3498 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3499 nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
3501 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 })));
3502 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3503 let (_, mut chan_0_monitor) = <(Sha256dHash, ChannelMonitor)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
3504 assert!(chan_0_monitor_read.is_empty());
3506 let mut nodes_0_read = &nodes_0_serialized[..];
3507 let keys_manager = Arc::new(test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
3508 let (_, nodes_0_deserialized) = {
3509 let mut channel_monitors = HashMap::new();
3510 channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &mut chan_0_monitor);
3511 <(Sha256dHash, ChannelManager<EnforcingChannelKeys>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3512 default_config: UserConfig::default(),
3514 fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
3515 monitor: nodes[0].chan_monitor.clone(),
3516 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3517 logger: Arc::new(test_utils::TestLogger::new()),
3518 channel_monitors: &mut channel_monitors,
3521 assert!(nodes_0_read.is_empty());
3523 assert!(nodes[0].chan_monitor.add_update_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
3524 nodes[0].node = Arc::new(nodes_0_deserialized);
3525 check_added_monitors!(nodes[0], 1);
3527 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3529 fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
3530 claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage, 1_000_000);
3534 fn test_manager_serialize_deserialize_inconsistent_monitor() {
3535 // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
3536 let mut nodes = create_network(4, &[None, None, None, None]);
3537 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3538 create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::supported(), InitFeatures::supported());
3539 let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::supported(), InitFeatures::supported());
3541 let (our_payment_preimage, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
3543 // Serialize the ChannelManager here, but the monitor we keep up-to-date
3544 let nodes_0_serialized = nodes[0].node.encode();
3546 route_payment(&nodes[0], &[&nodes[3]], 1000000);
3547 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3548 nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3549 nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3551 // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
3553 let mut node_0_monitors_serialized = Vec::new();
3554 for monitor in nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter() {
3555 let mut writer = test_utils::TestVecWriter(Vec::new());
3556 monitor.1.write_for_disk(&mut writer).unwrap();
3557 node_0_monitors_serialized.push(writer.0);
3560 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 })));
3561 let mut node_0_monitors = Vec::new();
3562 for serialized in node_0_monitors_serialized.iter() {
3563 let mut read = &serialized[..];
3564 let (_, monitor) = <(Sha256dHash, ChannelMonitor)>::read(&mut read, Arc::new(test_utils::TestLogger::new())).unwrap();
3565 assert!(read.is_empty());
3566 node_0_monitors.push(monitor);
3569 let mut nodes_0_read = &nodes_0_serialized[..];
3570 let keys_manager = Arc::new(test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
3571 let (_, nodes_0_deserialized) = <(Sha256dHash, ChannelManager<EnforcingChannelKeys>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3572 default_config: UserConfig::default(),
3574 fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
3575 monitor: nodes[0].chan_monitor.clone(),
3576 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3577 logger: Arc::new(test_utils::TestLogger::new()),
3578 channel_monitors: &mut node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().unwrap(), monitor) }).collect(),
3580 assert!(nodes_0_read.is_empty());
3582 { // Channel close should result in a commitment tx and an HTLC tx
3583 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3584 assert_eq!(txn.len(), 2);
3585 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
3586 assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
3589 for monitor in node_0_monitors.drain(..) {
3590 assert!(nodes[0].chan_monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor).is_ok());
3591 check_added_monitors!(nodes[0], 1);
3593 nodes[0].node = Arc::new(nodes_0_deserialized);
3595 // nodes[1] and nodes[2] have no lost state with nodes[0]...
3596 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3597 reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3598 //... and we can even still claim the payment!
3599 claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage, 1_000_000);
3601 nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3602 let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
3603 nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3604 nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
3605 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
3606 assert_eq!(msg_events.len(), 1);
3607 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
3609 &ErrorAction::SendErrorMessage { ref msg } => {
3610 assert_eq!(msg.channel_id, channel_id);
3612 _ => panic!("Unexpected event!"),
3617 macro_rules! check_spendable_outputs {
3618 ($node: expr, $der_idx: expr) => {
3620 let events = $node.chan_monitor.simple_monitor.get_and_clear_pending_events();
3621 let mut txn = Vec::new();
3622 for event in events {
3624 Event::SpendableOutputs { ref outputs } => {
3625 for outp in outputs {
3627 SpendableOutputDescriptor::DynamicOutputP2WPKH { ref outpoint, ref key, ref output } => {
3629 previous_output: outpoint.clone(),
3630 script_sig: Script::new(),
3632 witness: Vec::new(),
3635 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
3636 value: output.value,
3638 let mut spend_tx = Transaction {
3644 let secp_ctx = Secp256k1::new();
3645 let remotepubkey = PublicKey::from_secret_key(&secp_ctx, &key);
3646 let witness_script = Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: remotepubkey}, Network::Testnet).script_pubkey();
3647 let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
3648 let remotesig = secp_ctx.sign(&sighash, key);
3649 spend_tx.input[0].witness.push(remotesig.serialize_der().to_vec());
3650 spend_tx.input[0].witness[0].push(SigHashType::All as u8);
3651 spend_tx.input[0].witness.push(remotepubkey.serialize().to_vec());
3654 SpendableOutputDescriptor::DynamicOutputP2WSH { ref outpoint, ref key, ref witness_script, ref to_self_delay, ref output } => {
3656 previous_output: outpoint.clone(),
3657 script_sig: Script::new(),
3658 sequence: *to_self_delay as u32,
3659 witness: Vec::new(),
3662 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
3663 value: output.value,
3665 let mut spend_tx = Transaction {
3671 let secp_ctx = Secp256k1::new();
3672 let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], witness_script, output.value)[..]).unwrap();
3673 let local_delaysig = secp_ctx.sign(&sighash, key);
3674 spend_tx.input[0].witness.push(local_delaysig.serialize_der().to_vec());
3675 spend_tx.input[0].witness[0].push(SigHashType::All as u8);
3676 spend_tx.input[0].witness.push(vec!(0));
3677 spend_tx.input[0].witness.push(witness_script.clone().into_bytes());
3680 SpendableOutputDescriptor::StaticOutput { ref outpoint, ref output } => {
3681 let secp_ctx = Secp256k1::new();
3683 previous_output: outpoint.clone(),
3684 script_sig: Script::new(),
3686 witness: Vec::new(),
3689 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
3690 value: output.value,
3692 let mut spend_tx = Transaction {
3696 output: vec![outp.clone()],
3699 match ExtendedPrivKey::new_master(Network::Testnet, &$node.node_seed) {
3701 match master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx($der_idx).expect("key space exhausted")) {
3703 Err(_) => panic!("Your RNG is busted"),
3706 Err(_) => panic!("Your rng is busted"),
3709 let pubkey = ExtendedPubKey::from_private(&secp_ctx, &secret).public_key;
3710 let witness_script = Address::p2pkh(&pubkey, Network::Testnet).script_pubkey();
3711 let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
3712 let sig = secp_ctx.sign(&sighash, &secret.private_key.key);
3713 spend_tx.input[0].witness.push(sig.serialize_der().to_vec());
3714 spend_tx.input[0].witness[0].push(SigHashType::All as u8);
3715 spend_tx.input[0].witness.push(pubkey.key.serialize().to_vec());
3721 _ => panic!("Unexpected event"),
3730 fn test_claim_sizeable_push_msat() {
3731 // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
3732 let nodes = create_network(2, &[None, None]);
3734 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::supported(), InitFeatures::supported());
3735 nodes[1].node.force_close_channel(&chan.2);
3736 check_closed_broadcast!(nodes[1], false);
3737 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3738 assert_eq!(node_txn.len(), 1);
3739 check_spends!(node_txn[0], chan.3.clone());
3740 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
3742 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3743 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
3744 let spend_txn = check_spendable_outputs!(nodes[1], 1);
3745 assert_eq!(spend_txn.len(), 1);
3746 check_spends!(spend_txn[0], node_txn[0].clone());
3750 fn test_claim_on_remote_sizeable_push_msat() {
3751 // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
3752 // to_remote output is encumbered by a P2WPKH
3753 let nodes = create_network(2, &[None, None]);
3755 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::supported(), InitFeatures::supported());
3756 nodes[0].node.force_close_channel(&chan.2);
3757 check_closed_broadcast!(nodes[0], false);
3759 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3760 assert_eq!(node_txn.len(), 1);
3761 check_spends!(node_txn[0], chan.3.clone());
3762 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
3764 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3765 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
3766 check_closed_broadcast!(nodes[1], false);
3767 let spend_txn = check_spendable_outputs!(nodes[1], 1);
3768 assert_eq!(spend_txn.len(), 2);
3769 assert_eq!(spend_txn[0], spend_txn[1]);
3770 check_spends!(spend_txn[0], node_txn[0].clone());
3774 fn test_claim_on_remote_revoked_sizeable_push_msat() {
3775 // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
3776 // to_remote output is encumbered by a P2WPKH
3778 let nodes = create_network(2, &[None, None]);
3780 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::supported(), InitFeatures::supported());
3781 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
3782 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();
3783 assert_eq!(revoked_local_txn[0].input.len(), 1);
3784 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
3786 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
3787 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3788 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3789 check_closed_broadcast!(nodes[1], false);
3791 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3792 let spend_txn = check_spendable_outputs!(nodes[1], 1);
3793 assert_eq!(spend_txn.len(), 4);
3794 assert_eq!(spend_txn[0], spend_txn[2]); // to_remote output on revoked remote commitment_tx
3795 check_spends!(spend_txn[0], revoked_local_txn[0].clone());
3796 assert_eq!(spend_txn[1], spend_txn[3]); // to_local output on local commitment tx
3797 check_spends!(spend_txn[1], node_txn[0].clone());
3801 fn test_static_spendable_outputs_preimage_tx() {
3802 let nodes = create_network(2, &[None, None]);
3804 // Create some initial channels
3805 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3807 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
3809 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();
3810 assert_eq!(commitment_tx[0].input.len(), 1);
3811 assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
3813 // Settle A's commitment tx on B's chain
3814 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3815 assert!(nodes[1].node.claim_funds(payment_preimage, 3_000_000));
3816 check_added_monitors!(nodes[1], 1);
3817 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()] }, 1);
3818 let events = nodes[1].node.get_and_clear_pending_msg_events();
3820 MessageSendEvent::UpdateHTLCs { .. } => {},
3821 _ => panic!("Unexpected event"),
3824 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
3825 _ => panic!("Unexepected event"),
3828 // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
3829 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: 2 (1 preimage tx)
3830 assert_eq!(node_txn.len(), 4);
3831 check_spends!(node_txn[0], commitment_tx[0].clone());
3832 assert_eq!(node_txn[0], node_txn[3]);
3833 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3834 eprintln!("{:?}", node_txn[1]);
3835 check_spends!(node_txn[1], chan_1.3.clone());
3836 check_spends!(node_txn[2], node_txn[1]);
3838 let spend_txn = check_spendable_outputs!(nodes[1], 1); // , 0, 0, 1, 1);
3839 assert_eq!(spend_txn.len(), 2);
3840 assert_eq!(spend_txn[0], spend_txn[1]);
3841 check_spends!(spend_txn[0], node_txn[0].clone());
3845 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
3846 let nodes = create_network(2, &[None, None]);
3848 // Create some initial channels
3849 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3851 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
3852 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();
3853 assert_eq!(revoked_local_txn[0].input.len(), 1);
3854 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
3856 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
3858 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3859 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3860 check_closed_broadcast!(nodes[1], false);
3862 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3863 assert_eq!(node_txn.len(), 3);
3864 assert_eq!(node_txn.pop().unwrap(), node_txn[0]);
3865 assert_eq!(node_txn[0].input.len(), 2);
3866 check_spends!(node_txn[0], revoked_local_txn[0].clone());
3868 let spend_txn = check_spendable_outputs!(nodes[1], 1);
3869 assert_eq!(spend_txn.len(), 2);
3870 assert_eq!(spend_txn[0], spend_txn[1]);
3871 check_spends!(spend_txn[0], node_txn[0].clone());
3875 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
3876 let nodes = create_network(2, &[None, None]);
3878 // Create some initial channels
3879 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3881 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
3882 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();
3883 assert_eq!(revoked_local_txn[0].input.len(), 1);
3884 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
3886 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
3888 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3889 // A will generate HTLC-Timeout from revoked commitment tx
3890 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3891 check_closed_broadcast!(nodes[0], false);
3893 let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3894 assert_eq!(revoked_htlc_txn.len(), 3);
3895 assert_eq!(revoked_htlc_txn[0], revoked_htlc_txn[2]);
3896 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
3897 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3898 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
3899 check_spends!(revoked_htlc_txn[1], chan_1.3.clone());
3901 // B will generate justice tx from A's revoked commitment/HTLC tx
3902 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
3903 check_closed_broadcast!(nodes[1], false);
3905 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3906 assert_eq!(node_txn.len(), 5);
3907 assert_eq!(node_txn[3].input.len(), 1);
3908 check_spends!(node_txn[3], revoked_htlc_txn[0].clone());
3910 // Check B's ChannelMonitor was able to generate the right spendable output descriptor
3911 let spend_txn = check_spendable_outputs!(nodes[1], 1);
3912 assert_eq!(spend_txn.len(), 3);
3913 assert_eq!(spend_txn[0], spend_txn[1]);
3914 check_spends!(spend_txn[0], node_txn[0].clone());
3915 check_spends!(spend_txn[2], node_txn[3].clone());
3919 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
3920 let nodes = create_network(2, &[None, None]);
3922 // Create some initial channels
3923 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3925 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
3926 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();
3927 assert_eq!(revoked_local_txn[0].input.len(), 1);
3928 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
3930 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
3932 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3933 // B will generate HTLC-Success from revoked commitment tx
3934 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3935 check_closed_broadcast!(nodes[1], false);
3936 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3938 assert_eq!(revoked_htlc_txn.len(), 3);
3939 assert_eq!(revoked_htlc_txn[0], revoked_htlc_txn[2]);
3940 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
3941 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3942 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
3944 // A will generate justice tx from B's revoked commitment/HTLC tx
3945 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
3946 check_closed_broadcast!(nodes[0], false);
3948 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3949 assert_eq!(node_txn.len(), 4);
3950 assert_eq!(node_txn[3].input.len(), 1);
3951 check_spends!(node_txn[3], revoked_htlc_txn[0].clone());
3953 // Check A's ChannelMonitor was able to generate the right spendable output descriptor
3954 let spend_txn = check_spendable_outputs!(nodes[0], 1);
3955 assert_eq!(spend_txn.len(), 5);
3956 assert_eq!(spend_txn[0], spend_txn[2]);
3957 assert_eq!(spend_txn[1], spend_txn[3]);
3958 check_spends!(spend_txn[0], revoked_local_txn[0].clone()); // spending to_remote output from revoked local tx
3959 check_spends!(spend_txn[1], node_txn[2].clone()); // spending justice tx output from revoked local tx htlc received output
3960 check_spends!(spend_txn[4], node_txn[3].clone()); // spending justice tx output on htlc success tx
3964 fn test_onchain_to_onchain_claim() {
3965 // Test that in case of channel closure, we detect the state of output thanks to
3966 // ChainWatchInterface and claim HTLC on downstream peer's remote commitment tx.
3967 // First, have C claim an HTLC against its own latest commitment transaction.
3968 // Then, broadcast these to B, which should update the monitor downstream on the A<->B
3970 // Finally, check that B will claim the HTLC output if A's latest commitment transaction
3973 let nodes = create_network(3, &[None, None, None]);
3975 // Create some initial channels
3976 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3977 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
3979 // Rebalance the network a bit by relaying one payment through all the channels ...
3980 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
3981 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
3983 let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
3984 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
3985 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();
3986 check_spends!(commitment_tx[0], chan_2.3.clone());
3987 nodes[2].node.claim_funds(payment_preimage, 3_000_000);
3988 check_added_monitors!(nodes[2], 1);
3989 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3990 assert!(updates.update_add_htlcs.is_empty());
3991 assert!(updates.update_fail_htlcs.is_empty());
3992 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3993 assert!(updates.update_fail_malformed_htlcs.is_empty());
3995 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
3996 check_closed_broadcast!(nodes[2], false);
3998 let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
3999 assert_eq!(c_txn.len(), 4);
4000 assert_eq!(c_txn[0], c_txn[2]);
4001 assert_eq!(c_txn[0], c_txn[3]);
4002 assert_eq!(commitment_tx[0], c_txn[1]);
4003 check_spends!(c_txn[1], chan_2.3.clone());
4004 check_spends!(c_txn[2], c_txn[1].clone());
4005 assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
4006 assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4007 assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
4008 assert_eq!(c_txn[0].lock_time, 0); // Success tx
4010 // 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
4011 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]}, 1);
4013 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4014 assert_eq!(b_txn.len(), 4);
4015 assert_eq!(b_txn[0], b_txn[3]);
4016 check_spends!(b_txn[1], chan_2.3); // B local commitment tx, issued by ChannelManager
4017 check_spends!(b_txn[2], b_txn[1].clone()); // HTLC-Timeout on B local commitment tx, issued by ChannelManager
4018 assert_eq!(b_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4019 assert!(b_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
4020 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
4021 check_spends!(b_txn[0], c_txn[1].clone()); // timeout tx on C remote commitment tx, issued by ChannelMonitor, * 2 due to block rescan
4022 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4023 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
4024 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
4027 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
4028 check_added_monitors!(nodes[1], 1);
4029 match msg_events[0] {
4030 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4031 _ => panic!("Unexpected event"),
4033 match msg_events[1] {
4034 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, .. } } => {
4035 assert!(update_add_htlcs.is_empty());
4036 assert!(update_fail_htlcs.is_empty());
4037 assert_eq!(update_fulfill_htlcs.len(), 1);
4038 assert!(update_fail_malformed_htlcs.is_empty());
4039 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
4041 _ => panic!("Unexpected event"),
4043 // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
4044 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();
4045 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
4046 let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4047 assert_eq!(b_txn.len(), 4);
4048 check_spends!(b_txn[1], chan_1.3); // Local commitment tx, issued by ChannelManager
4049 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
4050 assert_eq!(b_txn[0], b_txn[3]); // HTLC-Success tx, issued by ChannelMonitor, * 2 due to block rescan
4051 check_spends!(b_txn[0], commitment_tx[0].clone());
4052 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4053 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
4054 assert_eq!(b_txn[2].lock_time, 0); // Success tx
4056 check_closed_broadcast!(nodes[1], false);
4060 fn test_duplicate_payment_hash_one_failure_one_success() {
4061 // Topology : A --> B --> C
4062 // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
4063 let mut nodes = create_network(3, &[None, None, None]);
4065 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4066 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
4068 let (our_payment_preimage, duplicate_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
4069 *nodes[0].network_payment_count.borrow_mut() -= 1;
4070 assert_eq!(route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000).1, duplicate_payment_hash);
4072 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();
4073 assert_eq!(commitment_txn[0].input.len(), 1);
4074 check_spends!(commitment_txn[0], chan_2.3.clone());
4076 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4077 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
4078 check_closed_broadcast!(nodes[1], false);
4080 let htlc_timeout_tx;
4081 { // Extract one of the two HTLC-Timeout transaction
4082 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4083 assert_eq!(node_txn.len(), 7);
4084 assert_eq!(node_txn[0], node_txn[5]);
4085 assert_eq!(node_txn[1], node_txn[6]);
4086 check_spends!(node_txn[0], commitment_txn[0].clone());
4087 assert_eq!(node_txn[0].input.len(), 1);
4088 check_spends!(node_txn[1], commitment_txn[0].clone());
4089 assert_eq!(node_txn[1].input.len(), 1);
4090 assert_ne!(node_txn[0].input[0], node_txn[1].input[0]);
4091 check_spends!(node_txn[2], chan_2.3.clone());
4092 check_spends!(node_txn[3], node_txn[2].clone());
4093 check_spends!(node_txn[4], node_txn[2].clone());
4094 htlc_timeout_tx = node_txn[1].clone();
4097 nodes[2].node.claim_funds(our_payment_preimage, 900_000);
4098 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
4099 check_added_monitors!(nodes[2], 2);
4100 let events = nodes[2].node.get_and_clear_pending_msg_events();
4102 MessageSendEvent::UpdateHTLCs { .. } => {},
4103 _ => panic!("Unexpected event"),
4106 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4107 _ => panic!("Unexepected event"),
4109 let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
4110 assert_eq!(htlc_success_txn.len(), 7);
4111 check_spends!(htlc_success_txn[2], chan_2.3.clone());
4112 check_spends!(htlc_success_txn[3], htlc_success_txn[2]);
4113 check_spends!(htlc_success_txn[4], htlc_success_txn[2]);
4114 assert_eq!(htlc_success_txn[0], htlc_success_txn[5]);
4115 assert_eq!(htlc_success_txn[0].input.len(), 1);
4116 assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4117 assert_eq!(htlc_success_txn[1], htlc_success_txn[4]);
4118 assert_eq!(htlc_success_txn[1].input.len(), 1);
4119 assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4120 assert_ne!(htlc_success_txn[0].input[0], htlc_success_txn[1].input[0]);
4121 check_spends!(htlc_success_txn[0], commitment_txn[0].clone());
4122 check_spends!(htlc_success_txn[1], commitment_txn[0].clone());
4124 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![htlc_timeout_tx] }, 200);
4125 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
4126 expect_pending_htlcs_forwardable!(nodes[1]);
4127 let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4128 assert!(htlc_updates.update_add_htlcs.is_empty());
4129 assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
4130 assert_eq!(htlc_updates.update_fail_htlcs[0].htlc_id, 1);
4131 assert!(htlc_updates.update_fulfill_htlcs.is_empty());
4132 assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
4133 check_added_monitors!(nodes[1], 1);
4135 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
4136 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4138 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
4139 let events = nodes[0].node.get_and_clear_pending_msg_events();
4140 assert_eq!(events.len(), 1);
4142 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. } } => {
4144 _ => { panic!("Unexpected event"); }
4147 let events = nodes[0].node.get_and_clear_pending_events();
4149 Event::PaymentFailed { ref payment_hash, .. } => {
4150 assert_eq!(*payment_hash, duplicate_payment_hash);
4152 _ => panic!("Unexpected event"),
4155 // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
4156 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![htlc_success_txn[0].clone()] }, 200);
4157 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4158 assert!(updates.update_add_htlcs.is_empty());
4159 assert!(updates.update_fail_htlcs.is_empty());
4160 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4161 assert_eq!(updates.update_fulfill_htlcs[0].htlc_id, 0);
4162 assert!(updates.update_fail_malformed_htlcs.is_empty());
4163 check_added_monitors!(nodes[1], 1);
4165 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
4166 commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
4168 let events = nodes[0].node.get_and_clear_pending_events();
4170 Event::PaymentSent { ref payment_preimage } => {
4171 assert_eq!(*payment_preimage, our_payment_preimage);
4173 _ => panic!("Unexpected event"),
4178 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
4179 let nodes = create_network(2, &[None, None]);
4181 // Create some initial channels
4182 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4184 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
4185 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();
4186 assert_eq!(local_txn[0].input.len(), 1);
4187 check_spends!(local_txn[0], chan_1.3.clone());
4189 // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
4190 nodes[1].node.claim_funds(payment_preimage, 9_000_000);
4191 check_added_monitors!(nodes[1], 1);
4192 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4193 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![local_txn[0].clone()] }, 1);
4194 let events = nodes[1].node.get_and_clear_pending_msg_events();
4196 MessageSendEvent::UpdateHTLCs { .. } => {},
4197 _ => panic!("Unexpected event"),
4200 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4201 _ => panic!("Unexepected event"),
4203 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4204 assert_eq!(node_txn[0].input.len(), 1);
4205 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4206 check_spends!(node_txn[0], local_txn[0].clone());
4208 // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
4209 let spend_txn = check_spendable_outputs!(nodes[1], 1);
4210 assert_eq!(spend_txn.len(), 2);
4211 check_spends!(spend_txn[0], node_txn[0].clone());
4212 check_spends!(spend_txn[1], node_txn[2].clone());
4215 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
4216 // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
4217 // unrevoked commitment transaction.
4218 // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
4219 // a remote RAA before they could be failed backwards (and combinations thereof).
4220 // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
4221 // use the same payment hashes.
4222 // Thus, we use a six-node network:
4227 // And test where C fails back to A/B when D announces its latest commitment transaction
4228 let nodes = create_network(6, &[None, None, None, None, None, None]);
4230 create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::supported(), InitFeatures::supported());
4231 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
4232 let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
4233 create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::supported(), InitFeatures::supported());
4234 create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::supported(), InitFeatures::supported());
4236 // Rebalance and check output sanity...
4237 send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000, 500_000);
4238 send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000, 500_000);
4239 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);
4241 let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
4243 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
4245 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
4246 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();
4248 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
4250 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
4252 let (_, payment_hash_3) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4254 let (_, payment_hash_4) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4255 let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4257 send_along_route_with_hash(&nodes[1], route.clone(), &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_3);
4259 send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_4);
4262 let (_, payment_hash_5) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4264 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();
4265 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
4268 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
4270 let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4271 send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_6);
4273 // Double-check that six of the new HTLC were added
4274 // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
4275 // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
4276 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);
4277 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);
4279 // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
4280 // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
4281 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1));
4282 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3));
4283 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5));
4284 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6));
4285 check_added_monitors!(nodes[4], 0);
4286 expect_pending_htlcs_forwardable!(nodes[4]);
4287 check_added_monitors!(nodes[4], 1);
4289 let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
4290 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
4291 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
4292 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
4293 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
4294 commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
4296 // Fail 3rd below-dust and 7th above-dust HTLCs
4297 assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2));
4298 assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4));
4299 check_added_monitors!(nodes[5], 0);
4300 expect_pending_htlcs_forwardable!(nodes[5]);
4301 check_added_monitors!(nodes[5], 1);
4303 let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
4304 nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
4305 nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
4306 commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
4308 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();
4310 expect_pending_htlcs_forwardable!(nodes[3]);
4311 check_added_monitors!(nodes[3], 1);
4312 let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
4313 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
4314 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
4315 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
4316 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
4317 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
4318 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
4319 if deliver_last_raa {
4320 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
4322 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
4325 // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
4326 // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
4327 // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
4328 // propagated back to A/B yet (and D has two unrevoked commitment transactions).
4330 // We now broadcast the latest commitment transaction, which *should* result in failures for
4331 // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
4332 // the non-broadcast above-dust HTLCs.
4334 // Alternatively, we may broadcast the previous commitment transaction, which should only
4335 // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
4336 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();
4338 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4339 if announce_latest {
4340 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![ds_last_commitment_tx[0].clone()]}, 1);
4342 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![ds_prev_commitment_tx[0].clone()]}, 1);
4344 connect_blocks(&nodes[2].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4345 check_closed_broadcast!(nodes[2], false);
4346 expect_pending_htlcs_forwardable!(nodes[2]);
4347 check_added_monitors!(nodes[2], 2);
4349 let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
4350 assert_eq!(cs_msgs.len(), 2);
4351 let mut a_done = false;
4352 for msg in cs_msgs {
4354 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
4355 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
4356 // should be failed-backwards here.
4357 let target = if *node_id == nodes[0].node.get_our_node_id() {
4358 // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
4359 for htlc in &updates.update_fail_htlcs {
4360 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 });
4362 assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
4367 // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
4368 for htlc in &updates.update_fail_htlcs {
4369 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
4371 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
4372 assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
4375 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
4376 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
4377 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
4378 if announce_latest {
4379 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
4380 if *node_id == nodes[0].node.get_our_node_id() {
4381 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
4384 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
4386 _ => panic!("Unexpected event"),
4390 let as_events = nodes[0].node.get_and_clear_pending_events();
4391 assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
4392 let mut as_failds = HashSet::new();
4393 for event in as_events.iter() {
4394 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
4395 assert!(as_failds.insert(*payment_hash));
4396 if *payment_hash != payment_hash_2 {
4397 assert_eq!(*rejected_by_dest, deliver_last_raa);
4399 assert!(!rejected_by_dest);
4401 } else { panic!("Unexpected event"); }
4403 assert!(as_failds.contains(&payment_hash_1));
4404 assert!(as_failds.contains(&payment_hash_2));
4405 if announce_latest {
4406 assert!(as_failds.contains(&payment_hash_3));
4407 assert!(as_failds.contains(&payment_hash_5));
4409 assert!(as_failds.contains(&payment_hash_6));
4411 let bs_events = nodes[1].node.get_and_clear_pending_events();
4412 assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
4413 let mut bs_failds = HashSet::new();
4414 for event in bs_events.iter() {
4415 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
4416 assert!(bs_failds.insert(*payment_hash));
4417 if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
4418 assert_eq!(*rejected_by_dest, deliver_last_raa);
4420 assert!(!rejected_by_dest);
4422 } else { panic!("Unexpected event"); }
4424 assert!(bs_failds.contains(&payment_hash_1));
4425 assert!(bs_failds.contains(&payment_hash_2));
4426 if announce_latest {
4427 assert!(bs_failds.contains(&payment_hash_4));
4429 assert!(bs_failds.contains(&payment_hash_5));
4431 // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
4432 // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
4433 // to unknown-preimage-etc, B should have gotten 2. Thus, in the
4434 // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
4435 // PaymentFailureNetworkUpdates.
4436 let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4437 assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
4438 let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
4439 assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
4440 for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
4442 &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
4443 _ => panic!("Unexpected event"),
4449 fn test_fail_backwards_latest_remote_announce_a() {
4450 do_test_fail_backwards_unrevoked_remote_announce(false, true);
4454 fn test_fail_backwards_latest_remote_announce_b() {
4455 do_test_fail_backwards_unrevoked_remote_announce(true, true);
4459 fn test_fail_backwards_previous_remote_announce() {
4460 do_test_fail_backwards_unrevoked_remote_announce(false, false);
4461 // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
4462 // tested for in test_commitment_revoked_fail_backward_exhaustive()
4466 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
4467 let nodes = create_network(2, &[None, None]);
4469 // Create some initial channels
4470 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4472 route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
4473 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();
4474 assert_eq!(local_txn[0].input.len(), 1);
4475 check_spends!(local_txn[0], chan_1.3.clone());
4477 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
4478 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4479 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![local_txn[0].clone()] }, 200);
4480 check_closed_broadcast!(nodes[0], false);
4482 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4483 assert_eq!(node_txn[0].input.len(), 1);
4484 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4485 check_spends!(node_txn[0], local_txn[0].clone());
4487 // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
4488 let spend_txn = check_spendable_outputs!(nodes[0], 1);
4489 assert_eq!(spend_txn.len(), 8);
4490 assert_eq!(spend_txn[0], spend_txn[2]);
4491 assert_eq!(spend_txn[0], spend_txn[4]);
4492 assert_eq!(spend_txn[0], spend_txn[6]);
4493 assert_eq!(spend_txn[1], spend_txn[3]);
4494 assert_eq!(spend_txn[1], spend_txn[5]);
4495 assert_eq!(spend_txn[1], spend_txn[7]);
4496 check_spends!(spend_txn[0], local_txn[0].clone());
4497 check_spends!(spend_txn[1], node_txn[0].clone());
4501 fn test_static_output_closing_tx() {
4502 let nodes = create_network(2, &[None, None]);
4504 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4506 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
4507 let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
4509 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4510 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![closing_tx.clone()] }, 1);
4511 let spend_txn = check_spendable_outputs!(nodes[0], 2);
4512 assert_eq!(spend_txn.len(), 1);
4513 check_spends!(spend_txn[0], closing_tx.clone());
4515 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![closing_tx.clone()] }, 1);
4516 let spend_txn = check_spendable_outputs!(nodes[1], 2);
4517 assert_eq!(spend_txn.len(), 1);
4518 check_spends!(spend_txn[0], closing_tx);
4521 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
4522 let nodes = create_network(2, &[None, None]);
4523 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4525 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
4527 // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
4528 // present in B's local commitment transaction, but none of A's commitment transactions.
4529 assert!(nodes[1].node.claim_funds(our_payment_preimage, if use_dust { 50_000 } else { 3_000_000 }));
4530 check_added_monitors!(nodes[1], 1);
4532 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4533 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
4534 let events = nodes[0].node.get_and_clear_pending_events();
4535 assert_eq!(events.len(), 1);
4537 Event::PaymentSent { payment_preimage } => {
4538 assert_eq!(payment_preimage, our_payment_preimage);
4540 _ => panic!("Unexpected event"),
4543 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
4544 check_added_monitors!(nodes[0], 1);
4545 let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4546 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
4547 check_added_monitors!(nodes[1], 1);
4549 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4550 for i in 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + CHAN_CONFIRM_DEPTH + 1 {
4551 nodes[1].block_notifier.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
4552 header.prev_blockhash = header.bitcoin_hash();
4554 test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
4555 check_closed_broadcast!(nodes[1], false);
4558 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
4559 let mut nodes = create_network(2, &[None, None]);
4560 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4562 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();
4563 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
4564 nodes[0].node.send_payment(route, payment_hash).unwrap();
4565 check_added_monitors!(nodes[0], 1);
4567 let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4569 // As far as A is concerned, the HTLC is now present only in the latest remote commitment
4570 // transaction, however it is not in A's latest local commitment, so we can just broadcast that
4571 // to "time out" the HTLC.
4573 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4575 for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
4576 nodes[0].block_notifier.block_connected(&Block { header, txdata: Vec::new()}, i);
4577 header.prev_blockhash = header.bitcoin_hash();
4579 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
4580 check_closed_broadcast!(nodes[0], false);
4583 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
4584 let nodes = create_network(3, &[None, None, None]);
4585 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4587 // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
4588 // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
4589 // Also optionally test that we *don't* fail the channel in case the commitment transaction was
4590 // actually revoked.
4591 let htlc_value = if use_dust { 50000 } else { 3000000 };
4592 let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
4593 assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash));
4594 expect_pending_htlcs_forwardable!(nodes[1]);
4595 check_added_monitors!(nodes[1], 1);
4597 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4598 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
4599 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
4600 check_added_monitors!(nodes[0], 1);
4601 let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4602 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
4603 check_added_monitors!(nodes[1], 1);
4604 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
4605 check_added_monitors!(nodes[1], 1);
4606 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4608 if check_revoke_no_close {
4609 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
4610 check_added_monitors!(nodes[0], 1);
4613 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4614 for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
4615 nodes[0].block_notifier.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
4616 header.prev_blockhash = header.bitcoin_hash();
4618 if !check_revoke_no_close {
4619 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
4620 check_closed_broadcast!(nodes[0], false);
4622 let events = nodes[0].node.get_and_clear_pending_events();
4623 assert_eq!(events.len(), 1);
4625 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
4626 assert_eq!(payment_hash, our_payment_hash);
4627 assert!(rejected_by_dest);
4629 _ => panic!("Unexpected event"),
4634 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
4635 // There are only a few cases to test here:
4636 // * its not really normative behavior, but we test that below-dust HTLCs "included" in
4637 // broadcastable commitment transactions result in channel closure,
4638 // * its included in an unrevoked-but-previous remote commitment transaction,
4639 // * its included in the latest remote or local commitment transactions.
4640 // We test each of the three possible commitment transactions individually and use both dust and
4642 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
4643 // assume they are handled the same across all six cases, as both outbound and inbound failures are
4644 // tested for at least one of the cases in other tests.
4646 fn htlc_claim_single_commitment_only_a() {
4647 do_htlc_claim_local_commitment_only(true);
4648 do_htlc_claim_local_commitment_only(false);
4650 do_htlc_claim_current_remote_commitment_only(true);
4651 do_htlc_claim_current_remote_commitment_only(false);
4655 fn htlc_claim_single_commitment_only_b() {
4656 do_htlc_claim_previous_remote_commitment_only(true, false);
4657 do_htlc_claim_previous_remote_commitment_only(false, false);
4658 do_htlc_claim_previous_remote_commitment_only(true, true);
4659 do_htlc_claim_previous_remote_commitment_only(false, true);
4662 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>)
4663 where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
4666 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);
4670 // 0: node1 fails backward
4671 // 1: final node fails backward
4672 // 2: payment completed but the user rejects the payment
4673 // 3: final node fails backward (but tamper onion payloads from node0)
4674 // 100: trigger error in the intermediate node and tamper returning fail_htlc
4675 // 200: trigger error in the final node and tamper returning fail_htlc
4676 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>)
4677 where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
4678 F2: for <'a> FnMut(&'a mut msgs::UpdateFailHTLC),
4682 // reset block height
4683 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4684 for ix in 0..nodes.len() {
4685 nodes[ix].block_notifier.block_connected_checked(&header, 1, &[], &[]);
4688 macro_rules! expect_event {
4689 ($node: expr, $event_type: path) => {{
4690 let events = $node.node.get_and_clear_pending_events();
4691 assert_eq!(events.len(), 1);
4693 $event_type { .. } => {},
4694 _ => panic!("Unexpected event"),
4699 macro_rules! expect_htlc_forward {
4701 expect_event!($node, Event::PendingHTLCsForwardable);
4702 $node.node.process_pending_htlc_forwards();
4706 // 0 ~~> 2 send payment
4707 nodes[0].node.send_payment(route.clone(), payment_hash.clone()).unwrap();
4708 check_added_monitors!(nodes[0], 1);
4709 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4710 // temper update_add (0 => 1)
4711 let mut update_add_0 = update_0.update_add_htlcs[0].clone();
4712 if test_case == 0 || test_case == 3 || test_case == 100 {
4713 callback_msg(&mut update_add_0);
4716 // 0 => 1 update_add & CS
4717 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0);
4718 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
4720 let update_1_0 = match test_case {
4721 0|100 => { // intermediate node failure; fail backward to 0
4722 let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4723 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));
4726 1|2|3|200 => { // final node failure; forwarding to 2
4727 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4729 if test_case != 200 {
4732 expect_htlc_forward!(&nodes[1]);
4734 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
4735 check_added_monitors!(&nodes[1], 1);
4736 assert_eq!(update_1.update_add_htlcs.len(), 1);
4737 // tamper update_add (1 => 2)
4738 let mut update_add_1 = update_1.update_add_htlcs[0].clone();
4739 if test_case != 3 && test_case != 200 {
4740 callback_msg(&mut update_add_1);
4744 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1);
4745 commitment_signed_dance!(nodes[2], nodes[1], update_1.commitment_signed, false, true);
4747 if test_case == 2 || test_case == 200 {
4748 expect_htlc_forward!(&nodes[2]);
4749 expect_event!(&nodes[2], Event::PaymentReceived);
4751 expect_pending_htlcs_forwardable!(nodes[2]);
4754 let update_2_1 = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
4755 if test_case == 2 || test_case == 200 {
4756 check_added_monitors!(&nodes[2], 1);
4758 assert!(update_2_1.update_fail_htlcs.len() == 1);
4760 let mut fail_msg = update_2_1.update_fail_htlcs[0].clone();
4761 if test_case == 200 {
4762 callback_fail(&mut fail_msg);
4766 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &fail_msg);
4767 commitment_signed_dance!(nodes[1], nodes[2], update_2_1.commitment_signed, true);
4769 // backward fail on 1
4770 let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4771 assert!(update_1_0.update_fail_htlcs.len() == 1);
4774 _ => unreachable!(),
4777 // 1 => 0 commitment_signed_dance
4778 if update_1_0.update_fail_htlcs.len() > 0 {
4779 let mut fail_msg = update_1_0.update_fail_htlcs[0].clone();
4780 if test_case == 100 {
4781 callback_fail(&mut fail_msg);
4783 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
4785 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_1_0.update_fail_malformed_htlcs[0]);
4788 commitment_signed_dance!(nodes[0], nodes[1], update_1_0.commitment_signed, false, true);
4790 let events = nodes[0].node.get_and_clear_pending_events();
4791 assert_eq!(events.len(), 1);
4792 if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code } = &events[0] {
4793 assert_eq!(*rejected_by_dest, !expected_retryable);
4794 assert_eq!(*error_code, expected_error_code);
4796 panic!("Uexpected event");
4799 let events = nodes[0].node.get_and_clear_pending_msg_events();
4800 if expected_channel_update.is_some() {
4801 assert_eq!(events.len(), 1);
4803 MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
4805 &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {
4806 if let HTLCFailChannelUpdate::ChannelUpdateMessage { .. } = expected_channel_update.unwrap() {} else {
4807 panic!("channel_update not found!");
4810 &HTLCFailChannelUpdate::ChannelClosed { ref short_channel_id, ref is_permanent } => {
4811 if let HTLCFailChannelUpdate::ChannelClosed { short_channel_id: ref expected_short_channel_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
4812 assert!(*short_channel_id == *expected_short_channel_id);
4813 assert!(*is_permanent == *expected_is_permanent);
4815 panic!("Unexpected message event");
4818 &HTLCFailChannelUpdate::NodeFailure { ref node_id, ref is_permanent } => {
4819 if let HTLCFailChannelUpdate::NodeFailure { node_id: ref expected_node_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
4820 assert!(*node_id == *expected_node_id);
4821 assert!(*is_permanent == *expected_is_permanent);
4823 panic!("Unexpected message event");
4828 _ => panic!("Unexpected message event"),
4831 assert_eq!(events.len(), 0);
4835 impl msgs::ChannelUpdate {
4836 fn dummy() -> msgs::ChannelUpdate {
4837 use secp256k1::ffi::Signature as FFISignature;
4838 use secp256k1::Signature;
4839 msgs::ChannelUpdate {
4840 signature: Signature::from(FFISignature::new()),
4841 contents: msgs::UnsignedChannelUpdate {
4842 chain_hash: Sha256dHash::hash(&vec![0u8][..]),
4843 short_channel_id: 0,
4846 cltv_expiry_delta: 0,
4847 htlc_minimum_msat: 0,
4849 fee_proportional_millionths: 0,
4850 excess_data: vec![],
4857 fn test_onion_failure() {
4858 use ln::msgs::ChannelUpdate;
4859 use ln::channelmanager::CLTV_FAR_FAR_AWAY;
4862 const BADONION: u16 = 0x8000;
4863 const PERM: u16 = 0x4000;
4864 const NODE: u16 = 0x2000;
4865 const UPDATE: u16 = 0x1000;
4867 let mut nodes = create_network(3, &[None, None, None]);
4868 for node in nodes.iter() {
4869 *node.keys_manager.override_session_priv.lock().unwrap() = Some(SecretKey::from_slice(&[3; 32]).unwrap());
4871 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())];
4872 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
4873 let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV).unwrap();
4875 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 40000, 40_000);
4877 // intermediate node failure
4878 run_onion_failure_test("invalid_realm", 0, &nodes, &route, &payment_hash, |msg| {
4879 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4880 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
4881 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4882 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
4883 onion_payloads[0].realm = 3;
4884 msg.onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
4885 }, ||{}, 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
4887 // final node failure
4888 run_onion_failure_test("invalid_realm", 3, &nodes, &route, &payment_hash, |msg| {
4889 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4890 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
4891 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4892 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
4893 onion_payloads[1].realm = 3;
4894 msg.onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
4895 }, ||{}, false, Some(PERM|1), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
4897 // the following three with run_onion_failure_test_with_fail_intercept() test only the origin node
4898 // receiving simulated fail messages
4899 // intermediate node failure
4900 run_onion_failure_test_with_fail_intercept("temporary_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
4902 msg.amount_msat -= 1;
4904 // and tamper returning error message
4905 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4906 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4907 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], NODE|2, &[0;0]);
4908 }, ||{}, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: false}));
4910 // final node failure
4911 run_onion_failure_test_with_fail_intercept("temporary_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
4912 // and tamper returning error message
4913 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4914 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4915 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], NODE|2, &[0;0]);
4917 nodes[2].node.fail_htlc_backwards(&payment_hash);
4918 }, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: false}));
4920 // intermediate node failure
4921 run_onion_failure_test_with_fail_intercept("permanent_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
4922 msg.amount_msat -= 1;
4924 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4925 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4926 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|2, &[0;0]);
4927 }, ||{}, true, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: true}));
4929 // final node failure
4930 run_onion_failure_test_with_fail_intercept("permanent_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
4931 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4932 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4933 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|2, &[0;0]);
4935 nodes[2].node.fail_htlc_backwards(&payment_hash);
4936 }, false, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: true}));
4938 // intermediate node failure
4939 run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
4940 msg.amount_msat -= 1;
4942 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4943 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4944 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|3, &[0;0]);
4946 nodes[2].node.fail_htlc_backwards(&payment_hash);
4947 }, true, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: true}));
4949 // final node failure
4950 run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
4951 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4952 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4953 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|3, &[0;0]);
4955 nodes[2].node.fail_htlc_backwards(&payment_hash);
4956 }, false, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: true}));
4958 run_onion_failure_test("invalid_onion_version", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.version = 1; }, ||{}, true,
4959 Some(BADONION|PERM|4), None);
4961 run_onion_failure_test("invalid_onion_hmac", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.hmac = [3; 32]; }, ||{}, true,
4962 Some(BADONION|PERM|5), None);
4964 run_onion_failure_test("invalid_onion_key", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.public_key = Err(secp256k1::Error::InvalidPublicKey);}, ||{}, true,
4965 Some(BADONION|PERM|6), None);
4967 run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
4968 msg.amount_msat -= 1;
4970 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4971 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4972 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], UPDATE|7, &ChannelUpdate::dummy().encode_with_len()[..]);
4973 }, ||{}, true, Some(UPDATE|7), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
4975 run_onion_failure_test_with_fail_intercept("permanent_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
4976 msg.amount_msat -= 1;
4978 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4979 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4980 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|8, &[0;0]);
4981 // short_channel_id from the processing node
4982 }, ||{}, true, Some(PERM|8), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
4984 run_onion_failure_test_with_fail_intercept("required_channel_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
4985 msg.amount_msat -= 1;
4987 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4988 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4989 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|9, &[0;0]);
4990 // short_channel_id from the processing node
4991 }, ||{}, true, Some(PERM|9), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
4993 let mut bogus_route = route.clone();
4994 bogus_route.hops[1].short_channel_id -= 1;
4995 run_onion_failure_test("unknown_next_peer", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(PERM|10),
4996 Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: bogus_route.hops[1].short_channel_id, is_permanent:true}));
4998 let amt_to_forward = nodes[1].node.channel_state.lock().unwrap().by_id.get(&channels[1].2).unwrap().get_their_htlc_minimum_msat() - 1;
4999 let mut bogus_route = route.clone();
5000 let route_len = bogus_route.hops.len();
5001 bogus_route.hops[route_len-1].fee_msat = amt_to_forward;
5002 run_onion_failure_test("amount_below_minimum", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(UPDATE|11), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5004 //TODO: with new config API, we will be able to generate both valid and
5005 //invalid channel_update cases.
5006 run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, |msg| {
5007 msg.amount_msat -= 1;
5008 }, || {}, true, Some(UPDATE|12), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
5010 run_onion_failure_test("incorrect_cltv_expiry", 0, &nodes, &route, &payment_hash, |msg| {
5011 // need to violate: cltv_expiry - cltv_expiry_delta >= outgoing_cltv_value
5012 msg.cltv_expiry -= 1;
5013 }, || {}, true, Some(UPDATE|13), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
5015 run_onion_failure_test("expiry_too_soon", 0, &nodes, &route, &payment_hash, |msg| {
5016 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
5017 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5019 nodes[1].block_notifier.block_connected_checked(&header, height, &[], &[]);
5020 }, ||{}, true, Some(UPDATE|14), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5022 run_onion_failure_test("unknown_payment_hash", 2, &nodes, &route, &payment_hash, |_| {}, || {
5023 nodes[2].node.fail_htlc_backwards(&payment_hash);
5024 }, false, Some(PERM|15), None);
5026 run_onion_failure_test("final_expiry_too_soon", 1, &nodes, &route, &payment_hash, |msg| {
5027 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
5028 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5030 nodes[2].block_notifier.block_connected_checked(&header, height, &[], &[]);
5031 }, || {}, true, Some(17), None);
5033 run_onion_failure_test("final_incorrect_cltv_expiry", 1, &nodes, &route, &payment_hash, |_| {}, || {
5034 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
5035 for f in pending_forwards.iter_mut() {
5037 &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
5038 forward_info.outgoing_cltv_value += 1,
5043 }, true, Some(18), None);
5045 run_onion_failure_test("final_incorrect_htlc_amount", 1, &nodes, &route, &payment_hash, |_| {}, || {
5046 // violate amt_to_forward > msg.amount_msat
5047 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
5048 for f in pending_forwards.iter_mut() {
5050 &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
5051 forward_info.amt_to_forward -= 1,
5056 }, true, Some(19), None);
5058 run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, |_| {}, || {
5059 // disconnect event to the channel between nodes[1] ~ nodes[2]
5060 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
5061 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5062 }, true, Some(UPDATE|20), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5063 reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
5065 run_onion_failure_test("expiry_too_far", 0, &nodes, &route, &payment_hash, |msg| {
5066 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5067 let mut route = route.clone();
5069 route.hops[1].cltv_expiry_delta += CLTV_FAR_FAR_AWAY + route.hops[0].cltv_expiry_delta + 1;
5070 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5071 let (onion_payloads, _, htlc_cltv) = onion_utils::build_onion_payloads(&route, height).unwrap();
5072 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
5073 msg.cltv_expiry = htlc_cltv;
5074 msg.onion_routing_packet = onion_packet;
5075 }, ||{}, true, Some(21), None);
5080 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
5081 let nodes = create_network(2, &[None, None]);
5082 //Force duplicate channel ids
5083 for node in nodes.iter() {
5084 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
5087 // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
5088 let channel_value_satoshis=10000;
5089 let push_msat=10001;
5090 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).unwrap();
5091 let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5092 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::supported(), &node0_to_1_send_open_channel);
5094 //Create a second channel with a channel_id collision
5095 assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).is_err());
5099 fn bolt2_open_channel_sending_node_checks_part2() {
5100 let nodes = create_network(2, &[None, None]);
5102 // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
5103 let channel_value_satoshis=2^24;
5104 let push_msat=10001;
5105 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).is_err());
5107 // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
5108 let channel_value_satoshis=10000;
5109 // Test when push_msat is equal to 1000 * funding_satoshis.
5110 let push_msat=1000*channel_value_satoshis+1;
5111 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).is_err());
5113 // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
5114 let channel_value_satoshis=10000;
5115 let push_msat=10001;
5116 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
5117 let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5118 assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
5120 // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
5121 // 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
5122 assert!(node0_to_1_send_open_channel.channel_flags<=1);
5124 // 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.
5125 assert!(BREAKDOWN_TIMEOUT>0);
5126 assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
5128 // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
5129 let chain_hash=genesis_block(Network::Testnet).header.bitcoin_hash();
5130 assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
5132 // 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.
5133 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
5134 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
5135 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
5136 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_basepoint.serialize()).is_ok());
5137 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
5140 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
5141 // 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.
5142 //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.
5145 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
5146 //BOLT2 Requirement: MUST offer amount_msat greater than 0.
5147 //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
5148 let mut nodes = create_network(2, &[None, None]);
5149 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5150 let mut route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5151 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5153 route.hops[0].fee_msat = 0;
5155 let err = nodes[0].node.send_payment(route, our_payment_hash);
5157 if let Err(APIError::ChannelUnavailable{err}) = err {
5158 assert_eq!(err, "Cannot send less than their minimum HTLC value");
5162 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5163 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
5167 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
5168 //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
5169 //It is enforced when constructing a route.
5170 let mut nodes = create_network(2, &[None, None]);
5171 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 0, InitFeatures::supported(), InitFeatures::supported());
5172 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000000, 500000001).unwrap();
5173 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5175 let err = nodes[0].node.send_payment(route, our_payment_hash);
5177 if let Err(APIError::RouteError{err}) = err {
5178 assert_eq!(err, "Channel CLTV overflowed?!");
5185 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
5186 //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.
5187 //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
5188 //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
5189 let mut nodes = create_network(2, &[None, None]);
5190 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::supported(), InitFeatures::supported());
5191 let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().their_max_accepted_htlcs as u64;
5193 for i in 0..max_accepted_htlcs {
5194 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5195 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5196 let payment_event = {
5197 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5198 check_added_monitors!(nodes[0], 1);
5200 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5201 assert_eq!(events.len(), 1);
5202 if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
5203 assert_eq!(htlcs[0].htlc_id, i);
5207 SendEvent::from_event(events.remove(0))
5209 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
5210 check_added_monitors!(nodes[1], 0);
5211 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
5213 expect_pending_htlcs_forwardable!(nodes[1]);
5214 expect_payment_received!(nodes[1], our_payment_hash, 100000);
5216 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5217 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5218 let err = nodes[0].node.send_payment(route, our_payment_hash);
5220 if let Err(APIError::ChannelUnavailable{err}) = err {
5221 assert_eq!(err, "Cannot push more than their max accepted HTLCs");
5225 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5226 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
5230 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
5231 //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.
5232 let mut nodes = create_network(2, &[None, None]);
5233 let channel_value = 100000;
5234 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::supported(), InitFeatures::supported());
5235 let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).their_max_htlc_value_in_flight_msat;
5237 send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight, max_in_flight);
5239 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], max_in_flight+1, TEST_FINAL_CLTV).unwrap();
5240 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5241 let err = nodes[0].node.send_payment(route, our_payment_hash);
5243 if let Err(APIError::ChannelUnavailable{err}) = err {
5244 assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight our peer will accept");
5248 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5249 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);
5251 send_payment(&nodes[0], &[&nodes[1]], max_in_flight, max_in_flight);
5254 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
5256 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
5257 //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
5258 let mut nodes = create_network(2, &[None, None]);
5259 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5260 let htlc_minimum_msat: u64;
5262 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
5263 let channel = chan_lock.by_id.get(&chan.2).unwrap();
5264 htlc_minimum_msat = channel.get_our_htlc_minimum_msat();
5266 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], htlc_minimum_msat, TEST_FINAL_CLTV).unwrap();
5267 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5268 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5269 check_added_monitors!(nodes[0], 1);
5270 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5271 updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
5272 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5273 assert!(nodes[1].node.list_channels().is_empty());
5274 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5275 assert_eq!(err_msg.data, "Remote side tried to send less than our minimum HTLC value");
5279 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
5280 //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
5281 let mut nodes = create_network(2, &[None, None]);
5282 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5284 let their_channel_reserve = get_channel_value_stat!(nodes[0], chan.2).channel_reserve_msat;
5286 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 5000000-their_channel_reserve, TEST_FINAL_CLTV).unwrap();
5287 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5288 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5289 check_added_monitors!(nodes[0], 1);
5290 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5292 updates.update_add_htlcs[0].amount_msat = 5000000-their_channel_reserve+1;
5293 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5295 assert!(nodes[1].node.list_channels().is_empty());
5296 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5297 assert_eq!(err_msg.data, "Remote HTLC add would put them over their reserve value");
5301 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
5302 //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
5303 //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
5304 let mut nodes = create_network(2, &[None, None]);
5305 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5306 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 3999999, TEST_FINAL_CLTV).unwrap();
5307 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5309 let session_priv = SecretKey::from_slice(&{
5310 let mut session_key = [0; 32];
5311 let mut rng = thread_rng();
5312 rng.fill_bytes(&mut session_key);
5314 }).expect("RNG is bad!");
5316 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5317 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route, &session_priv).unwrap();
5318 let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
5319 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
5321 let mut msg = msgs::UpdateAddHTLC {
5325 payment_hash: our_payment_hash,
5326 cltv_expiry: htlc_cltv,
5327 onion_routing_packet: onion_packet.clone(),
5330 for i in 0..super::channel::OUR_MAX_HTLCS {
5331 msg.htlc_id = i as u64;
5332 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
5334 msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
5335 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
5337 assert!(nodes[1].node.list_channels().is_empty());
5338 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5339 assert_eq!(err_msg.data, "Remote tried to push more than our max accepted HTLCs");
5343 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
5344 //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
5345 let mut nodes = create_network(2, &[None, None]);
5346 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
5347 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5348 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5349 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5350 check_added_monitors!(nodes[0], 1);
5351 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5352 updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).their_max_htlc_value_in_flight_msat + 1;
5353 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5355 assert!(nodes[1].node.list_channels().is_empty());
5356 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5357 assert_eq!(err_msg.data,"Remote HTLC add would put them over our max HTLC value");
5361 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
5362 //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
5363 let mut nodes = create_network(2, &[None, None]);
5364 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5365 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 3999999, TEST_FINAL_CLTV).unwrap();
5366 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5367 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5368 check_added_monitors!(nodes[0], 1);
5369 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5370 updates.update_add_htlcs[0].cltv_expiry = 500000000;
5371 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5373 assert!(nodes[1].node.list_channels().is_empty());
5374 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5375 assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
5379 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
5380 //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
5381 // We test this by first testing that that repeated HTLCs pass commitment signature checks
5382 // after disconnect and that non-sequential htlc_ids result in a channel failure.
5383 let mut nodes = create_network(2, &[None, None]);
5384 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5385 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5386 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5387 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5388 check_added_monitors!(nodes[0], 1);
5389 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5390 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5392 //Disconnect and Reconnect
5393 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5394 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5395 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
5396 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
5397 assert_eq!(reestablish_1.len(), 1);
5398 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
5399 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
5400 assert_eq!(reestablish_2.len(), 1);
5401 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
5402 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
5403 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
5404 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
5407 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5408 assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
5409 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
5410 check_added_monitors!(nodes[1], 1);
5411 let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5413 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5415 assert!(nodes[1].node.list_channels().is_empty());
5416 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5417 assert_eq!(err_msg.data, "Remote skipped HTLC ID");
5421 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
5422 //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.
5424 let mut nodes = create_network(2, &[None, None]);
5425 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5427 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5428 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5429 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5430 check_added_monitors!(nodes[0], 1);
5431 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5432 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5434 let update_msg = msgs::UpdateFulfillHTLC{
5437 payment_preimage: our_payment_preimage,
5440 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5442 assert!(nodes[0].node.list_channels().is_empty());
5443 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5444 assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
5448 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
5449 //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.
5451 let mut nodes = create_network(2, &[None, None]);
5452 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5454 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5455 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5456 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5457 check_added_monitors!(nodes[0], 1);
5458 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5459 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5461 let update_msg = msgs::UpdateFailHTLC{
5464 reason: msgs::OnionErrorPacket { data: Vec::new()},
5467 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5469 assert!(nodes[0].node.list_channels().is_empty());
5470 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5471 assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
5475 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
5476 //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.
5478 let mut nodes = create_network(2, &[None, None]);
5479 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5481 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5482 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5483 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5484 check_added_monitors!(nodes[0], 1);
5485 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5486 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5488 let update_msg = msgs::UpdateFailMalformedHTLC{
5491 sha256_of_onion: [1; 32],
5492 failure_code: 0x8000,
5495 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5497 assert!(nodes[0].node.list_channels().is_empty());
5498 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5499 assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
5503 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
5504 //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
5506 let nodes = create_network(2, &[None, None]);
5507 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5509 let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
5511 nodes[1].node.claim_funds(our_payment_preimage, 100_000);
5512 check_added_monitors!(nodes[1], 1);
5514 let events = nodes[1].node.get_and_clear_pending_msg_events();
5515 assert_eq!(events.len(), 1);
5516 let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
5518 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, .. } } => {
5519 assert!(update_add_htlcs.is_empty());
5520 assert_eq!(update_fulfill_htlcs.len(), 1);
5521 assert!(update_fail_htlcs.is_empty());
5522 assert!(update_fail_malformed_htlcs.is_empty());
5523 assert!(update_fee.is_none());
5524 update_fulfill_htlcs[0].clone()
5526 _ => panic!("Unexpected event"),
5530 update_fulfill_msg.htlc_id = 1;
5532 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
5534 assert!(nodes[0].node.list_channels().is_empty());
5535 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5536 assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
5540 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
5541 //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.
5543 let nodes = create_network(2, &[None, None]);
5544 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5546 let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
5548 nodes[1].node.claim_funds(our_payment_preimage, 100_000);
5549 check_added_monitors!(nodes[1], 1);
5551 let events = nodes[1].node.get_and_clear_pending_msg_events();
5552 assert_eq!(events.len(), 1);
5553 let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
5555 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, .. } } => {
5556 assert!(update_add_htlcs.is_empty());
5557 assert_eq!(update_fulfill_htlcs.len(), 1);
5558 assert!(update_fail_htlcs.is_empty());
5559 assert!(update_fail_malformed_htlcs.is_empty());
5560 assert!(update_fee.is_none());
5561 update_fulfill_htlcs[0].clone()
5563 _ => panic!("Unexpected event"),
5567 update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
5569 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
5571 assert!(nodes[0].node.list_channels().is_empty());
5572 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5573 assert_eq!(err_msg.data, "Remote tried to fulfill HTLC with an incorrect preimage");
5578 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
5579 //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.
5581 let mut nodes = create_network(2, &[None, None]);
5582 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
5583 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5584 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5585 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5586 check_added_monitors!(nodes[0], 1);
5588 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5589 updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
5591 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5592 check_added_monitors!(nodes[1], 0);
5593 commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
5595 let events = nodes[1].node.get_and_clear_pending_msg_events();
5597 let mut update_msg: msgs::UpdateFailMalformedHTLC = {
5599 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, .. } } => {
5600 assert!(update_add_htlcs.is_empty());
5601 assert!(update_fulfill_htlcs.is_empty());
5602 assert!(update_fail_htlcs.is_empty());
5603 assert_eq!(update_fail_malformed_htlcs.len(), 1);
5604 assert!(update_fee.is_none());
5605 update_fail_malformed_htlcs[0].clone()
5607 _ => panic!("Unexpected event"),
5610 update_msg.failure_code &= !0x8000;
5611 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5613 assert!(nodes[0].node.list_channels().is_empty());
5614 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5615 assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
5619 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
5620 //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
5621 // * 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.
5623 let mut nodes = create_network(3, &[None, None, None]);
5624 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
5625 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
5627 let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
5628 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5631 let mut payment_event = {
5632 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5633 check_added_monitors!(nodes[0], 1);
5634 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5635 assert_eq!(events.len(), 1);
5636 SendEvent::from_event(events.remove(0))
5638 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
5639 check_added_monitors!(nodes[1], 0);
5640 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
5641 expect_pending_htlcs_forwardable!(nodes[1]);
5642 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
5643 assert_eq!(events_2.len(), 1);
5644 check_added_monitors!(nodes[1], 1);
5645 payment_event = SendEvent::from_event(events_2.remove(0));
5646 assert_eq!(payment_event.msgs.len(), 1);
5649 payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
5650 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
5651 check_added_monitors!(nodes[2], 0);
5652 commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
5654 let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
5655 assert_eq!(events_3.len(), 1);
5656 let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
5658 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 } } => {
5659 assert!(update_add_htlcs.is_empty());
5660 assert!(update_fulfill_htlcs.is_empty());
5661 assert!(update_fail_htlcs.is_empty());
5662 assert_eq!(update_fail_malformed_htlcs.len(), 1);
5663 assert!(update_fee.is_none());
5664 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
5666 _ => panic!("Unexpected event"),
5670 nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
5672 check_added_monitors!(nodes[1], 0);
5673 commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
5674 expect_pending_htlcs_forwardable!(nodes[1]);
5675 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
5676 assert_eq!(events_4.len(), 1);
5678 //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
5680 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, .. } } => {
5681 assert!(update_add_htlcs.is_empty());
5682 assert!(update_fulfill_htlcs.is_empty());
5683 assert_eq!(update_fail_htlcs.len(), 1);
5684 assert!(update_fail_malformed_htlcs.is_empty());
5685 assert!(update_fee.is_none());
5687 _ => panic!("Unexpected event"),
5690 check_added_monitors!(nodes[1], 1);
5693 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
5694 // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
5695 // 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
5696 // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
5698 let nodes = create_network(2, &[None, None]);
5699 let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5701 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
5703 // We route 2 dust-HTLCs between A and B
5704 let (_, payment_hash_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
5705 let (_, payment_hash_2) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
5706 route_payment(&nodes[0], &[&nodes[1]], 1000000);
5708 // Cache one local commitment tx as previous
5709 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();
5711 // Fail one HTLC to prune it in the will-be-latest-local commitment tx
5712 assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2));
5713 check_added_monitors!(nodes[1], 0);
5714 expect_pending_htlcs_forwardable!(nodes[1]);
5715 check_added_monitors!(nodes[1], 1);
5717 let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5718 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
5719 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
5720 check_added_monitors!(nodes[0], 1);
5722 // Cache one local commitment tx as lastest
5723 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();
5725 let events = nodes[0].node.get_and_clear_pending_msg_events();
5727 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
5728 assert_eq!(node_id, nodes[1].node.get_our_node_id());
5730 _ => panic!("Unexpected event"),
5733 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
5734 assert_eq!(node_id, nodes[1].node.get_our_node_id());
5736 _ => panic!("Unexpected event"),
5739 assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
5740 // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
5741 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5743 if announce_latest {
5744 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_last_commitment_tx[0].clone()]}, 1);
5746 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_prev_commitment_tx[0].clone()]}, 1);
5749 let events = nodes[0].node.get_and_clear_pending_msg_events();
5750 assert_eq!(events.len(), 1);
5752 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5753 _ => panic!("Unexpected event"),
5756 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
5757 connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
5758 let events = nodes[0].node.get_and_clear_pending_events();
5759 // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
5760 assert_eq!(events.len(), 2);
5761 let mut first_failed = false;
5762 for event in events {
5764 Event::PaymentFailed { payment_hash, .. } => {
5765 if payment_hash == payment_hash_1 {
5766 assert!(!first_failed);
5767 first_failed = true;
5769 assert_eq!(payment_hash, payment_hash_2);
5772 _ => panic!("Unexpected event"),
5778 fn test_failure_delay_dust_htlc_local_commitment() {
5779 do_test_failure_delay_dust_htlc_local_commitment(true);
5780 do_test_failure_delay_dust_htlc_local_commitment(false);
5784 fn test_no_failure_dust_htlc_local_commitment() {
5785 // Transaction filters for failing back dust htlc based on local commitment txn infos has been
5786 // prone to error, we test here that a dummy transaction don't fail them.
5788 let nodes = create_network(2, &[None, None]);
5789 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5792 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
5794 let as_dust_limit = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
5795 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
5797 // We route 2 dust-HTLCs between A and B
5798 let (preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
5799 let (preimage_2, _) = route_payment(&nodes[1], &[&nodes[0]], as_dust_limit*1000);
5801 // Build a dummy invalid transaction trying to spend a commitment tx
5803 previous_output: BitcoinOutPoint { txid: chan.3.txid(), vout: 0 },
5804 script_sig: Script::new(),
5806 witness: Vec::new(),
5810 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
5814 let dummy_tx = Transaction {
5821 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5822 nodes[0].chan_monitor.simple_monitor.block_connected(&header, 1, &[&dummy_tx], &[1;1]);
5823 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
5824 assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
5825 // We broadcast a few more block to check everything is all right
5826 connect_blocks(&nodes[0].block_notifier, 20, 1, true, header.bitcoin_hash());
5827 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
5828 assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
5830 claim_payment(&nodes[0], &vec!(&nodes[1])[..], preimage_1, bs_dust_limit*1000);
5831 claim_payment(&nodes[1], &vec!(&nodes[0])[..], preimage_2, as_dust_limit*1000);
5834 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
5835 // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
5836 // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
5837 // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
5838 // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
5839 // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
5840 // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
5842 let nodes = create_network(3, &[None, None, None]);
5843 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5845 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
5847 let (_payment_preimage_1, dust_hash) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
5848 let (_payment_preimage_2, non_dust_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
5850 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();
5851 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();
5853 // We revoked bs_commitment_tx
5855 let (payment_preimage_3, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
5856 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 1_000_000);
5859 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5860 let mut timeout_tx = Vec::new();
5862 // We fail dust-HTLC 1 by broadcast of local commitment tx
5863 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_commitment_tx[0].clone()]}, 1);
5864 let events = nodes[0].node.get_and_clear_pending_msg_events();
5865 assert_eq!(events.len(), 1);
5867 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5868 _ => panic!("Unexpected event"),
5870 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
5871 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
5872 let parent_hash = connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
5873 let events = nodes[0].node.get_and_clear_pending_events();
5874 assert_eq!(events.len(), 1);
5876 Event::PaymentFailed { payment_hash, .. } => {
5877 assert_eq!(payment_hash, dust_hash);
5879 _ => panic!("Unexpected event"),
5881 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5882 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
5883 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5884 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
5885 nodes[0].block_notifier.block_connected(&Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
5886 let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5887 connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
5888 let events = nodes[0].node.get_and_clear_pending_events();
5889 assert_eq!(events.len(), 1);
5891 Event::PaymentFailed { payment_hash, .. } => {
5892 assert_eq!(payment_hash, non_dust_hash);
5894 _ => panic!("Unexpected event"),
5897 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
5898 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![bs_commitment_tx[0].clone()]}, 1);
5899 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
5900 let events = nodes[0].node.get_and_clear_pending_msg_events();
5901 assert_eq!(events.len(), 1);
5903 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5904 _ => panic!("Unexpected event"),
5906 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
5907 let parent_hash = connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
5908 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5910 let events = nodes[0].node.get_and_clear_pending_events();
5911 assert_eq!(events.len(), 1);
5913 Event::PaymentFailed { payment_hash, .. } => {
5914 assert_eq!(payment_hash, dust_hash);
5916 _ => panic!("Unexpected event"),
5918 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5919 // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
5920 nodes[0].block_notifier.block_connected(&Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
5921 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
5922 let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5923 connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
5924 let events = nodes[0].node.get_and_clear_pending_events();
5925 assert_eq!(events.len(), 1);
5927 Event::PaymentFailed { payment_hash, .. } => {
5928 assert_eq!(payment_hash, non_dust_hash);
5930 _ => panic!("Unexpected event"),
5933 // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
5935 let events = nodes[0].node.get_and_clear_pending_events();
5936 assert_eq!(events.len(), 2);
5939 Event::PaymentFailed { payment_hash, .. } => {
5940 if payment_hash == dust_hash { first = true; }
5941 else { first = false; }
5943 _ => panic!("Unexpected event"),
5946 Event::PaymentFailed { payment_hash, .. } => {
5947 if first { assert_eq!(payment_hash, non_dust_hash); }
5948 else { assert_eq!(payment_hash, dust_hash); }
5950 _ => panic!("Unexpected event"),
5957 fn test_sweep_outbound_htlc_failure_update() {
5958 do_test_sweep_outbound_htlc_failure_update(false, true);
5959 do_test_sweep_outbound_htlc_failure_update(false, false);
5960 do_test_sweep_outbound_htlc_failure_update(true, false);
5964 fn test_upfront_shutdown_script() {
5965 // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
5966 // enforce it at shutdown message
5968 let mut config = UserConfig::default();
5969 config.channel_options.announced_channel = true;
5970 config.peer_channel_config_limits.force_announced_channel_preference = false;
5971 config.channel_options.commit_upfront_shutdown_pubkey = false;
5972 let cfgs = [None, Some(config), None];
5973 let nodes = create_network(3, &cfgs);
5975 // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
5976 let flags = InitFeatures::supported();
5977 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
5978 nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
5979 let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
5980 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
5981 // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that we disconnect peer
5982 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
5983 let events = nodes[2].node.get_and_clear_pending_msg_events();
5984 assert_eq!(events.len(), 2);
5986 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5987 _ => panic!("Unexpected event"),
5989 if let MessageSendEvent::HandleError { ref action, .. } = events[1] {
5991 &ErrorAction::SendErrorMessage { ref msg } => {
5992 assert_eq!(msg.data,"Got shutdown request with a scriptpubkey which did not match their previous scriptpubkey");
5994 _ => { assert!(false); }
5996 } else { assert!(false); }
5998 // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
5999 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
6000 nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6001 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
6002 // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
6003 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
6004 let events = nodes[2].node.get_and_clear_pending_msg_events();
6005 assert_eq!(events.len(), 1);
6007 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
6008 _ => panic!("Unexpected event"),
6011 // We test that if case of peer non-signaling we don't enforce committed script at channel opening
6012 let mut flags_no = InitFeatures::supported();
6013 flags_no.unset_upfront_shutdown_script();
6014 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
6015 nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6016 let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
6017 node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6018 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_1_shutdown);
6019 let events = nodes[1].node.get_and_clear_pending_msg_events();
6020 assert_eq!(events.len(), 1);
6022 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
6023 _ => panic!("Unexpected event"),
6026 // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
6027 // channel smoothly, opt-out is from channel initiator here
6028 let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
6029 nodes[1].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6030 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
6031 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6032 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
6033 let events = nodes[0].node.get_and_clear_pending_msg_events();
6034 assert_eq!(events.len(), 1);
6036 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6037 _ => panic!("Unexpected event"),
6040 //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
6041 //// channel smoothly
6042 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
6043 nodes[1].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6044 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
6045 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6046 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
6047 let events = nodes[0].node.get_and_clear_pending_msg_events();
6048 assert_eq!(events.len(), 2);
6050 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6051 _ => panic!("Unexpected event"),
6054 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6055 _ => panic!("Unexpected event"),
6060 fn test_user_configurable_csv_delay() {
6061 // We test our channel constructors yield errors when we pass them absurd csv delay
6063 let mut low_our_to_self_config = UserConfig::default();
6064 low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
6065 let mut high_their_to_self_config = UserConfig::default();
6066 high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
6067 let cfgs = [Some(high_their_to_self_config.clone()), None];
6068 let nodes = create_network(2, &cfgs);
6070 // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
6071 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())));
6072 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) {
6074 APIError::APIMisuseError { err } => { assert_eq!(err, "Configured with an unreasonable our_to_self_delay putting user funds at risks"); },
6075 _ => panic!("Unexpected event"),
6077 } else { assert!(false) }
6079 // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
6080 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42).unwrap();
6081 let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
6082 open_channel.to_self_delay = 200;
6083 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) {
6085 ChannelError::Close(err) => { assert_eq!(err, "Configured with an unreasonable our_to_self_delay putting user funds at risks"); },
6086 _ => panic!("Unexpected event"),
6088 } else { assert!(false); }
6090 // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
6091 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42).unwrap();
6092 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()));
6093 let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
6094 accept_channel.to_self_delay = 200;
6095 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::supported(), &accept_channel);
6096 if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
6098 &ErrorAction::SendErrorMessage { ref msg } => {
6099 assert_eq!(msg.data,"They wanted our payments to be delayed by a needlessly long period");
6101 _ => { assert!(false); }
6103 } else { assert!(false); }
6105 // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
6106 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42).unwrap();
6107 let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
6108 open_channel.to_self_delay = 200;
6109 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) {
6111 ChannelError::Close(err) => { assert_eq!(err, "They wanted our payments to be delayed by a needlessly long period"); },
6112 _ => panic!("Unexpected event"),
6114 } else { assert!(false); }
6118 fn test_data_loss_protect() {
6119 // We want to be sure that :
6120 // * we don't broadcast our Local Commitment Tx in case of fallen behind
6121 // * we close channel in case of detecting other being fallen behind
6122 // * we are able to claim our own outputs thanks to remote my_current_per_commitment_point
6123 let mut nodes = create_network(2, &[None, None]);
6125 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
6127 // Cache node A state before any channel update
6128 let previous_node_state = nodes[0].node.encode();
6129 let mut previous_chan_monitor_state = test_utils::TestVecWriter(Vec::new());
6130 nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut previous_chan_monitor_state).unwrap();
6132 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
6133 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
6135 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6136 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6138 // Restore node A from previous state
6139 let logger: Arc<Logger> = Arc::new(test_utils::TestLogger::with_id(format!("node {}", 0)));
6140 let mut chan_monitor = <(Sha256dHash, ChannelMonitor)>::read(&mut ::std::io::Cursor::new(previous_chan_monitor_state.0), Arc::clone(&logger)).unwrap().1;
6141 let chain_monitor = Arc::new(ChainWatchInterfaceUtil::new(Network::Testnet, Arc::clone(&logger)));
6142 let tx_broadcaster = Arc::new(test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())});
6143 let feeest = Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 });
6144 let monitor = Arc::new(test_utils::TestChannelMonitor::new(chain_monitor.clone(), tx_broadcaster.clone(), logger.clone(), feeest.clone()));
6145 let node_state_0 = {
6146 let mut channel_monitors = HashMap::new();
6147 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chan_monitor);
6148 <(Sha256dHash, ChannelManager<EnforcingChannelKeys>)>::read(&mut ::std::io::Cursor::new(previous_node_state), ChannelManagerReadArgs {
6149 keys_manager: Arc::new(test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::clone(&logger))),
6150 fee_estimator: feeest.clone(),
6151 monitor: monitor.clone(),
6152 logger: Arc::clone(&logger),
6154 default_config: UserConfig::default(),
6155 channel_monitors: &mut channel_monitors
6158 nodes[0].node = Arc::new(node_state_0);
6159 assert!(monitor.add_update_monitor(OutPoint { txid: chan.3.txid(), index: 0 }, chan_monitor.clone()).is_ok());
6160 nodes[0].chan_monitor = monitor;
6161 nodes[0].chain_monitor = chain_monitor;
6163 let weak_res = Arc::downgrade(&nodes[0].chan_monitor.simple_monitor);
6164 nodes[0].block_notifier.register_listener(weak_res);
6165 let weak_res = Arc::downgrade(&nodes[0].node);
6166 nodes[0].block_notifier.register_listener(weak_res);
6168 check_added_monitors!(nodes[0], 1);
6170 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6171 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6173 let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6175 // Check we update monitor following learning of per_commitment_point from B
6176 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
6177 check_added_monitors!(nodes[0], 1);
6180 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
6181 assert_eq!(node_txn.len(), 0);
6184 let mut reestablish_1 = Vec::with_capacity(1);
6185 for msg in nodes[0].node.get_and_clear_pending_msg_events() {
6186 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
6187 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
6188 reestablish_1.push(msg.clone());
6189 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
6190 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
6192 &ErrorAction::SendErrorMessage { ref msg } => {
6193 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");
6195 _ => panic!("Unexpected event!"),
6198 panic!("Unexpected event")
6202 // Check we close channel detecting A is fallen-behind
6203 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6204 let events = nodes[1].node.get_and_clear_pending_msg_events();
6205 assert_eq!(events.len(), 2);
6207 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
6208 _ => panic!("Unexpected event"),
6211 MessageSendEvent::HandleError { ref action, .. } => {
6213 &ErrorAction::SendErrorMessage { ref msg } => {
6214 assert_eq!(msg.data, "Peer attempted to reestablish channel with a very old local commitment transaction"); },
6215 _ => panic!("Unexpected event!"),
6218 _ => panic!("Unexpected event"),
6221 // Check A is able to claim to_remote output
6222 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
6223 assert_eq!(node_txn.len(), 1);
6224 check_spends!(node_txn[0], chan.3.clone());
6225 assert_eq!(node_txn[0].output.len(), 2);
6226 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
6227 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()]}, 1);
6228 let spend_txn = check_spendable_outputs!(nodes[0], 1);
6229 assert_eq!(spend_txn.len(), 1);
6230 check_spends!(spend_txn[0], node_txn[0].clone());
6234 fn test_check_htlc_underpaying() {
6235 // Send payment through A -> B but A is maliciously
6236 // sending a probe payment (i.e less than expected value0
6237 // to B, B should refuse payment.
6239 let nodes = create_network(2, &[None, None, None]);
6241 // Create some initial channels
6242 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6244 let (payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 10_000);
6246 // Node 3 is expecting payment of 100_000 but receive 10_000,
6247 // fail htlc like we didn't know the preimage.
6248 nodes[1].node.claim_funds(payment_preimage, 100_000);
6249 nodes[1].node.process_pending_htlc_forwards();
6251 let events = nodes[1].node.get_and_clear_pending_msg_events();
6252 assert_eq!(events.len(), 1);
6253 let (update_fail_htlc, commitment_signed) = match events[0] {
6254 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 } } => {
6255 assert!(update_add_htlcs.is_empty());
6256 assert!(update_fulfill_htlcs.is_empty());
6257 assert_eq!(update_fail_htlcs.len(), 1);
6258 assert!(update_fail_malformed_htlcs.is_empty());
6259 assert!(update_fee.is_none());
6260 (update_fail_htlcs[0].clone(), commitment_signed)
6262 _ => panic!("Unexpected event"),
6264 check_added_monitors!(nodes[1], 1);
6266 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
6267 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
6269 let events = nodes[0].node.get_and_clear_pending_events();
6270 assert_eq!(events.len(), 1);
6271 if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code } = &events[0] {
6272 assert_eq!(*rejected_by_dest, true);
6273 assert_eq!(error_code.unwrap(), 0x4000|15);
6275 panic!("Unexpected event");
6277 nodes[1].node.get_and_clear_pending_events();
6281 fn test_announce_disable_channels() {
6282 // Create 2 channels between A and B. Disconnect B. Call timer_chan_freshness_every_min and check for generated
6283 // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
6285 let nodes = create_network(2, &[None, None]);
6287 let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
6288 let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
6289 let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
6292 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6293 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6295 nodes[0].node.timer_chan_freshness_every_min(); // dirty -> stagged
6296 nodes[0].node.timer_chan_freshness_every_min(); // staged -> fresh
6297 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
6298 assert_eq!(msg_events.len(), 3);
6299 for e in msg_events {
6301 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
6302 let short_id = msg.contents.short_channel_id;
6303 // Check generated channel_update match list in PendingChannelUpdate
6304 if short_id != short_id_1 && short_id != short_id_2 && short_id != short_id_3 {
6305 panic!("Generated ChannelUpdate for wrong chan!");
6308 _ => panic!("Unexpected event"),
6312 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6313 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6314 assert_eq!(reestablish_1.len(), 3);
6315 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6316 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6317 assert_eq!(reestablish_2.len(), 3);
6319 // Reestablish chan_1
6320 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6321 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6322 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6323 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6324 // Reestablish chan_2
6325 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
6326 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6327 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
6328 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6329 // Reestablish chan_3
6330 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
6331 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6332 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
6333 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6335 nodes[0].node.timer_chan_freshness_every_min();
6336 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6340 fn test_bump_penalty_txn_on_revoked_commitment() {
6341 // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
6342 // we're able to claim outputs on revoked commitment transaction before timelocks expiration
6344 let nodes = create_network(2, &[None, None]);
6346 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
6347 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
6348 let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 3000000, 30).unwrap();
6349 send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
6351 let revoked_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
6352 // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
6353 assert_eq!(revoked_txn[0].output.len(), 4);
6354 assert_eq!(revoked_txn[0].input.len(), 1);
6355 assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
6356 let revoked_txid = revoked_txn[0].txid();
6358 let mut penalty_sum = 0;
6359 for outp in revoked_txn[0].output.iter() {
6360 if outp.script_pubkey.is_v0_p2wsh() {
6361 penalty_sum += outp.value;
6365 // Connect blocks to change height_timer range to see if we use right soonest_timelock
6366 let header_114 = connect_blocks(&nodes[1].block_notifier, 114, 0, false, Default::default());
6368 // Actually revoke tx by claiming a HTLC
6369 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
6370 let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6371 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_txn[0].clone()] }, 115);
6373 // One or more justice tx should have been broadcast, check it
6377 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6378 assert_eq!(node_txn.len(), 4); // justice tx (broadcasted from ChannelMonitor) * 2 (block-reparsing) + local commitment tx + local HTLC-timeout (broadcasted from ChannelManager)
6379 assert_eq!(node_txn[0], node_txn[3]);
6380 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
6381 assert_eq!(node_txn[0].output.len(), 1);
6382 check_spends!(node_txn[0], revoked_txn[0].clone());
6383 let fee_1 = penalty_sum - node_txn[0].output[0].value;
6384 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
6385 penalty_1 = node_txn[0].txid();
6389 // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
6390 let header = connect_blocks(&nodes[1].block_notifier, 3, 115, true, header.bitcoin_hash());
6391 let mut penalty_2 = penalty_1;
6392 let mut feerate_2 = 0;
6394 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6395 assert_eq!(node_txn.len(), 1);
6396 if node_txn[0].input[0].previous_output.txid == revoked_txid {
6397 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
6398 assert_eq!(node_txn[0].output.len(), 1);
6399 check_spends!(node_txn[0], revoked_txn[0].clone());
6400 penalty_2 = node_txn[0].txid();
6401 // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
6402 assert_ne!(penalty_2, penalty_1);
6403 let fee_2 = penalty_sum - node_txn[0].output[0].value;
6404 feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
6405 // Verify 25% bump heuristic
6406 assert!(feerate_2 * 100 >= feerate_1 * 125);
6410 assert_ne!(feerate_2, 0);
6412 // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
6413 connect_blocks(&nodes[1].block_notifier, 3, 118, true, header);
6415 let mut feerate_3 = 0;
6417 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6418 assert_eq!(node_txn.len(), 1);
6419 if node_txn[0].input[0].previous_output.txid == revoked_txid {
6420 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
6421 assert_eq!(node_txn[0].output.len(), 1);
6422 check_spends!(node_txn[0], revoked_txn[0].clone());
6423 penalty_3 = node_txn[0].txid();
6424 // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
6425 assert_ne!(penalty_3, penalty_2);
6426 let fee_3 = penalty_sum - node_txn[0].output[0].value;
6427 feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
6428 // Verify 25% bump heuristic
6429 assert!(feerate_3 * 100 >= feerate_2 * 125);
6433 assert_ne!(feerate_3, 0);
6435 nodes[1].node.get_and_clear_pending_events();
6436 nodes[1].node.get_and_clear_pending_msg_events();
6440 fn test_bump_penalty_txn_on_revoked_htlcs() {
6441 // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
6442 // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
6444 let nodes = create_network(2, &[None, None]);
6446 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
6447 // Lock HTLC in both directions
6448 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3_000_000).0;
6449 route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
6451 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();
6452 assert_eq!(revoked_local_txn[0].input.len(), 1);
6453 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
6455 // Revoke local commitment tx
6456 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
6458 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6459 // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
6460 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
6461 check_closed_broadcast!(nodes[1], false);
6463 let mut received = ::std::usize::MAX;
6464 let mut offered = ::std::usize::MAX;
6465 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6466 assert_eq!(revoked_htlc_txn.len(), 6);
6467 if revoked_htlc_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
6468 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
6469 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
6470 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
6471 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
6472 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0].clone());
6475 } else if revoked_htlc_txn[1].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
6476 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
6477 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0].clone());
6478 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
6479 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
6480 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
6485 // Broadcast set of revoked txn on A
6486 let header_128 = connect_blocks(&nodes[0].block_notifier, 128, 0, true, header.bitcoin_hash());
6487 let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6488 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);
6494 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6495 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
6496 // Verify claim tx are spending revoked HTLC txn
6497 assert_eq!(node_txn[7].input.len(), 1);
6498 assert_eq!(node_txn[7].output.len(), 1);
6499 check_spends!(node_txn[7], revoked_htlc_txn[0].clone());
6500 first = node_txn[7].txid();
6501 assert_eq!(node_txn[8].input.len(), 1);
6502 assert_eq!(node_txn[8].output.len(), 1);
6503 check_spends!(node_txn[8], revoked_htlc_txn[1].clone());
6504 second = node_txn[8].txid();
6505 // Store both feerates for later comparison
6506 let fee_1 = revoked_htlc_txn[0].output[0].value - node_txn[7].output[0].value;
6507 feerate_1 = fee_1 * 1000 / node_txn[7].get_weight() as u64;
6508 let fee_2 = revoked_htlc_txn[1].output[0].value - node_txn[8].output[0].value;
6509 feerate_2 = fee_2 * 1000 / node_txn[8].get_weight() as u64;
6513 // Connect three more block to see if bumped penalty are issued for HTLC txn
6514 let header_132 = connect_blocks(&nodes[0].block_notifier, 3, 129, true, header_129.bitcoin_hash());
6516 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6517 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
6519 check_spends!(node_txn[0], revoked_local_txn[0].clone());
6520 check_spends!(node_txn[1], revoked_local_txn[0].clone());
6522 let mut penalty_local = ::std::usize::MAX;
6523 let mut penalty_offered = ::std::usize::MAX;
6524 let mut penalty_received = ::std::usize::MAX;
6527 let iter_txn = node_txn[2..].iter();
6528 for (i, tx) in iter_txn.enumerate() {
6529 if tx.input[0].previous_output.txid == revoked_local_txn[0].txid() {
6530 penalty_local = 2 + i;
6531 } else if tx.input[0].previous_output.txid == revoked_htlc_txn[offered].txid() {
6532 penalty_offered = 2+ i;
6533 } else if tx.input[0].previous_output.txid == revoked_htlc_txn[received].txid() {
6534 penalty_received = 2 + i;
6538 check_spends!(node_txn[penalty_local], revoked_local_txn[0].clone());
6540 assert_eq!(node_txn[penalty_received].input.len(), 1);
6541 assert_eq!(node_txn[penalty_received].output.len(), 1);
6542 assert_eq!(node_txn[penalty_offered].input.len(), 1);
6543 assert_eq!(node_txn[penalty_offered].output.len(), 1);
6544 // Verify bumped tx is different and 25% bump heuristic
6545 check_spends!(node_txn[penalty_offered], revoked_htlc_txn[offered].clone());
6546 assert_ne!(first, node_txn[penalty_offered].txid());
6547 let fee = revoked_htlc_txn[offered].output[0].value - node_txn[penalty_offered].output[0].value;
6548 let new_feerate = fee * 1000 / node_txn[penalty_offered].get_weight() as u64;
6549 assert!(new_feerate * 100 > feerate_1 * 125);
6551 check_spends!(node_txn[penalty_received], revoked_htlc_txn[received].clone());
6552 assert_ne!(second, node_txn[penalty_received].txid());
6553 let fee = revoked_htlc_txn[received].output[0].value - node_txn[penalty_received].output[0].value;
6554 let new_feerate = fee * 1000 / node_txn[penalty_received].get_weight() as u64;
6555 assert!(new_feerate * 100 > feerate_2 * 125);
6556 let txn = vec![node_txn[2].clone(), node_txn[3].clone(), node_txn[4].clone()];
6560 // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
6561 let header_133 = BlockHeader { version: 0x20000000, prev_blockhash: header_132, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6562 nodes[0].block_notifier.block_connected(&Block { header: header_133, txdata: node_txn }, 133);
6563 let header_140 = connect_blocks(&nodes[0].block_notifier, 6, 134, true, header_133.bitcoin_hash());
6565 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6569 // Connect few more blocks and check only penalty transaction for to_local output have been issued
6570 connect_blocks(&nodes[0].block_notifier, 7, 140, true, header_140);
6572 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6573 assert_eq!(node_txn.len(), 2); //TODO: should be zero when we fix check_spend_remote_htlc
6576 check_closed_broadcast!(nodes[0], false);
6580 fn test_bump_penalty_txn_on_remote_commitment() {
6581 // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
6582 // we're able to claim outputs on remote commitment transaction before timelocks expiration
6585 // Provide preimage for one
6586 // Check aggregation
6588 let nodes = create_network(2, &[None, None]);
6590 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
6591 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
6592 route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
6594 // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
6595 let remote_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
6596 assert_eq!(remote_txn[0].output.len(), 4);
6597 assert_eq!(remote_txn[0].input.len(), 1);
6598 assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
6600 // Claim a HTLC without revocation (provide B monitor with preimage)
6601 nodes[1].node.claim_funds(payment_preimage, 3_000_000);
6602 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6603 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
6604 check_added_monitors!(nodes[1], 1);
6606 // One or more claim tx should have been broadcast, check it
6609 let feerate_timeout;
6610 let feerate_preimage;
6612 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6613 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)
6614 assert_eq!(node_txn[0], node_txn[5]);
6615 assert_eq!(node_txn[1], node_txn[6]);
6616 assert_eq!(node_txn[0].input.len(), 1);
6617 assert_eq!(node_txn[1].input.len(), 1);
6618 check_spends!(node_txn[0], remote_txn[0].clone());
6619 check_spends!(node_txn[1], remote_txn[0].clone());
6620 check_spends!(node_txn[2], chan.3);
6621 check_spends!(node_txn[3], node_txn[2]);
6622 check_spends!(node_txn[4], node_txn[2]);
6623 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
6624 timeout = node_txn[0].txid();
6625 let index = node_txn[0].input[0].previous_output.vout;
6626 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
6627 feerate_timeout = fee * 1000 / node_txn[0].get_weight() as u64;
6629 preimage = node_txn[1].txid();
6630 let index = node_txn[1].input[0].previous_output.vout;
6631 let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
6632 feerate_preimage = fee * 1000 / node_txn[1].get_weight() as u64;
6634 timeout = node_txn[1].txid();
6635 let index = node_txn[1].input[0].previous_output.vout;
6636 let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
6637 feerate_timeout = fee * 1000 / node_txn[1].get_weight() as u64;
6639 preimage = node_txn[0].txid();
6640 let index = node_txn[0].input[0].previous_output.vout;
6641 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
6642 feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
6646 assert_ne!(feerate_timeout, 0);
6647 assert_ne!(feerate_preimage, 0);
6649 // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
6650 connect_blocks(&nodes[1].block_notifier, 15, 1, true, header.bitcoin_hash());
6652 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6653 assert_eq!(node_txn.len(), 2);
6654 assert_eq!(node_txn[0].input.len(), 1);
6655 assert_eq!(node_txn[1].input.len(), 1);
6656 check_spends!(node_txn[0], remote_txn[0].clone());
6657 check_spends!(node_txn[1], remote_txn[0].clone());
6658 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
6659 let index = node_txn[0].input[0].previous_output.vout;
6660 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
6661 let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
6662 assert!(new_feerate * 100 > feerate_timeout * 125);
6663 assert_ne!(timeout, node_txn[0].txid());
6665 let index = node_txn[1].input[0].previous_output.vout;
6666 let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
6667 let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
6668 assert!(new_feerate * 100 > feerate_preimage * 125);
6669 assert_ne!(preimage, node_txn[1].txid());
6671 let index = node_txn[1].input[0].previous_output.vout;
6672 let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
6673 let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
6674 assert!(new_feerate * 100 > feerate_timeout * 125);
6675 assert_ne!(timeout, node_txn[1].txid());
6677 let index = node_txn[0].input[0].previous_output.vout;
6678 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
6679 let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
6680 assert!(new_feerate * 100 > feerate_preimage * 125);
6681 assert_ne!(preimage, node_txn[0].txid());
6686 nodes[1].node.get_and_clear_pending_events();
6687 nodes[1].node.get_and_clear_pending_msg_events();
6691 fn test_set_outpoints_partial_claiming() {
6692 // - remote party claim tx, new bump tx
6693 // - disconnect remote claiming tx, new bump
6694 // - disconnect tx, see no tx anymore
6695 let nodes = create_network(2, &[None, None]);
6697 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
6698 let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
6699 let payment_preimage_2 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
6701 // Remote commitment txn with 4 outputs: to_local, to_remote, 2 outgoing HTLC
6702 let remote_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
6703 assert_eq!(remote_txn.len(), 3);
6704 assert_eq!(remote_txn[0].output.len(), 4);
6705 assert_eq!(remote_txn[0].input.len(), 1);
6706 assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
6707 check_spends!(remote_txn[1], remote_txn[0].clone());
6708 check_spends!(remote_txn[2], remote_txn[0].clone());
6710 // Connect blocks on node A to advance height towards TEST_FINAL_CLTV
6711 let prev_header_100 = connect_blocks(&nodes[1].block_notifier, 100, 0, false, Default::default());
6712 // Provide node A with both preimage
6713 nodes[0].node.claim_funds(payment_preimage_1, 3_000_000);
6714 nodes[0].node.claim_funds(payment_preimage_2, 3_000_000);
6715 check_added_monitors!(nodes[0], 2);
6716 nodes[0].node.get_and_clear_pending_events();
6717 nodes[0].node.get_and_clear_pending_msg_events();
6719 // Connect blocks on node A commitment transaction
6720 let header = BlockHeader { version: 0x20000000, prev_blockhash: prev_header_100, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6721 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 101);
6722 // Verify node A broadcast tx claiming both HTLCs
6724 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6725 assert_eq!(node_txn.len(), 5);
6726 assert_eq!(node_txn[0], node_txn[4]);
6727 check_spends!(node_txn[0], remote_txn[0].clone());
6728 check_spends!(node_txn[1], chan.3.clone());
6729 check_spends!(node_txn[2], node_txn[1]);
6730 check_spends!(node_txn[3], node_txn[1]);
6731 assert_eq!(node_txn[0].input.len(), 2);
6734 nodes[0].node.get_and_clear_pending_msg_events();
6736 // Connect blocks on node B
6737 connect_blocks(&nodes[1].block_notifier, 135, 0, false, Default::default());
6738 // Verify node B broadcast 2 HTLC-timeout txn
6739 let partial_claim_tx = {
6740 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6741 assert_eq!(node_txn.len(), 3);
6742 check_spends!(node_txn[1], node_txn[0].clone());
6743 check_spends!(node_txn[2], node_txn[0].clone());
6744 assert_eq!(node_txn[1].input.len(), 1);
6745 assert_eq!(node_txn[2].input.len(), 1);
6748 nodes[1].node.get_and_clear_pending_msg_events();
6750 // Broadcast partial claim on node A, should regenerate a claiming tx with HTLC dropped
6751 let header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6752 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![partial_claim_tx.clone()] }, 102);
6754 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6755 assert_eq!(node_txn.len(), 1);
6756 check_spends!(node_txn[0], remote_txn[0].clone());
6757 assert_eq!(node_txn[0].input.len(), 1); //dropped HTLC
6760 nodes[0].node.get_and_clear_pending_msg_events();
6762 // Disconnect last block on node A, should regenerate a claiming tx with HTLC dropped
6763 nodes[0].block_notifier.block_disconnected(&header, 102);
6765 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6766 assert_eq!(node_txn.len(), 1);
6767 check_spends!(node_txn[0], remote_txn[0].clone());
6768 assert_eq!(node_txn[0].input.len(), 2); //resurrected HTLC
6772 //// Disconnect one more block and then reconnect multiple no transaction should be generated
6773 nodes[0].block_notifier.block_disconnected(&header, 101);
6774 connect_blocks(&nodes[1].block_notifier, 15, 101, false, prev_header_100);
6776 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6777 assert_eq!(node_txn.len(), 0);
6783 fn test_bump_txn_sanitize_tracking_maps() {
6784 // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
6785 // verify we clean then right after expiration of ANTI_REORG_DELAY.
6787 let nodes = create_network(2, &[None, None]);
6789 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
6790 // Lock HTLC in both directions
6791 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
6792 route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
6794 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();
6795 assert_eq!(revoked_local_txn[0].input.len(), 1);
6796 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
6798 // Revoke local commitment tx
6799 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 9_000_000);
6801 // Broadcast set of revoked txn on A
6802 let header_128 = connect_blocks(&nodes[0].block_notifier, 128, 0, false, Default::default());
6803 let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6804 nodes[0].block_notifier.block_connected(&Block { header: header_129, txdata: vec![revoked_local_txn[0].clone()] }, 129);
6805 check_closed_broadcast!(nodes[0], false);
6807 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6808 assert_eq!(node_txn.len(), 7);
6809 check_spends!(node_txn[0], revoked_local_txn[0].clone());
6810 check_spends!(node_txn[1], revoked_local_txn[0].clone());
6811 check_spends!(node_txn[2], revoked_local_txn[0].clone());
6812 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
6816 let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6817 nodes[0].block_notifier.block_connected(&Block { header: header_130, txdata: penalty_txn }, 130);
6818 connect_blocks(&nodes[0].block_notifier, 5, 130, false, header_130.bitcoin_hash());
6820 let monitors = nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap();
6821 if let Some(monitor) = monitors.get(&OutPoint::new(chan.3.txid(), 0)) {
6822 assert!(monitor.pending_claim_requests.is_empty());
6823 assert!(monitor.claimable_outpoints.is_empty());