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::keysinterface::{KeysInterface, SpendableOutputDescriptor};
7 use chain::chaininterface::{ChainListener, ChainWatchInterfaceUtil, BlockNotifier};
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, Writer, 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 node_cfgs = create_node_cfgs(2);
57 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
58 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
60 // Instantiate channel parameters where we push the maximum msats given our
62 let channel_value_sat = 31337; // same as funding satoshis
63 let channel_reserve_satoshis = Channel::<EnforcingChannelKeys>::get_our_channel_reserve_satoshis(channel_value_sat);
64 let push_msat = (channel_value_sat - channel_reserve_satoshis) * 1000;
66 // Have node0 initiate a channel to node1 with aforementioned parameters
67 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_sat, push_msat, 42).unwrap();
69 // Extract the channel open message from node0 to node1
70 let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
72 // Test helper that asserts we get the correct error string given a mutator
73 // that supposedly makes the channel open message insane
74 let insane_open_helper = |expected_error_str: &str, message_mutator: fn(msgs::OpenChannel) -> msgs::OpenChannel| {
75 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::supported(), &message_mutator(open_channel_message.clone()));
76 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
77 assert_eq!(msg_events.len(), 1);
78 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
80 &ErrorAction::SendErrorMessage { .. } => {
81 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), expected_error_str.to_string(), 1);
83 _ => panic!("unexpected event!"),
85 } else { assert!(false); }
88 use ln::channel::MAX_FUNDING_SATOSHIS;
89 use ln::channelmanager::MAX_LOCAL_BREAKDOWN_TIMEOUT;
91 // Test all mutations that would make the channel open message insane
92 insane_open_helper("funding value > 2^24", |mut msg| { msg.funding_satoshis = MAX_FUNDING_SATOSHIS; msg });
94 insane_open_helper("Bogus channel_reserve_satoshis", |mut msg| { msg.channel_reserve_satoshis = msg.funding_satoshis + 1; msg });
96 insane_open_helper("push_msat larger than funding value", |mut msg| { msg.push_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 + 1; msg });
98 insane_open_helper("Peer never wants payout outputs?", |mut msg| { msg.dust_limit_satoshis = msg.funding_satoshis + 1 ; msg });
100 insane_open_helper("Bogus; channel reserve is less than dust limit", |mut msg| { msg.dust_limit_satoshis = msg.channel_reserve_satoshis + 1; msg });
102 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 });
104 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 });
106 insane_open_helper("0 max_accpted_htlcs makes for a useless channel", |mut msg| { msg.max_accepted_htlcs = 0; msg });
108 insane_open_helper("max_accpted_htlcs > 483", |mut msg| { msg.max_accepted_htlcs = 484; msg });
112 fn test_async_inbound_update_fee() {
113 let node_cfgs = create_node_cfgs(2);
114 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
115 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
116 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
117 let channel_id = chan.2;
120 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
124 // send (1) commitment_signed -.
125 // <- update_add_htlc/commitment_signed
126 // send (2) RAA (awaiting remote revoke) -.
127 // (1) commitment_signed is delivered ->
128 // .- send (3) RAA (awaiting remote revoke)
129 // (2) RAA is delivered ->
130 // .- send (4) commitment_signed
131 // <- (3) RAA is delivered
132 // send (5) commitment_signed -.
133 // <- (4) commitment_signed is delivered
135 // (5) commitment_signed is delivered ->
137 // (6) RAA is delivered ->
139 // First nodes[0] generates an update_fee
140 nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
141 check_added_monitors!(nodes[0], 1);
143 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
144 assert_eq!(events_0.len(), 1);
145 let (update_msg, commitment_signed) = match events_0[0] { // (1)
146 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
147 (update_fee.as_ref(), commitment_signed)
149 _ => panic!("Unexpected event"),
152 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
154 // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
155 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
156 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();
157 check_added_monitors!(nodes[1], 1);
159 let payment_event = {
160 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
161 assert_eq!(events_1.len(), 1);
162 SendEvent::from_event(events_1.remove(0))
164 assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
165 assert_eq!(payment_event.msgs.len(), 1);
167 // ...now when the messages get delivered everyone should be happy
168 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
169 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
170 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
171 // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
172 check_added_monitors!(nodes[0], 1);
174 // deliver(1), generate (3):
175 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
176 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
177 // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
178 check_added_monitors!(nodes[1], 1);
180 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack); // deliver (2)
181 let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
182 assert!(bs_update.update_add_htlcs.is_empty()); // (4)
183 assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
184 assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
185 assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
186 assert!(bs_update.update_fee.is_none()); // (4)
187 check_added_monitors!(nodes[1], 1);
189 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack); // deliver (3)
190 let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
191 assert!(as_update.update_add_htlcs.is_empty()); // (5)
192 assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
193 assert!(as_update.update_fail_htlcs.is_empty()); // (5)
194 assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
195 assert!(as_update.update_fee.is_none()); // (5)
196 check_added_monitors!(nodes[0], 1);
198 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed); // deliver (4)
199 let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
200 // only (6) so get_event_msg's assert(len == 1) passes
201 check_added_monitors!(nodes[0], 1);
203 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed); // deliver (5)
204 let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
205 check_added_monitors!(nodes[1], 1);
207 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
208 check_added_monitors!(nodes[0], 1);
210 let events_2 = nodes[0].node.get_and_clear_pending_events();
211 assert_eq!(events_2.len(), 1);
213 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
214 _ => panic!("Unexpected event"),
217 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke); // deliver (6)
218 check_added_monitors!(nodes[1], 1);
222 fn test_update_fee_unordered_raa() {
223 // Just the intro to the previous test followed by an out-of-order RAA (which caused a
224 // crash in an earlier version of the update_fee patch)
225 let node_cfgs = create_node_cfgs(2);
226 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
227 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
228 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
229 let channel_id = chan.2;
232 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
234 // First nodes[0] generates an update_fee
235 nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
236 check_added_monitors!(nodes[0], 1);
238 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
239 assert_eq!(events_0.len(), 1);
240 let update_msg = match events_0[0] { // (1)
241 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
244 _ => panic!("Unexpected event"),
247 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
249 // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
250 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
251 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();
252 check_added_monitors!(nodes[1], 1);
254 let payment_event = {
255 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
256 assert_eq!(events_1.len(), 1);
257 SendEvent::from_event(events_1.remove(0))
259 assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
260 assert_eq!(payment_event.msgs.len(), 1);
262 // ...now when the messages get delivered everyone should be happy
263 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
264 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
265 let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
266 // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
267 check_added_monitors!(nodes[0], 1);
269 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg); // deliver (2)
270 check_added_monitors!(nodes[1], 1);
272 // We can't continue, sadly, because our (1) now has a bogus signature
276 fn test_multi_flight_update_fee() {
277 let node_cfgs = create_node_cfgs(2);
278 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
279 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
280 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
281 let channel_id = chan.2;
284 // update_fee/commitment_signed ->
285 // .- send (1) RAA and (2) commitment_signed
286 // update_fee (never committed) ->
288 // We have to manually generate the above update_fee, it is allowed by the protocol but we
289 // don't track which updates correspond to which revoke_and_ack responses so we're in
290 // AwaitingRAA mode and will not generate the update_fee yet.
291 // <- (1) RAA delivered
292 // (3) is generated and send (4) CS -.
293 // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
294 // know the per_commitment_point to use for it.
295 // <- (2) commitment_signed delivered
297 // B should send no response here
298 // (4) commitment_signed delivered ->
299 // <- RAA/commitment_signed delivered
302 // First nodes[0] generates an update_fee
303 let initial_feerate = get_feerate!(nodes[0], channel_id);
304 nodes[0].node.update_fee(channel_id, initial_feerate + 20).unwrap();
305 check_added_monitors!(nodes[0], 1);
307 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
308 assert_eq!(events_0.len(), 1);
309 let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
310 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
311 (update_fee.as_ref().unwrap(), commitment_signed)
313 _ => panic!("Unexpected event"),
316 // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
317 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1);
318 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1);
319 let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
320 check_added_monitors!(nodes[1], 1);
322 // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
324 nodes[0].node.update_fee(channel_id, initial_feerate + 40).unwrap();
325 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
326 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
328 // Create the (3) update_fee message that nodes[0] will generate before it does...
329 let mut update_msg_2 = msgs::UpdateFee {
330 channel_id: update_msg_1.channel_id.clone(),
331 feerate_per_kw: (initial_feerate + 30) as u32,
334 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
336 update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
338 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
340 // Deliver (1), generating (3) and (4)
341 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg);
342 let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
343 check_added_monitors!(nodes[0], 1);
344 assert!(as_second_update.update_add_htlcs.is_empty());
345 assert!(as_second_update.update_fulfill_htlcs.is_empty());
346 assert!(as_second_update.update_fail_htlcs.is_empty());
347 assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
348 // Check that the update_fee newly generated matches what we delivered:
349 assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
350 assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
352 // Deliver (2) commitment_signed
353 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
354 let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
355 check_added_monitors!(nodes[0], 1);
356 // No commitment_signed so get_event_msg's assert(len == 1) passes
358 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg);
359 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
360 check_added_monitors!(nodes[1], 1);
363 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
364 let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
365 check_added_monitors!(nodes[1], 1);
367 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
368 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
369 check_added_monitors!(nodes[0], 1);
371 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment);
372 let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
373 // No commitment_signed so get_event_msg's assert(len == 1) passes
374 check_added_monitors!(nodes[0], 1);
376 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke);
377 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
378 check_added_monitors!(nodes[1], 1);
382 fn test_update_fee_vanilla() {
383 let node_cfgs = create_node_cfgs(2);
384 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
385 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
386 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
387 let channel_id = chan.2;
389 let feerate = get_feerate!(nodes[0], channel_id);
390 nodes[0].node.update_fee(channel_id, feerate+25).unwrap();
391 check_added_monitors!(nodes[0], 1);
393 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
394 assert_eq!(events_0.len(), 1);
395 let (update_msg, commitment_signed) = match events_0[0] {
396 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 } } => {
397 (update_fee.as_ref(), commitment_signed)
399 _ => panic!("Unexpected event"),
401 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
403 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
404 let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
405 check_added_monitors!(nodes[1], 1);
407 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
408 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
409 check_added_monitors!(nodes[0], 1);
411 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
412 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
413 // No commitment_signed so get_event_msg's assert(len == 1) passes
414 check_added_monitors!(nodes[0], 1);
416 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
417 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
418 check_added_monitors!(nodes[1], 1);
422 fn test_update_fee_that_funder_cannot_afford() {
423 let node_cfgs = create_node_cfgs(2);
424 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
425 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
426 let channel_value = 1888;
427 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000, InitFeatures::supported(), InitFeatures::supported());
428 let channel_id = chan.2;
431 nodes[0].node.update_fee(channel_id, feerate).unwrap();
432 check_added_monitors!(nodes[0], 1);
433 let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
435 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap());
437 commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
439 //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
440 //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
442 let mut chan_lock = nodes[1].node.channel_state.lock().unwrap();
443 let chan = chan_lock.by_id.get_mut(&channel_id).unwrap();
445 //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
446 let num_htlcs = chan.channel_monitor().get_latest_local_commitment_txn()[0].output.len() - 2;
447 let total_fee: u64 = feerate * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
448 let mut actual_fee = chan.channel_monitor().get_latest_local_commitment_txn()[0].output.iter().fold(0, |acc, output| acc + output.value);
449 actual_fee = channel_value - actual_fee;
450 assert_eq!(total_fee, actual_fee);
453 //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
454 //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
455 nodes[0].node.update_fee(channel_id, feerate+2).unwrap();
456 check_added_monitors!(nodes[0], 1);
458 let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
460 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap());
462 //While producing the commitment_signed response after handling a received update_fee request the
463 //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
464 //Should produce and error.
465 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed);
466 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Funding remote cannot afford proposed new fee".to_string(), 1);
468 //clear the message we could not handle
469 nodes[1].node.get_and_clear_pending_msg_events();
473 fn test_update_fee_with_fundee_update_add_htlc() {
474 let node_cfgs = create_node_cfgs(2);
475 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
476 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
477 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
478 let channel_id = chan.2;
481 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
483 let feerate = get_feerate!(nodes[0], channel_id);
484 nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
485 check_added_monitors!(nodes[0], 1);
487 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
488 assert_eq!(events_0.len(), 1);
489 let (update_msg, commitment_signed) = match events_0[0] {
490 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 } } => {
491 (update_fee.as_ref(), commitment_signed)
493 _ => panic!("Unexpected event"),
495 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
496 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
497 let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
498 check_added_monitors!(nodes[1], 1);
500 let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 800000, TEST_FINAL_CLTV).unwrap();
502 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[1]);
504 // nothing happens since node[1] is in AwaitingRemoteRevoke
505 nodes[1].node.send_payment(route, our_payment_hash).unwrap();
507 let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
508 assert_eq!(added_monitors.len(), 0);
509 added_monitors.clear();
511 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
512 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
513 // node[1] has nothing to do
515 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
516 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
517 check_added_monitors!(nodes[0], 1);
519 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
520 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
521 // No commitment_signed so get_event_msg's assert(len == 1) passes
522 check_added_monitors!(nodes[0], 1);
523 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
524 check_added_monitors!(nodes[1], 1);
525 // AwaitingRemoteRevoke ends here
527 let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
528 assert_eq!(commitment_update.update_add_htlcs.len(), 1);
529 assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
530 assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
531 assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
532 assert_eq!(commitment_update.update_fee.is_none(), true);
534 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]);
535 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
536 check_added_monitors!(nodes[0], 1);
537 let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
539 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke);
540 check_added_monitors!(nodes[1], 1);
541 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
543 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
544 check_added_monitors!(nodes[1], 1);
545 let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
546 // No commitment_signed so get_event_msg's assert(len == 1) passes
548 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke);
549 check_added_monitors!(nodes[0], 1);
550 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
552 expect_pending_htlcs_forwardable!(nodes[0]);
554 let events = nodes[0].node.get_and_clear_pending_events();
555 assert_eq!(events.len(), 1);
557 Event::PaymentReceived { .. } => { },
558 _ => panic!("Unexpected event"),
561 claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage, 800_000);
563 send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000, 800_000);
564 send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000, 800_000);
565 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
569 fn test_update_fee() {
570 let node_cfgs = create_node_cfgs(2);
571 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
572 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
573 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
574 let channel_id = chan.2;
577 // (1) update_fee/commitment_signed ->
578 // <- (2) revoke_and_ack
579 // .- send (3) commitment_signed
580 // (4) update_fee/commitment_signed ->
581 // .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
582 // <- (3) commitment_signed delivered
583 // send (6) revoke_and_ack -.
584 // <- (5) deliver revoke_and_ack
585 // (6) deliver revoke_and_ack ->
586 // .- send (7) commitment_signed in response to (4)
587 // <- (7) deliver commitment_signed
590 // Create and deliver (1)...
591 let feerate = get_feerate!(nodes[0], channel_id);
592 nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
593 check_added_monitors!(nodes[0], 1);
595 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
596 assert_eq!(events_0.len(), 1);
597 let (update_msg, commitment_signed) = match events_0[0] {
598 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 } } => {
599 (update_fee.as_ref(), commitment_signed)
601 _ => panic!("Unexpected event"),
603 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
605 // Generate (2) and (3):
606 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
607 let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
608 check_added_monitors!(nodes[1], 1);
611 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
612 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
613 check_added_monitors!(nodes[0], 1);
615 // Create and deliver (4)...
616 nodes[0].node.update_fee(channel_id, feerate+30).unwrap();
617 check_added_monitors!(nodes[0], 1);
618 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
619 assert_eq!(events_0.len(), 1);
620 let (update_msg, commitment_signed) = match events_0[0] {
621 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 } } => {
622 (update_fee.as_ref(), commitment_signed)
624 _ => panic!("Unexpected event"),
627 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
628 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
629 check_added_monitors!(nodes[1], 1);
631 let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
632 // No commitment_signed so get_event_msg's assert(len == 1) passes
634 // Handle (3), creating (6):
635 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0);
636 check_added_monitors!(nodes[0], 1);
637 let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
638 // No commitment_signed so get_event_msg's assert(len == 1) passes
641 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
642 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
643 check_added_monitors!(nodes[0], 1);
645 // Deliver (6), creating (7):
646 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0);
647 let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
648 assert!(commitment_update.update_add_htlcs.is_empty());
649 assert!(commitment_update.update_fulfill_htlcs.is_empty());
650 assert!(commitment_update.update_fail_htlcs.is_empty());
651 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
652 assert!(commitment_update.update_fee.is_none());
653 check_added_monitors!(nodes[1], 1);
656 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
657 check_added_monitors!(nodes[0], 1);
658 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
659 // No commitment_signed so get_event_msg's assert(len == 1) passes
661 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
662 check_added_monitors!(nodes[1], 1);
663 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
665 assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
666 assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
667 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
671 fn pre_funding_lock_shutdown_test() {
672 // Test sending a shutdown prior to funding_locked after funding generation
673 let node_cfgs = create_node_cfgs(2);
674 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
675 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
676 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0, InitFeatures::supported(), InitFeatures::supported());
677 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
678 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![tx.clone()]}, 1);
679 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![tx.clone()]}, 1);
681 nodes[0].node.close_channel(&OutPoint::new(tx.txid(), 0).to_channel_id()).unwrap();
682 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
683 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
684 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
685 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
687 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
688 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
689 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
690 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
691 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
692 assert!(node_0_none.is_none());
694 assert!(nodes[0].node.list_channels().is_empty());
695 assert!(nodes[1].node.list_channels().is_empty());
699 fn updates_shutdown_wait() {
700 // Test sending a shutdown with outstanding updates pending
701 let node_cfgs = create_node_cfgs(3);
702 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
703 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
704 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
705 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
706 let route_1 = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
707 let route_2 = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
709 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
711 nodes[0].node.close_channel(&chan_1.2).unwrap();
712 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
713 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
714 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
715 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
717 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
718 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
720 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
721 if let Err(APIError::ChannelUnavailable {..}) = nodes[0].node.send_payment(route_1, payment_hash) {}
722 else { panic!("New sends should fail!") };
723 if let Err(APIError::ChannelUnavailable {..}) = nodes[1].node.send_payment(route_2, payment_hash) {}
724 else { panic!("New sends should fail!") };
726 assert!(nodes[2].node.claim_funds(our_payment_preimage, 100_000));
727 check_added_monitors!(nodes[2], 1);
728 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
729 assert!(updates.update_add_htlcs.is_empty());
730 assert!(updates.update_fail_htlcs.is_empty());
731 assert!(updates.update_fail_malformed_htlcs.is_empty());
732 assert!(updates.update_fee.is_none());
733 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
734 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
735 check_added_monitors!(nodes[1], 1);
736 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
737 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
739 assert!(updates_2.update_add_htlcs.is_empty());
740 assert!(updates_2.update_fail_htlcs.is_empty());
741 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
742 assert!(updates_2.update_fee.is_none());
743 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
744 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
745 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
747 let events = nodes[0].node.get_and_clear_pending_events();
748 assert_eq!(events.len(), 1);
750 Event::PaymentSent { ref payment_preimage } => {
751 assert_eq!(our_payment_preimage, *payment_preimage);
753 _ => panic!("Unexpected event"),
756 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
757 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
758 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
759 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
760 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
761 assert!(node_0_none.is_none());
763 assert!(nodes[0].node.list_channels().is_empty());
765 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
766 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
767 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
768 assert!(nodes[1].node.list_channels().is_empty());
769 assert!(nodes[2].node.list_channels().is_empty());
773 fn htlc_fail_async_shutdown() {
774 // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
775 let node_cfgs = create_node_cfgs(3);
776 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
777 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
778 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
779 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
781 let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
782 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
783 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
784 check_added_monitors!(nodes[0], 1);
785 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
786 assert_eq!(updates.update_add_htlcs.len(), 1);
787 assert!(updates.update_fulfill_htlcs.is_empty());
788 assert!(updates.update_fail_htlcs.is_empty());
789 assert!(updates.update_fail_malformed_htlcs.is_empty());
790 assert!(updates.update_fee.is_none());
792 nodes[1].node.close_channel(&chan_1.2).unwrap();
793 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
794 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
795 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
797 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
798 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
799 check_added_monitors!(nodes[1], 1);
800 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
801 commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
803 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
804 assert!(updates_2.update_add_htlcs.is_empty());
805 assert!(updates_2.update_fulfill_htlcs.is_empty());
806 assert_eq!(updates_2.update_fail_htlcs.len(), 1);
807 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
808 assert!(updates_2.update_fee.is_none());
810 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
811 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
813 let events = nodes[0].node.get_and_clear_pending_events();
814 assert_eq!(events.len(), 1);
816 Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } => {
817 assert_eq!(our_payment_hash, *payment_hash);
818 assert!(!rejected_by_dest);
820 _ => panic!("Unexpected event"),
823 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
824 assert_eq!(msg_events.len(), 2);
825 let node_0_closing_signed = match msg_events[0] {
826 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
827 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
830 _ => panic!("Unexpected event"),
832 match msg_events[1] {
833 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
834 assert_eq!(msg.contents.short_channel_id, chan_1.0.contents.short_channel_id);
836 _ => panic!("Unexpected event"),
839 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
840 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
841 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
842 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
843 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
844 assert!(node_0_none.is_none());
846 assert!(nodes[0].node.list_channels().is_empty());
848 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
849 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
850 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
851 assert!(nodes[1].node.list_channels().is_empty());
852 assert!(nodes[2].node.list_channels().is_empty());
855 fn do_test_shutdown_rebroadcast(recv_count: u8) {
856 // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
857 // messages delivered prior to disconnect
858 let node_cfgs = create_node_cfgs(3);
859 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
860 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
861 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
862 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
864 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
866 nodes[1].node.close_channel(&chan_1.2).unwrap();
867 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
869 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
870 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
872 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
876 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
877 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
879 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
880 let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
881 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
882 let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
884 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
885 let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
886 assert!(node_1_shutdown == node_1_2nd_shutdown);
888 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
889 let node_0_2nd_shutdown = if recv_count > 0 {
890 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
891 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
894 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
895 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
896 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
898 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_2nd_shutdown);
900 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
901 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
903 assert!(nodes[2].node.claim_funds(our_payment_preimage, 100_000));
904 check_added_monitors!(nodes[2], 1);
905 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
906 assert!(updates.update_add_htlcs.is_empty());
907 assert!(updates.update_fail_htlcs.is_empty());
908 assert!(updates.update_fail_malformed_htlcs.is_empty());
909 assert!(updates.update_fee.is_none());
910 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
911 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
912 check_added_monitors!(nodes[1], 1);
913 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
914 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
916 assert!(updates_2.update_add_htlcs.is_empty());
917 assert!(updates_2.update_fail_htlcs.is_empty());
918 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
919 assert!(updates_2.update_fee.is_none());
920 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
921 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
922 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
924 let events = nodes[0].node.get_and_clear_pending_events();
925 assert_eq!(events.len(), 1);
927 Event::PaymentSent { ref payment_preimage } => {
928 assert_eq!(our_payment_preimage, *payment_preimage);
930 _ => panic!("Unexpected event"),
933 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
935 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
936 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
937 assert!(node_1_closing_signed.is_some());
940 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
941 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
943 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
944 let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
945 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
947 // If all closing_signeds weren't delivered we can just resume where we left off...
948 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
950 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
951 let node_0_3rd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
952 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
954 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
955 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
956 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
958 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_3rd_shutdown);
959 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
961 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_3rd_shutdown);
962 let node_0_2nd_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
963 assert!(node_0_closing_signed == node_0_2nd_closing_signed);
965 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
966 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
967 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
968 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
969 assert!(node_0_none.is_none());
971 // If one node, however, received + responded with an identical closing_signed we end
972 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
973 // There isn't really anything better we can do simply, but in the future we might
974 // explore storing a set of recently-closed channels that got disconnected during
975 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
976 // give our counterparty enough time to (potentially) broadcast a cooperative closing
978 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
980 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
981 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
982 assert_eq!(msg_events.len(), 1);
983 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
985 &ErrorAction::SendErrorMessage { ref msg } => {
986 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msg);
987 assert_eq!(msg.channel_id, chan_1.2);
989 _ => panic!("Unexpected event!"),
991 } else { panic!("Needed SendErrorMessage close"); }
993 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
994 // checks it, but in this case nodes[0] didn't ever get a chance to receive a
995 // closing_signed so we do it ourselves
996 check_closed_broadcast!(nodes[0], false);
999 assert!(nodes[0].node.list_channels().is_empty());
1001 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1002 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1003 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1004 assert!(nodes[1].node.list_channels().is_empty());
1005 assert!(nodes[2].node.list_channels().is_empty());
1009 fn test_shutdown_rebroadcast() {
1010 do_test_shutdown_rebroadcast(0);
1011 do_test_shutdown_rebroadcast(1);
1012 do_test_shutdown_rebroadcast(2);
1016 fn fake_network_test() {
1017 // Simple test which builds a network of ChannelManagers, connects them to each other, and
1018 // tests that payments get routed and transactions broadcast in semi-reasonable ways.
1019 let node_cfgs = create_node_cfgs(4);
1020 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1021 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1023 // Create some initial channels
1024 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1025 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
1026 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
1028 // Rebalance the network a bit by relaying one payment through all the channels...
1029 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1030 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1031 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1032 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1034 // Send some more payments
1035 send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000, 1_000_000);
1036 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000, 1_000_000);
1037 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000, 1_000_000);
1039 // Test failure packets
1040 let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
1041 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
1043 // Add a new channel that skips 3
1044 let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::supported(), InitFeatures::supported());
1046 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000, 1_000_000);
1047 send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000, 1_000_000);
1048 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1049 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1050 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1051 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1052 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1054 // Do some rebalance loop payments, simultaneously
1055 let mut hops = Vec::with_capacity(3);
1056 hops.push(RouteHop {
1057 pubkey: nodes[2].node.get_our_node_id(),
1058 node_features: NodeFeatures::empty(),
1059 short_channel_id: chan_2.0.contents.short_channel_id,
1060 channel_features: ChannelFeatures::empty(),
1062 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
1064 hops.push(RouteHop {
1065 pubkey: nodes[3].node.get_our_node_id(),
1066 node_features: NodeFeatures::empty(),
1067 short_channel_id: chan_3.0.contents.short_channel_id,
1068 channel_features: ChannelFeatures::empty(),
1070 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
1072 hops.push(RouteHop {
1073 pubkey: nodes[1].node.get_our_node_id(),
1074 node_features: NodeFeatures::empty(),
1075 short_channel_id: chan_4.0.contents.short_channel_id,
1076 channel_features: ChannelFeatures::empty(),
1078 cltv_expiry_delta: TEST_FINAL_CLTV,
1080 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;
1081 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;
1082 let payment_preimage_1 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
1084 let mut hops = Vec::with_capacity(3);
1085 hops.push(RouteHop {
1086 pubkey: nodes[3].node.get_our_node_id(),
1087 node_features: NodeFeatures::empty(),
1088 short_channel_id: chan_4.0.contents.short_channel_id,
1089 channel_features: ChannelFeatures::empty(),
1091 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
1093 hops.push(RouteHop {
1094 pubkey: nodes[2].node.get_our_node_id(),
1095 node_features: NodeFeatures::empty(),
1096 short_channel_id: chan_3.0.contents.short_channel_id,
1097 channel_features: ChannelFeatures::empty(),
1099 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
1101 hops.push(RouteHop {
1102 pubkey: nodes[1].node.get_our_node_id(),
1103 node_features: NodeFeatures::empty(),
1104 short_channel_id: chan_2.0.contents.short_channel_id,
1105 channel_features: ChannelFeatures::empty(),
1107 cltv_expiry_delta: TEST_FINAL_CLTV,
1109 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;
1110 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;
1111 let payment_hash_2 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1113 // Claim the rebalances...
1114 fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1115 claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1, 1_000_000);
1117 // Add a duplicate new channel from 2 to 4
1118 let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::supported(), InitFeatures::supported());
1120 // Send some payments across both channels
1121 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1122 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1123 let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1126 route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
1127 let events = nodes[0].node.get_and_clear_pending_msg_events();
1128 assert_eq!(events.len(), 0);
1129 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);
1131 //TODO: Test that routes work again here as we've been notified that the channel is full
1133 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3, 3_000_000);
1134 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4, 3_000_000);
1135 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5, 3_000_000);
1137 // Close down the channels...
1138 close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1139 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1140 close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1141 close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1142 close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
1146 fn holding_cell_htlc_counting() {
1147 // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1148 // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1149 // commitment dance rounds.
1150 let node_cfgs = create_node_cfgs(3);
1151 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1152 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1153 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1154 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
1156 let mut payments = Vec::new();
1157 for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1158 let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
1159 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1160 nodes[1].node.send_payment(route, payment_hash).unwrap();
1161 payments.push((payment_preimage, payment_hash));
1163 check_added_monitors!(nodes[1], 1);
1165 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1166 assert_eq!(events.len(), 1);
1167 let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1168 assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1170 // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1171 // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1173 let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
1174 let (_, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
1175 if let APIError::ChannelUnavailable { err } = nodes[1].node.send_payment(route, payment_hash_1).unwrap_err() {
1176 assert_eq!(err, "Cannot push more than their max accepted HTLCs");
1177 } else { panic!("Unexpected event"); }
1178 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1179 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1181 // This should also be true if we try to forward a payment.
1182 let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
1183 let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
1184 nodes[0].node.send_payment(route, payment_hash_2).unwrap();
1185 check_added_monitors!(nodes[0], 1);
1187 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1188 assert_eq!(events.len(), 1);
1189 let payment_event = SendEvent::from_event(events.pop().unwrap());
1190 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1192 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1193 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1194 // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1195 // fails), the second will process the resulting failure and fail the HTLC backward.
1196 expect_pending_htlcs_forwardable!(nodes[1]);
1197 expect_pending_htlcs_forwardable!(nodes[1]);
1198 check_added_monitors!(nodes[1], 1);
1200 let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1201 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1202 commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1204 let events = nodes[0].node.get_and_clear_pending_msg_events();
1205 assert_eq!(events.len(), 1);
1207 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
1208 assert_eq!(msg.contents.short_channel_id, chan_2.0.contents.short_channel_id);
1210 _ => panic!("Unexpected event"),
1213 let events = nodes[0].node.get_and_clear_pending_events();
1214 assert_eq!(events.len(), 1);
1216 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
1217 assert_eq!(payment_hash, payment_hash_2);
1218 assert!(!rejected_by_dest);
1220 _ => panic!("Unexpected event"),
1223 // Now forward all the pending HTLCs and claim them back
1224 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1225 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1226 check_added_monitors!(nodes[2], 1);
1228 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1229 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1230 check_added_monitors!(nodes[1], 1);
1231 let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1233 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1234 check_added_monitors!(nodes[1], 1);
1235 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1237 for ref update in as_updates.update_add_htlcs.iter() {
1238 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1240 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1241 check_added_monitors!(nodes[2], 1);
1242 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1243 check_added_monitors!(nodes[2], 1);
1244 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1246 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1247 check_added_monitors!(nodes[1], 1);
1248 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1249 check_added_monitors!(nodes[1], 1);
1250 let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1252 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1253 check_added_monitors!(nodes[2], 1);
1255 expect_pending_htlcs_forwardable!(nodes[2]);
1257 let events = nodes[2].node.get_and_clear_pending_events();
1258 assert_eq!(events.len(), payments.len());
1259 for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1261 &Event::PaymentReceived { ref payment_hash, .. } => {
1262 assert_eq!(*payment_hash, *hash);
1264 _ => panic!("Unexpected event"),
1268 for (preimage, _) in payments.drain(..) {
1269 claim_payment(&nodes[1], &[&nodes[2]], preimage, 100_000);
1272 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000, 1_000_000);
1276 fn duplicate_htlc_test() {
1277 // Test that we accept duplicate payment_hash HTLCs across the network and that
1278 // claiming/failing them are all separate and don't affect each other
1279 let node_cfgs = create_node_cfgs(6);
1280 let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1281 let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1283 // Create some initial channels to route via 3 to 4/5 from 0/1/2
1284 create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::supported(), InitFeatures::supported());
1285 create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::supported(), InitFeatures::supported());
1286 create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
1287 create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::supported(), InitFeatures::supported());
1288 create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::supported(), InitFeatures::supported());
1290 let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1292 *nodes[0].network_payment_count.borrow_mut() -= 1;
1293 assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1295 *nodes[0].network_payment_count.borrow_mut() -= 1;
1296 assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1298 claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage, 1_000_000);
1299 fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1300 claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage, 1_000_000);
1304 fn test_duplicate_htlc_different_direction_onchain() {
1305 // Test that ChannelMonitor doesn't generate 2 preimage txn
1306 // when we have 2 HTLCs with same preimage that go across a node
1307 // in opposite directions.
1308 let node_cfgs = create_node_cfgs(2);
1309 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1310 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1312 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1315 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
1317 let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1319 let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 800_000, TEST_FINAL_CLTV).unwrap();
1320 send_along_route_with_hash(&nodes[1], route, &vec!(&nodes[0])[..], 800_000, payment_hash);
1322 // Provide preimage to node 0 by claiming payment
1323 nodes[0].node.claim_funds(payment_preimage, 800_000);
1324 check_added_monitors!(nodes[0], 1);
1326 // Broadcast node 1 commitment txn
1327 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();
1329 assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1330 let mut has_both_htlcs = 0; // check htlcs match ones committed
1331 for outp in remote_txn[0].output.iter() {
1332 if outp.value == 800_000 / 1000 {
1333 has_both_htlcs += 1;
1334 } else if outp.value == 900_000 / 1000 {
1335 has_both_htlcs += 1;
1338 assert_eq!(has_both_htlcs, 2);
1340 let header = BlockHeader { version: 0x2000_0000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1341 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
1343 // Check we only broadcast 1 timeout tx
1344 let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1345 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()) };
1346 assert_eq!(claim_txn.len(), 7);
1347 check_spends!(claim_txn[2], chan_1.3);
1348 check_spends!(claim_txn[3], claim_txn[2]);
1349 assert_eq!(claim_txn[0], claim_txn[5]);
1350 assert_eq!(claim_txn[1], claim_txn[6]);
1351 assert_eq!(htlc_pair.0.input.len(), 1);
1352 assert_eq!(htlc_pair.0.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1353 check_spends!(htlc_pair.0, remote_txn[0].clone());
1354 assert_eq!(htlc_pair.1.input.len(), 1);
1355 assert_eq!(htlc_pair.1.input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1356 check_spends!(htlc_pair.1, remote_txn[0].clone());
1358 let events = nodes[0].node.get_and_clear_pending_msg_events();
1359 assert_eq!(events.len(), 2);
1362 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1363 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, .. } } => {
1364 assert!(update_add_htlcs.is_empty());
1365 assert!(update_fail_htlcs.is_empty());
1366 assert_eq!(update_fulfill_htlcs.len(), 1);
1367 assert!(update_fail_malformed_htlcs.is_empty());
1368 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1370 _ => panic!("Unexpected event"),
1375 fn do_channel_reserve_test(test_recv: bool) {
1377 let node_cfgs = create_node_cfgs(3);
1378 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1379 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1380 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1900, 1001, InitFeatures::supported(), InitFeatures::supported());
1381 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1900, 1001, InitFeatures::supported(), InitFeatures::supported());
1383 let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1384 let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1386 let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1387 let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1389 macro_rules! get_route_and_payment_hash {
1390 ($recv_value: expr) => {{
1391 let route = nodes[0].router.get_route(&nodes.last().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV).unwrap();
1392 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1393 (route, payment_hash, payment_preimage)
1397 macro_rules! expect_forward {
1399 let mut events = $node.node.get_and_clear_pending_msg_events();
1400 assert_eq!(events.len(), 1);
1401 check_added_monitors!($node, 1);
1402 let payment_event = SendEvent::from_event(events.remove(0));
1407 let feemsat = 239; // somehow we know?
1408 let total_fee_msat = (nodes.len() - 2) as u64 * 239;
1410 let recv_value_0 = stat01.their_max_htlc_value_in_flight_msat - total_fee_msat;
1412 // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1414 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_0 + 1);
1415 assert!(route.hops.iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1416 let err = nodes[0].node.send_payment(route, our_payment_hash).err().unwrap();
1418 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight our peer will accept"),
1419 _ => panic!("Unknown error variants"),
1421 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1422 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);
1425 let mut htlc_id = 0;
1426 // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1427 // nodes[0]'s wealth
1429 let amt_msat = recv_value_0 + total_fee_msat;
1430 if stat01.value_to_self_msat - amt_msat < stat01.channel_reserve_msat {
1433 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0, recv_value_0);
1436 let (stat01_, stat11_, stat12_, stat22_) = (
1437 get_channel_value_stat!(nodes[0], chan_1.2),
1438 get_channel_value_stat!(nodes[1], chan_1.2),
1439 get_channel_value_stat!(nodes[1], chan_2.2),
1440 get_channel_value_stat!(nodes[2], chan_2.2),
1443 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1444 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1445 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1446 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1447 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1451 let recv_value = stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat;
1452 // attempt to get channel_reserve violation
1453 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value + 1);
1454 let err = nodes[0].node.send_payment(route.clone(), our_payment_hash).err().unwrap();
1456 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over their reserve value"),
1457 _ => panic!("Unknown error variants"),
1459 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1460 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over their reserve value".to_string(), 1);
1463 // adding pending output
1464 let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat)/2;
1465 let amt_msat_1 = recv_value_1 + total_fee_msat;
1467 let (route_1, our_payment_hash_1, our_payment_preimage_1) = get_route_and_payment_hash!(recv_value_1);
1468 let payment_event_1 = {
1469 nodes[0].node.send_payment(route_1, our_payment_hash_1).unwrap();
1470 check_added_monitors!(nodes[0], 1);
1472 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1473 assert_eq!(events.len(), 1);
1474 SendEvent::from_event(events.remove(0))
1476 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1478 // channel reserve test with htlc pending output > 0
1479 let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat;
1481 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
1482 match nodes[0].node.send_payment(route, our_payment_hash).err().unwrap() {
1483 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over their reserve value"),
1484 _ => panic!("Unknown error variants"),
1486 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1487 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over their reserve value".to_string(), 2);
1491 // test channel_reserve test on nodes[1] side
1492 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
1494 // Need to manually create update_add_htlc message to go around the channel reserve check in send_htlc()
1495 let secp_ctx = Secp256k1::new();
1496 let session_priv = SecretKey::from_slice(&{
1497 let mut session_key = [0; 32];
1498 let mut rng = thread_rng();
1499 rng.fill_bytes(&mut session_key);
1501 }).expect("RNG is bad!");
1503 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1504 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route, &session_priv).unwrap();
1505 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
1506 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
1507 let msg = msgs::UpdateAddHTLC {
1508 channel_id: chan_1.2,
1510 amount_msat: htlc_msat,
1511 payment_hash: our_payment_hash,
1512 cltv_expiry: htlc_cltv,
1513 onion_routing_packet: onion_packet,
1517 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1518 // If we send a garbage message, the channel should get closed, making the rest of this test case fail.
1519 assert_eq!(nodes[1].node.list_channels().len(), 1);
1520 assert_eq!(nodes[1].node.list_channels().len(), 1);
1521 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1522 assert_eq!(err_msg.data, "Remote HTLC add would put them over their reserve value");
1527 // split the rest to test holding cell
1528 let recv_value_21 = recv_value_2/2;
1529 let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat;
1531 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
1532 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);
1535 // now see if they go through on both sides
1536 let (route_21, our_payment_hash_21, our_payment_preimage_21) = get_route_and_payment_hash!(recv_value_21);
1537 // but this will stuck in the holding cell
1538 nodes[0].node.send_payment(route_21, our_payment_hash_21).unwrap();
1539 check_added_monitors!(nodes[0], 0);
1540 let events = nodes[0].node.get_and_clear_pending_events();
1541 assert_eq!(events.len(), 0);
1543 // test with outbound holding cell amount > 0
1545 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_22+1);
1546 match nodes[0].node.send_payment(route, our_payment_hash).err().unwrap() {
1547 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over their reserve value"),
1548 _ => panic!("Unknown error variants"),
1550 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1551 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over their reserve value".to_string(), 3);
1554 let (route_22, our_payment_hash_22, our_payment_preimage_22) = get_route_and_payment_hash!(recv_value_22);
1555 // this will also stuck in the holding cell
1556 nodes[0].node.send_payment(route_22, our_payment_hash_22).unwrap();
1557 check_added_monitors!(nodes[0], 0);
1558 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1559 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1561 // flush the pending htlc
1562 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
1563 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1564 check_added_monitors!(nodes[1], 1);
1566 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
1567 check_added_monitors!(nodes[0], 1);
1568 let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1570 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
1571 let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1572 // No commitment_signed so get_event_msg's assert(len == 1) passes
1573 check_added_monitors!(nodes[0], 1);
1575 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
1576 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1577 check_added_monitors!(nodes[1], 1);
1579 expect_pending_htlcs_forwardable!(nodes[1]);
1581 let ref payment_event_11 = expect_forward!(nodes[1]);
1582 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
1583 commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
1585 expect_pending_htlcs_forwardable!(nodes[2]);
1586 expect_payment_received!(nodes[2], our_payment_hash_1, recv_value_1);
1588 // flush the htlcs in the holding cell
1589 assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
1590 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
1591 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
1592 commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
1593 expect_pending_htlcs_forwardable!(nodes[1]);
1595 let ref payment_event_3 = expect_forward!(nodes[1]);
1596 assert_eq!(payment_event_3.msgs.len(), 2);
1597 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
1598 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
1600 commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
1601 expect_pending_htlcs_forwardable!(nodes[2]);
1603 let events = nodes[2].node.get_and_clear_pending_events();
1604 assert_eq!(events.len(), 2);
1606 Event::PaymentReceived { ref payment_hash, amt } => {
1607 assert_eq!(our_payment_hash_21, *payment_hash);
1608 assert_eq!(recv_value_21, amt);
1610 _ => panic!("Unexpected event"),
1613 Event::PaymentReceived { ref payment_hash, amt } => {
1614 assert_eq!(our_payment_hash_22, *payment_hash);
1615 assert_eq!(recv_value_22, amt);
1617 _ => panic!("Unexpected event"),
1620 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1, recv_value_1);
1621 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21, recv_value_21);
1622 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22, recv_value_22);
1624 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);
1625 let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
1626 assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
1627 assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat);
1629 let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
1630 assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22);
1634 fn channel_reserve_test() {
1635 do_channel_reserve_test(false);
1636 do_channel_reserve_test(true);
1640 fn channel_reserve_in_flight_removes() {
1641 // In cases where one side claims an HTLC, it thinks it has additional available funds that it
1642 // can send to its counterparty, but due to update ordering, the other side may not yet have
1643 // considered those HTLCs fully removed.
1644 // This tests that we don't count HTLCs which will not be included in the next remote
1645 // commitment transaction towards the reserve value (as it implies no commitment transaction
1646 // will be generated which violates the remote reserve value).
1647 // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
1649 // * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
1650 // you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
1651 // you only consider the value of the first HTLC, it may not),
1652 // * start routing a third HTLC from A to B,
1653 // * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
1654 // the other claim in its holding cell, as it immediately goes into AwaitingRAA),
1655 // * deliver the first fulfill from B
1656 // * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
1658 // * deliver A's response CS and RAA.
1659 // This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
1660 // removed it fully. B now has the push_msat plus the first two HTLCs in value.
1661 // * Now B happily sends another HTLC, potentially violating its reserve value from A's point
1662 // of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
1663 let node_cfgs = create_node_cfgs(2);
1664 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1665 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1666 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1668 let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
1669 // Route the first two HTLCs.
1670 let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
1671 let (payment_preimage_2, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
1673 // Start routing the third HTLC (this is just used to get everyone in the right state).
1674 let (payment_preimage_3, payment_hash_3) = get_payment_preimage_hash!(nodes[0]);
1676 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
1677 nodes[0].node.send_payment(route, payment_hash_3).unwrap();
1678 check_added_monitors!(nodes[0], 1);
1679 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1680 assert_eq!(events.len(), 1);
1681 SendEvent::from_event(events.remove(0))
1684 // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
1685 // initial fulfill/CS.
1686 assert!(nodes[1].node.claim_funds(payment_preimage_1, b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000));
1687 check_added_monitors!(nodes[1], 1);
1688 let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1690 // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
1691 // remove the second HTLC when we send the HTLC back from B to A.
1692 assert!(nodes[1].node.claim_funds(payment_preimage_2, 20000));
1693 check_added_monitors!(nodes[1], 1);
1694 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1696 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
1697 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
1698 check_added_monitors!(nodes[0], 1);
1699 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1700 expect_payment_sent!(nodes[0], payment_preimage_1);
1702 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
1703 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
1704 check_added_monitors!(nodes[1], 1);
1705 // B is already AwaitingRAA, so cant generate a CS here
1706 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1708 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1709 check_added_monitors!(nodes[1], 1);
1710 let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1712 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1713 check_added_monitors!(nodes[0], 1);
1714 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1716 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1717 check_added_monitors!(nodes[1], 1);
1718 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1720 // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
1721 // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
1722 // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
1723 // can no longer broadcast a commitment transaction with it and B has the preimage so can go
1724 // on-chain as necessary).
1725 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
1726 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
1727 check_added_monitors!(nodes[0], 1);
1728 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1729 expect_payment_sent!(nodes[0], payment_preimage_2);
1731 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1732 check_added_monitors!(nodes[1], 1);
1733 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1735 expect_pending_htlcs_forwardable!(nodes[1]);
1736 expect_payment_received!(nodes[1], payment_hash_3, 100000);
1738 // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
1739 // resolve the second HTLC from A's point of view.
1740 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1741 check_added_monitors!(nodes[0], 1);
1742 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1744 // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
1745 // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
1746 let (payment_preimage_4, payment_hash_4) = get_payment_preimage_hash!(nodes[1]);
1748 let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &[], 10000, TEST_FINAL_CLTV).unwrap();
1749 nodes[1].node.send_payment(route, payment_hash_4).unwrap();
1750 check_added_monitors!(nodes[1], 1);
1751 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1752 assert_eq!(events.len(), 1);
1753 SendEvent::from_event(events.remove(0))
1756 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
1757 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
1758 check_added_monitors!(nodes[0], 1);
1759 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1761 // Now just resolve all the outstanding messages/HTLCs for completeness...
1763 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1764 check_added_monitors!(nodes[1], 1);
1765 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1767 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1768 check_added_monitors!(nodes[1], 1);
1770 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1771 check_added_monitors!(nodes[0], 1);
1772 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1774 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1775 check_added_monitors!(nodes[1], 1);
1776 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1778 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1779 check_added_monitors!(nodes[0], 1);
1781 expect_pending_htlcs_forwardable!(nodes[0]);
1782 expect_payment_received!(nodes[0], payment_hash_4, 10000);
1784 claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4, 10_000);
1785 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3, 100_000);
1789 fn channel_monitor_network_test() {
1790 // Simple test which builds a network of ChannelManagers, connects them to each other, and
1791 // tests that ChannelMonitor is able to recover from various states.
1792 let node_cfgs = create_node_cfgs(5);
1793 let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
1794 let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
1796 // Create some initial channels
1797 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1798 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
1799 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
1800 let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::supported(), InitFeatures::supported());
1802 // Rebalance the network a bit by relaying one payment through all the channels...
1803 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1804 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1805 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1806 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1808 // Simple case with no pending HTLCs:
1809 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
1811 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
1812 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1813 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
1814 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
1816 get_announce_close_broadcast_events(&nodes, 0, 1);
1817 assert_eq!(nodes[0].node.list_channels().len(), 0);
1818 assert_eq!(nodes[1].node.list_channels().len(), 1);
1820 // One pending HTLC is discarded by the force-close:
1821 let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
1823 // Simple case of one pending HTLC to HTLC-Timeout
1824 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
1826 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
1827 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1828 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
1829 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
1831 get_announce_close_broadcast_events(&nodes, 1, 2);
1832 assert_eq!(nodes[1].node.list_channels().len(), 0);
1833 assert_eq!(nodes[2].node.list_channels().len(), 1);
1835 macro_rules! claim_funds {
1836 ($node: expr, $prev_node: expr, $preimage: expr, $amount: expr) => {
1838 assert!($node.node.claim_funds($preimage, $amount));
1839 check_added_monitors!($node, 1);
1841 let events = $node.node.get_and_clear_pending_msg_events();
1842 assert_eq!(events.len(), 1);
1844 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
1845 assert!(update_add_htlcs.is_empty());
1846 assert!(update_fail_htlcs.is_empty());
1847 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
1849 _ => panic!("Unexpected event"),
1855 // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
1856 // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
1857 nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
1858 let node2_commitment_txid;
1860 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
1861 node2_commitment_txid = node_txn[0].txid();
1863 // Claim the payment on nodes[3], giving it knowledge of the preimage
1864 claim_funds!(nodes[3], nodes[2], payment_preimage_1, 3_000_000);
1866 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1867 nodes[3].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 1);
1869 check_preimage_claim(&nodes[3], &node_txn);
1871 get_announce_close_broadcast_events(&nodes, 2, 3);
1872 assert_eq!(nodes[2].node.list_channels().len(), 0);
1873 assert_eq!(nodes[3].node.list_channels().len(), 1);
1875 { // Cheat and reset nodes[4]'s height to 1
1876 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1877 nodes[4].block_notifier.block_connected(&Block { header, txdata: vec![] }, 1);
1880 assert_eq!(nodes[3].node.latest_block_height.load(Ordering::Acquire), 1);
1881 assert_eq!(nodes[4].node.latest_block_height.load(Ordering::Acquire), 1);
1882 // One pending HTLC to time out:
1883 let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
1884 // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
1888 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1889 nodes[3].block_notifier.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
1890 for i in 3..TEST_FINAL_CLTV + 2 + LATENCY_GRACE_PERIOD_BLOCKS + 1 {
1891 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1892 nodes[3].block_notifier.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
1895 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
1897 let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
1898 node_txn.retain(|tx| {
1899 if tx.input[0].previous_output.txid == node2_commitment_txid {
1905 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
1907 // Claim the payment on nodes[4], giving it knowledge of the preimage
1908 claim_funds!(nodes[4], nodes[3], payment_preimage_2, 3_000_000);
1910 header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1912 nodes[4].block_notifier.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
1913 for i in 3..TEST_FINAL_CLTV + 2 - CLTV_CLAIM_BUFFER + 1 {
1914 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1915 nodes[4].block_notifier.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
1918 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
1920 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1921 nodes[4].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, TEST_FINAL_CLTV - 5);
1923 check_preimage_claim(&nodes[4], &node_txn);
1925 get_announce_close_broadcast_events(&nodes, 3, 4);
1926 assert_eq!(nodes[3].node.list_channels().len(), 0);
1927 assert_eq!(nodes[4].node.list_channels().len(), 0);
1931 fn test_justice_tx() {
1932 // Test justice txn built on revoked HTLC-Success tx, against both sides
1933 let mut alice_config = UserConfig::default();
1934 alice_config.channel_options.announced_channel = true;
1935 alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
1936 alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
1937 let mut bob_config = UserConfig::default();
1938 bob_config.channel_options.announced_channel = true;
1939 bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
1940 bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
1941 let user_cfgs = [Some(alice_config), Some(bob_config)];
1942 let node_cfgs = create_node_cfgs(2);
1943 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
1944 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1945 // Create some new channels:
1946 let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1948 // A pending HTLC which will be revoked:
1949 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
1950 // Get the will-be-revoked local txn from nodes[0]
1951 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();
1952 assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
1953 assert_eq!(revoked_local_txn[0].input.len(), 1);
1954 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
1955 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
1956 assert_eq!(revoked_local_txn[1].input.len(), 1);
1957 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
1958 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
1959 // Revoke the old state
1960 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 3_000_000);
1963 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1964 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
1966 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
1967 assert_eq!(node_txn.len(), 3);
1968 assert_eq!(node_txn.pop().unwrap(), node_txn[0]); // An outpoint registration will result in a 2nd block_connected
1969 assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
1971 check_spends!(node_txn[0], revoked_local_txn[0].clone());
1972 node_txn.swap_remove(0);
1973 node_txn.truncate(1);
1975 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
1977 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
1978 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
1979 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1980 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
1981 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
1983 get_announce_close_broadcast_events(&nodes, 0, 1);
1985 assert_eq!(nodes[0].node.list_channels().len(), 0);
1986 assert_eq!(nodes[1].node.list_channels().len(), 0);
1988 // We test justice_tx build by A on B's revoked HTLC-Success tx
1989 // Create some new channels:
1990 let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1992 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
1996 // A pending HTLC which will be revoked:
1997 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
1998 // Get the will-be-revoked local txn from B
1999 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();
2000 assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2001 assert_eq!(revoked_local_txn[0].input.len(), 1);
2002 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2003 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2004 // Revoke the old state
2005 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4, 3_000_000);
2007 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2008 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2010 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2011 assert_eq!(node_txn.len(), 3);
2012 assert_eq!(node_txn.pop().unwrap(), node_txn[0]); // An outpoint registration will result in a 2nd block_connected
2013 assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2015 check_spends!(node_txn[0], revoked_local_txn[0].clone());
2016 node_txn.swap_remove(0);
2018 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2020 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2021 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2022 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2023 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2024 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2026 get_announce_close_broadcast_events(&nodes, 0, 1);
2027 assert_eq!(nodes[0].node.list_channels().len(), 0);
2028 assert_eq!(nodes[1].node.list_channels().len(), 0);
2032 fn revoked_output_claim() {
2033 // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2034 // transaction is broadcast by its counterparty
2035 let node_cfgs = create_node_cfgs(2);
2036 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2037 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2038 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2039 // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2040 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();
2041 assert_eq!(revoked_local_txn.len(), 1);
2042 // Only output is the full channel value back to nodes[0]:
2043 assert_eq!(revoked_local_txn[0].output.len(), 1);
2044 // Send a payment through, updating everyone's latest commitment txn
2045 send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000, 5_000_000);
2047 // Inform nodes[1] that nodes[0] broadcast a stale tx
2048 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2049 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2050 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2051 assert_eq!(node_txn.len(), 3); // nodes[1] will broadcast justice tx twice, and its own local state once
2053 assert_eq!(node_txn[0], node_txn[2]);
2055 check_spends!(node_txn[0], revoked_local_txn[0].clone());
2056 check_spends!(node_txn[1], chan_1.3.clone());
2058 // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2059 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2060 get_announce_close_broadcast_events(&nodes, 0, 1);
2064 fn claim_htlc_outputs_shared_tx() {
2065 // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2066 let node_cfgs = create_node_cfgs(2);
2067 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2068 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2070 // Create some new channel:
2071 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2073 // Rebalance the network to generate htlc in the two directions
2074 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2075 // 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
2076 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2077 let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2079 // Get the will-be-revoked local txn from node[0]
2080 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();
2081 assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2082 assert_eq!(revoked_local_txn[0].input.len(), 1);
2083 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2084 assert_eq!(revoked_local_txn[1].input.len(), 1);
2085 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2086 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2087 check_spends!(revoked_local_txn[1], revoked_local_txn[0].clone());
2089 //Revoke the old state
2090 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2093 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2094 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2095 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2096 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2098 let events = nodes[1].node.get_and_clear_pending_events();
2099 assert_eq!(events.len(), 1);
2101 Event::PaymentFailed { payment_hash, .. } => {
2102 assert_eq!(payment_hash, payment_hash_2);
2104 _ => panic!("Unexpected event"),
2107 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2108 assert_eq!(node_txn.len(), 4);
2110 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2111 check_spends!(node_txn[0], revoked_local_txn[0].clone());
2113 assert_eq!(node_txn[0], node_txn[3]); // justice tx is duplicated due to block re-scanning
2115 let mut witness_lens = BTreeSet::new();
2116 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2117 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2118 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2119 assert_eq!(witness_lens.len(), 3);
2120 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2121 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2122 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2124 // Next nodes[1] broadcasts its current local tx state:
2125 assert_eq!(node_txn[1].input.len(), 1);
2126 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2128 assert_eq!(node_txn[2].input.len(), 1);
2129 let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
2130 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2131 assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
2132 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2133 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
2135 get_announce_close_broadcast_events(&nodes, 0, 1);
2136 assert_eq!(nodes[0].node.list_channels().len(), 0);
2137 assert_eq!(nodes[1].node.list_channels().len(), 0);
2141 fn claim_htlc_outputs_single_tx() {
2142 // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2143 let node_cfgs = create_node_cfgs(2);
2144 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2145 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2147 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2149 // Rebalance the network to generate htlc in the two directions
2150 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2151 // 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
2152 // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2153 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2154 let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2156 // Get the will-be-revoked local txn from node[0]
2157 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();
2159 //Revoke the old state
2160 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2163 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2164 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2165 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2166 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
2168 let events = nodes[1].node.get_and_clear_pending_events();
2169 assert_eq!(events.len(), 1);
2171 Event::PaymentFailed { payment_hash, .. } => {
2172 assert_eq!(payment_hash, payment_hash_2);
2174 _ => panic!("Unexpected event"),
2177 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2178 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)
2180 assert_eq!(node_txn[0], node_txn[7]);
2181 assert_eq!(node_txn[1], node_txn[8]);
2182 assert_eq!(node_txn[2], node_txn[9]);
2183 assert_eq!(node_txn[3], node_txn[10]);
2184 assert_eq!(node_txn[4], node_txn[11]);
2185 assert_eq!(node_txn[3], node_txn[5]); //local commitment tx + htlc timeout tx broadcasted by ChannelManger
2186 assert_eq!(node_txn[4], node_txn[6]);
2188 assert_eq!(node_txn[0].input.len(), 1);
2189 assert_eq!(node_txn[1].input.len(), 1);
2190 assert_eq!(node_txn[2].input.len(), 1);
2192 fn get_txout(out_point: &BitcoinOutPoint, tx: &Transaction) -> Option<TxOut> {
2193 if out_point.txid == tx.txid() {
2194 tx.output.get(out_point.vout as usize).cloned()
2199 node_txn[0].verify(|out|get_txout(out, &revoked_local_txn[0])).unwrap();
2200 node_txn[1].verify(|out|get_txout(out, &revoked_local_txn[0])).unwrap();
2201 node_txn[2].verify(|out|get_txout(out, &revoked_local_txn[0])).unwrap();
2203 let mut witness_lens = BTreeSet::new();
2204 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2205 witness_lens.insert(node_txn[1].input[0].witness.last().unwrap().len());
2206 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2207 assert_eq!(witness_lens.len(), 3);
2208 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2209 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2210 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2212 assert_eq!(node_txn[3].input.len(), 1);
2213 check_spends!(node_txn[3], chan_1.3.clone());
2215 assert_eq!(node_txn[4].input.len(), 1);
2216 let witness_script = node_txn[4].input[0].witness.last().unwrap();
2217 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2218 assert_eq!(node_txn[4].input[0].previous_output.txid, node_txn[3].txid());
2219 assert_ne!(node_txn[4].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2220 assert_ne!(node_txn[4].input[0].previous_output.txid, node_txn[1].input[0].previous_output.txid);
2222 get_announce_close_broadcast_events(&nodes, 0, 1);
2223 assert_eq!(nodes[0].node.list_channels().len(), 0);
2224 assert_eq!(nodes[1].node.list_channels().len(), 0);
2228 fn test_htlc_on_chain_success() {
2229 // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2230 // ChainWatchInterface and pass the preimage backward accordingly. So here we test that ChannelManager is
2231 // broadcasting the right event to other nodes in payment path.
2232 // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2233 // A --------------------> B ----------------------> C (preimage)
2234 // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2235 // commitment transaction was broadcast.
2236 // Then, B should learn the preimage from said transactions, attempting to claim backwards
2238 // B should be able to claim via preimage if A then broadcasts its local tx.
2239 // Finally, when A sees B's latest local commitment transaction it should be able to claim
2240 // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2241 // PaymentSent event).
2243 let node_cfgs = create_node_cfgs(3);
2244 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2245 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2247 // Create some initial channels
2248 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2249 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2251 // Rebalance the network a bit by relaying one payment through all the channels...
2252 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2253 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2255 let (our_payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2256 let (our_payment_preimage_2, _payment_hash_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2257 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2259 // Broadcast legit commitment tx from C on B's chain
2260 // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2261 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();
2262 assert_eq!(commitment_tx.len(), 1);
2263 check_spends!(commitment_tx[0], chan_2.3.clone());
2264 nodes[2].node.claim_funds(our_payment_preimage, 3_000_000);
2265 nodes[2].node.claim_funds(our_payment_preimage_2, 3_000_000);
2266 check_added_monitors!(nodes[2], 2);
2267 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2268 assert!(updates.update_add_htlcs.is_empty());
2269 assert!(updates.update_fail_htlcs.is_empty());
2270 assert!(updates.update_fail_malformed_htlcs.is_empty());
2271 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2273 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2274 check_closed_broadcast!(nodes[2], false);
2275 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)
2276 assert_eq!(node_txn.len(), 7);
2277 assert_eq!(node_txn[0], node_txn[3]);
2278 assert_eq!(node_txn[1], node_txn[4]);
2279 assert_eq!(node_txn[0], node_txn[5]);
2280 assert_eq!(node_txn[1], node_txn[6]);
2281 assert_eq!(node_txn[2], commitment_tx[0]);
2282 check_spends!(node_txn[0], commitment_tx[0].clone());
2283 check_spends!(node_txn[1], commitment_tx[0].clone());
2284 assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2285 assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2286 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2287 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2288 assert_eq!(node_txn[0].lock_time, 0);
2289 assert_eq!(node_txn[1].lock_time, 0);
2291 // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2292 nodes[1].block_notifier.block_connected(&Block { header, txdata: node_txn}, 1);
2293 let events = nodes[1].node.get_and_clear_pending_msg_events();
2295 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
2296 assert_eq!(added_monitors.len(), 2);
2297 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2298 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2299 added_monitors.clear();
2301 assert_eq!(events.len(), 2);
2303 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2304 _ => panic!("Unexpected event"),
2307 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, .. } } => {
2308 assert!(update_add_htlcs.is_empty());
2309 assert!(update_fail_htlcs.is_empty());
2310 assert_eq!(update_fulfill_htlcs.len(), 1);
2311 assert!(update_fail_malformed_htlcs.is_empty());
2312 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2314 _ => panic!("Unexpected event"),
2316 macro_rules! check_tx_local_broadcast {
2317 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2318 // ChannelManager : 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor : 2 (timeout tx) * 2 (block-rescan)
2319 let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2320 assert_eq!(node_txn.len(), 7);
2321 assert_eq!(node_txn[0], node_txn[5]);
2322 assert_eq!(node_txn[1], node_txn[6]);
2323 check_spends!(node_txn[0], $commitment_tx.clone());
2324 check_spends!(node_txn[1], $commitment_tx.clone());
2325 assert_ne!(node_txn[0].lock_time, 0);
2326 assert_ne!(node_txn[1].lock_time, 0);
2328 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2329 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2330 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2331 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2333 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2334 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2335 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2336 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2338 check_spends!(node_txn[2], $chan_tx.clone());
2339 check_spends!(node_txn[3], node_txn[2].clone());
2340 check_spends!(node_txn[4], node_txn[2].clone());
2341 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), 71);
2342 assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2343 assert_eq!(node_txn[4].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2344 assert!(node_txn[3].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2345 assert!(node_txn[4].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2346 assert_ne!(node_txn[3].lock_time, 0);
2347 assert_ne!(node_txn[4].lock_time, 0);
2351 // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2352 // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2353 // timeout-claim of the output that nodes[2] just claimed via success.
2354 check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2356 // Broadcast legit commitment tx from A on B's chain
2357 // Broadcast preimage tx by B on offered output from A commitment tx on A's chain
2358 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();
2359 check_spends!(commitment_tx[0], chan_1.3.clone());
2360 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2361 check_closed_broadcast!(nodes[1], false);
2362 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)
2363 assert_eq!(node_txn.len(), 5);
2364 assert_eq!(node_txn[0], node_txn[4]);
2365 check_spends!(node_txn[0], commitment_tx[0].clone());
2366 assert_eq!(node_txn[0].input.len(), 2);
2367 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2368 assert_eq!(node_txn[0].input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2369 assert_eq!(node_txn[0].lock_time, 0);
2370 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2371 check_spends!(node_txn[1], chan_1.3.clone());
2372 assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2373 check_spends!(node_txn[2], node_txn[1]);
2374 check_spends!(node_txn[3], node_txn[1]);
2375 // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2376 // we already checked the same situation with A.
2378 // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2379 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone(), node_txn[0].clone()] }, 1);
2380 check_closed_broadcast!(nodes[0], false);
2381 let events = nodes[0].node.get_and_clear_pending_events();
2382 assert_eq!(events.len(), 2);
2383 let mut first_claimed = false;
2384 for event in events {
2386 Event::PaymentSent { payment_preimage } => {
2387 if payment_preimage == our_payment_preimage {
2388 assert!(!first_claimed);
2389 first_claimed = true;
2391 assert_eq!(payment_preimage, our_payment_preimage_2);
2394 _ => panic!("Unexpected event"),
2397 check_tx_local_broadcast!(nodes[0], true, commitment_tx[0], chan_1.3);
2401 fn test_htlc_on_chain_timeout() {
2402 // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2403 // ChainWatchInterface and timeout the HTLC backward accordingly. So here we test that ChannelManager is
2404 // broadcasting the right event to other nodes in payment path.
2405 // A ------------------> B ----------------------> C (timeout)
2406 // B's commitment tx C's commitment tx
2408 // B's HTLC timeout tx B's timeout tx
2410 let node_cfgs = create_node_cfgs(3);
2411 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2412 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2414 // Create some intial channels
2415 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2416 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2418 // Rebalance the network a bit by relaying one payment thorugh all the channels...
2419 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2420 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2422 let (_payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2423 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2425 // Broadcast legit commitment tx from C on B's chain
2426 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();
2427 check_spends!(commitment_tx[0], chan_2.3.clone());
2428 nodes[2].node.fail_htlc_backwards(&payment_hash);
2429 check_added_monitors!(nodes[2], 0);
2430 expect_pending_htlcs_forwardable!(nodes[2]);
2431 check_added_monitors!(nodes[2], 1);
2433 let events = nodes[2].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_fulfill_htlcs, ref update_fail_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[1].node.get_our_node_id(), *node_id);
2443 _ => panic!("Unexpected event"),
2445 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2446 check_closed_broadcast!(nodes[2], false);
2447 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2448 assert_eq!(node_txn.len(), 1);
2449 check_spends!(node_txn[0], chan_2.3.clone());
2450 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2452 // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2453 // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2454 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2457 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2458 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)
2459 assert_eq!(node_txn[0], node_txn[5]);
2460 assert_eq!(node_txn[1], node_txn[6]);
2461 assert_eq!(node_txn[2], node_txn[7]);
2462 check_spends!(node_txn[0], commitment_tx[0].clone());
2463 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2464 check_spends!(node_txn[1], chan_2.3.clone());
2465 check_spends!(node_txn[2], node_txn[1].clone());
2466 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2467 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2468 check_spends!(node_txn[3], chan_2.3.clone());
2469 check_spends!(node_txn[4], node_txn[3].clone());
2470 assert_eq!(node_txn[3].input[0].witness.clone().last().unwrap().len(), 71);
2471 assert_eq!(node_txn[4].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2472 timeout_tx = node_txn[0].clone();
2476 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![timeout_tx]}, 1);
2477 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2478 check_added_monitors!(nodes[1], 0);
2479 check_closed_broadcast!(nodes[1], false);
2481 expect_pending_htlcs_forwardable!(nodes[1]);
2482 check_added_monitors!(nodes[1], 1);
2483 let events = nodes[1].node.get_and_clear_pending_msg_events();
2484 assert_eq!(events.len(), 1);
2486 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, .. } } => {
2487 assert!(update_add_htlcs.is_empty());
2488 assert!(!update_fail_htlcs.is_empty());
2489 assert!(update_fulfill_htlcs.is_empty());
2490 assert!(update_fail_malformed_htlcs.is_empty());
2491 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2493 _ => panic!("Unexpected event"),
2495 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
2496 assert_eq!(node_txn.len(), 0);
2498 // Broadcast legit commitment tx from B on A's chain
2499 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();
2500 check_spends!(commitment_tx[0], chan_1.3.clone());
2502 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2503 check_closed_broadcast!(nodes[0], false);
2504 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
2505 assert_eq!(node_txn.len(), 4);
2506 assert_eq!(node_txn[0], node_txn[3]);
2507 check_spends!(node_txn[0], commitment_tx[0].clone());
2508 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2509 check_spends!(node_txn[1], chan_1.3.clone());
2510 check_spends!(node_txn[2], node_txn[1].clone());
2511 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2512 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2516 fn test_simple_commitment_revoked_fail_backward() {
2517 // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
2518 // and fail backward accordingly.
2520 let node_cfgs = create_node_cfgs(3);
2521 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2522 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2524 // Create some initial channels
2525 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2526 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2528 let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2529 // Get the will-be-revoked local txn from nodes[2]
2530 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();
2531 // Revoke the old state
2532 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, 3_000_000);
2534 route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2536 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2537 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2538 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2539 check_added_monitors!(nodes[1], 0);
2540 check_closed_broadcast!(nodes[1], false);
2542 expect_pending_htlcs_forwardable!(nodes[1]);
2543 check_added_monitors!(nodes[1], 1);
2544 let events = nodes[1].node.get_and_clear_pending_msg_events();
2545 assert_eq!(events.len(), 1);
2547 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, .. } } => {
2548 assert!(update_add_htlcs.is_empty());
2549 assert_eq!(update_fail_htlcs.len(), 1);
2550 assert!(update_fulfill_htlcs.is_empty());
2551 assert!(update_fail_malformed_htlcs.is_empty());
2552 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2554 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
2555 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2557 let events = nodes[0].node.get_and_clear_pending_msg_events();
2558 assert_eq!(events.len(), 1);
2560 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
2561 _ => panic!("Unexpected event"),
2563 let events = nodes[0].node.get_and_clear_pending_events();
2564 assert_eq!(events.len(), 1);
2566 Event::PaymentFailed { .. } => {},
2567 _ => panic!("Unexpected event"),
2570 _ => panic!("Unexpected event"),
2574 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
2575 // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
2576 // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
2577 // commitment transaction anymore.
2578 // To do this, we have the peer which will broadcast a revoked commitment transaction send
2579 // a number of update_fail/commitment_signed updates without ever sending the RAA in
2580 // response to our commitment_signed. This is somewhat misbehavior-y, though not
2581 // technically disallowed and we should probably handle it reasonably.
2582 // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
2583 // failed/fulfilled backwards must be in at least one of the latest two remote commitment
2585 // * Once we move it out of our holding cell/add it, we will immediately include it in a
2586 // commitment_signed (implying it will be in the latest remote commitment transaction).
2587 // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
2588 // and once they revoke the previous commitment transaction (allowing us to send a new
2589 // commitment_signed) we will be free to fail/fulfill the HTLC backwards.
2590 let node_cfgs = create_node_cfgs(3);
2591 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2592 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2594 // Create some initial channels
2595 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2596 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2598 let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], if no_to_remote { 10_000 } else { 3_000_000 });
2599 // Get the will-be-revoked local txn from nodes[2]
2600 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();
2601 assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
2602 // Revoke the old state
2603 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, if no_to_remote { 10_000 } else { 3_000_000});
2605 let value = if use_dust {
2606 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
2607 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
2608 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().our_dust_limit_satoshis * 1000
2611 let (_, first_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2612 let (_, second_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2613 let (_, third_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2615 assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash));
2616 expect_pending_htlcs_forwardable!(nodes[2]);
2617 check_added_monitors!(nodes[2], 1);
2618 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2619 assert!(updates.update_add_htlcs.is_empty());
2620 assert!(updates.update_fulfill_htlcs.is_empty());
2621 assert!(updates.update_fail_malformed_htlcs.is_empty());
2622 assert_eq!(updates.update_fail_htlcs.len(), 1);
2623 assert!(updates.update_fee.is_none());
2624 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2625 let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
2626 // Drop the last RAA from 3 -> 2
2628 assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash));
2629 expect_pending_htlcs_forwardable!(nodes[2]);
2630 check_added_monitors!(nodes[2], 1);
2631 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2632 assert!(updates.update_add_htlcs.is_empty());
2633 assert!(updates.update_fulfill_htlcs.is_empty());
2634 assert!(updates.update_fail_malformed_htlcs.is_empty());
2635 assert_eq!(updates.update_fail_htlcs.len(), 1);
2636 assert!(updates.update_fee.is_none());
2637 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2638 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2639 check_added_monitors!(nodes[1], 1);
2640 // Note that nodes[1] is in AwaitingRAA, so won't send a CS
2641 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2642 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2643 check_added_monitors!(nodes[2], 1);
2645 assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash));
2646 expect_pending_htlcs_forwardable!(nodes[2]);
2647 check_added_monitors!(nodes[2], 1);
2648 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2649 assert!(updates.update_add_htlcs.is_empty());
2650 assert!(updates.update_fulfill_htlcs.is_empty());
2651 assert!(updates.update_fail_malformed_htlcs.is_empty());
2652 assert_eq!(updates.update_fail_htlcs.len(), 1);
2653 assert!(updates.update_fee.is_none());
2654 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2655 // At this point first_payment_hash has dropped out of the latest two commitment
2656 // transactions that nodes[1] is tracking...
2657 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2658 check_added_monitors!(nodes[1], 1);
2659 // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
2660 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2661 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2662 check_added_monitors!(nodes[2], 1);
2664 // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
2665 // on nodes[2]'s RAA.
2666 let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
2667 let (_, fourth_payment_hash) = get_payment_preimage_hash!(nodes[0]);
2668 nodes[1].node.send_payment(route, fourth_payment_hash).unwrap();
2669 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2670 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2671 check_added_monitors!(nodes[1], 0);
2674 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
2675 // One monitor for the new revocation preimage, no second on as we won't generate a new
2676 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
2677 check_added_monitors!(nodes[1], 1);
2678 let events = nodes[1].node.get_and_clear_pending_events();
2679 assert_eq!(events.len(), 1);
2681 Event::PendingHTLCsForwardable { .. } => { },
2682 _ => panic!("Unexpected event"),
2684 // Deliberately don't process the pending fail-back so they all fail back at once after
2685 // block connection just like the !deliver_bs_raa case
2688 let mut failed_htlcs = HashSet::new();
2689 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2691 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2692 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2693 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2695 let events = nodes[1].node.get_and_clear_pending_events();
2696 assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
2698 Event::PaymentFailed { ref payment_hash, .. } => {
2699 assert_eq!(*payment_hash, fourth_payment_hash);
2701 _ => panic!("Unexpected event"),
2703 if !deliver_bs_raa {
2705 Event::PendingHTLCsForwardable { .. } => { },
2706 _ => panic!("Unexpected event"),
2709 nodes[1].node.process_pending_htlc_forwards();
2710 check_added_monitors!(nodes[1], 1);
2712 let events = nodes[1].node.get_and_clear_pending_msg_events();
2713 assert_eq!(events.len(), if deliver_bs_raa { 3 } else { 2 });
2714 match events[if deliver_bs_raa { 1 } else { 0 }] {
2715 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
2716 _ => panic!("Unexpected event"),
2720 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, .. } } => {
2721 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
2722 assert_eq!(update_add_htlcs.len(), 1);
2723 assert!(update_fulfill_htlcs.is_empty());
2724 assert!(update_fail_htlcs.is_empty());
2725 assert!(update_fail_malformed_htlcs.is_empty());
2727 _ => panic!("Unexpected event"),
2730 match events[if deliver_bs_raa { 2 } else { 1 }] {
2731 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, .. } } => {
2732 assert!(update_add_htlcs.is_empty());
2733 assert_eq!(update_fail_htlcs.len(), 3);
2734 assert!(update_fulfill_htlcs.is_empty());
2735 assert!(update_fail_malformed_htlcs.is_empty());
2736 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2738 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
2739 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
2740 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
2742 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2744 let events = nodes[0].node.get_and_clear_pending_msg_events();
2745 // If we delivered B's RAA we got an unknown preimage error, not something
2746 // that we should update our routing table for.
2747 assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
2748 for event in events {
2750 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
2751 _ => panic!("Unexpected event"),
2754 let events = nodes[0].node.get_and_clear_pending_events();
2755 assert_eq!(events.len(), 3);
2757 Event::PaymentFailed { ref payment_hash, .. } => {
2758 assert!(failed_htlcs.insert(payment_hash.0));
2760 _ => panic!("Unexpected event"),
2763 Event::PaymentFailed { ref payment_hash, .. } => {
2764 assert!(failed_htlcs.insert(payment_hash.0));
2766 _ => panic!("Unexpected event"),
2769 Event::PaymentFailed { ref payment_hash, .. } => {
2770 assert!(failed_htlcs.insert(payment_hash.0));
2772 _ => panic!("Unexpected event"),
2775 _ => panic!("Unexpected event"),
2778 assert!(failed_htlcs.contains(&first_payment_hash.0));
2779 assert!(failed_htlcs.contains(&second_payment_hash.0));
2780 assert!(failed_htlcs.contains(&third_payment_hash.0));
2784 fn test_commitment_revoked_fail_backward_exhaustive_a() {
2785 do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
2786 do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
2787 do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
2788 do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
2792 fn test_commitment_revoked_fail_backward_exhaustive_b() {
2793 do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
2794 do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
2795 do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
2796 do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
2800 fn test_htlc_ignore_latest_remote_commitment() {
2801 // Test that HTLC transactions spending the latest remote commitment transaction are simply
2802 // ignored if we cannot claim them. This originally tickled an invalid unwrap().
2803 let node_cfgs = create_node_cfgs(2);
2804 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2805 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2806 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2808 route_payment(&nodes[0], &[&nodes[1]], 10000000);
2809 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id);
2810 check_closed_broadcast!(nodes[0], false);
2812 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2813 assert_eq!(node_txn.len(), 2);
2815 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2816 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
2817 check_closed_broadcast!(nodes[1], false);
2819 // Duplicate the block_connected call since this may happen due to other listeners
2820 // registering new transactions
2821 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
2825 fn test_force_close_fail_back() {
2826 // Check which HTLCs are failed-backwards on channel force-closure
2827 let node_cfgs = create_node_cfgs(3);
2828 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2829 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2830 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2831 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2833 let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, 42).unwrap();
2835 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
2837 let mut payment_event = {
2838 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
2839 check_added_monitors!(nodes[0], 1);
2841 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2842 assert_eq!(events.len(), 1);
2843 SendEvent::from_event(events.remove(0))
2846 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
2847 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
2849 expect_pending_htlcs_forwardable!(nodes[1]);
2851 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
2852 assert_eq!(events_2.len(), 1);
2853 payment_event = SendEvent::from_event(events_2.remove(0));
2854 assert_eq!(payment_event.msgs.len(), 1);
2856 check_added_monitors!(nodes[1], 1);
2857 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
2858 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
2859 check_added_monitors!(nodes[2], 1);
2860 let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2862 // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
2863 // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
2864 // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
2866 nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id);
2867 check_closed_broadcast!(nodes[2], false);
2869 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
2870 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
2871 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
2872 // back to nodes[1] upon timeout otherwise.
2873 assert_eq!(node_txn.len(), 1);
2877 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2878 nodes[1].block_notifier.block_connected_checked(&header, 1, &[&tx], &[1]);
2880 // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
2881 check_closed_broadcast!(nodes[1], false);
2883 // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
2885 let mut monitors = nodes[2].chan_monitor.simple_monitor.monitors.lock().unwrap();
2886 monitors.get_mut(&OutPoint::new(Sha256dHash::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), 0)).unwrap()
2887 .provide_payment_preimage(&our_payment_hash, &our_payment_preimage);
2889 nodes[2].block_notifier.block_connected_checked(&header, 1, &[&tx], &[1]);
2890 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
2891 assert_eq!(node_txn.len(), 1);
2892 assert_eq!(node_txn[0].input.len(), 1);
2893 assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
2894 assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
2895 assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
2897 check_spends!(node_txn[0], tx);
2901 fn test_unconf_chan() {
2902 // After creating a chan between nodes, we disconnect all blocks previously seen to force a channel close on nodes[0] side
2903 let node_cfgs = create_node_cfgs(2);
2904 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2905 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2906 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2908 let channel_state = nodes[0].node.channel_state.lock().unwrap();
2909 assert_eq!(channel_state.by_id.len(), 1);
2910 assert_eq!(channel_state.short_to_id.len(), 1);
2911 mem::drop(channel_state);
2913 let mut headers = Vec::new();
2914 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2915 headers.push(header.clone());
2917 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2918 headers.push(header.clone());
2920 let mut height = 99;
2921 while !headers.is_empty() {
2922 nodes[0].node.block_disconnected(&headers.pop().unwrap(), height);
2925 check_closed_broadcast!(nodes[0], false);
2926 let channel_state = nodes[0].node.channel_state.lock().unwrap();
2927 assert_eq!(channel_state.by_id.len(), 0);
2928 assert_eq!(channel_state.short_to_id.len(), 0);
2932 fn test_simple_peer_disconnect() {
2933 // Test that we can reconnect when there are no lost messages
2934 let node_cfgs = create_node_cfgs(3);
2935 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2936 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2937 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2938 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2940 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2941 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2942 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
2944 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
2945 let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
2946 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
2947 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1, 1_000_000);
2949 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2950 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2951 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
2953 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
2954 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
2955 let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
2956 let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
2958 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2959 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2961 claim_payment_along_route(&nodes[0], &vec!(&nodes[1], &nodes[2]), true, payment_preimage_3, 1_000_000);
2962 fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
2964 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
2966 let events = nodes[0].node.get_and_clear_pending_events();
2967 assert_eq!(events.len(), 2);
2969 Event::PaymentSent { payment_preimage } => {
2970 assert_eq!(payment_preimage, payment_preimage_3);
2972 _ => panic!("Unexpected event"),
2975 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
2976 assert_eq!(payment_hash, payment_hash_5);
2977 assert!(rejected_by_dest);
2979 _ => panic!("Unexpected event"),
2983 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4, 1_000_000);
2984 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
2987 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
2988 // Test that we can reconnect when in-flight HTLC updates get dropped
2989 let node_cfgs = create_node_cfgs(2);
2990 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2991 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2992 if messages_delivered == 0 {
2993 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
2994 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
2996 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2999 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();
3000 let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
3002 let payment_event = {
3003 nodes[0].node.send_payment(route.clone(), payment_hash_1).unwrap();
3004 check_added_monitors!(nodes[0], 1);
3006 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3007 assert_eq!(events.len(), 1);
3008 SendEvent::from_event(events.remove(0))
3010 assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3012 if messages_delivered < 2 {
3013 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3015 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3016 if messages_delivered >= 3 {
3017 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3018 check_added_monitors!(nodes[1], 1);
3019 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3021 if messages_delivered >= 4 {
3022 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3023 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3024 check_added_monitors!(nodes[0], 1);
3026 if messages_delivered >= 5 {
3027 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3028 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3029 // No commitment_signed so get_event_msg's assert(len == 1) passes
3030 check_added_monitors!(nodes[0], 1);
3032 if messages_delivered >= 6 {
3033 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3034 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3035 check_added_monitors!(nodes[1], 1);
3042 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3043 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3044 if messages_delivered < 3 {
3045 // Even if the funding_locked messages get exchanged, as long as nothing further was
3046 // received on either side, both sides will need to resend them.
3047 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3048 } else if messages_delivered == 3 {
3049 // nodes[0] still wants its RAA + commitment_signed
3050 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3051 } else if messages_delivered == 4 {
3052 // nodes[0] still wants its commitment_signed
3053 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3054 } else if messages_delivered == 5 {
3055 // nodes[1] still wants its final RAA
3056 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3057 } else if messages_delivered == 6 {
3058 // Everything was delivered...
3059 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3062 let events_1 = nodes[1].node.get_and_clear_pending_events();
3063 assert_eq!(events_1.len(), 1);
3065 Event::PendingHTLCsForwardable { .. } => { },
3066 _ => panic!("Unexpected event"),
3069 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3070 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3071 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3073 nodes[1].node.process_pending_htlc_forwards();
3075 let events_2 = nodes[1].node.get_and_clear_pending_events();
3076 assert_eq!(events_2.len(), 1);
3078 Event::PaymentReceived { ref payment_hash, amt } => {
3079 assert_eq!(payment_hash_1, *payment_hash);
3080 assert_eq!(amt, 1000000);
3082 _ => panic!("Unexpected event"),
3085 nodes[1].node.claim_funds(payment_preimage_1, 1_000_000);
3086 check_added_monitors!(nodes[1], 1);
3088 let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3089 assert_eq!(events_3.len(), 1);
3090 let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3091 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3092 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3093 assert!(updates.update_add_htlcs.is_empty());
3094 assert!(updates.update_fail_htlcs.is_empty());
3095 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3096 assert!(updates.update_fail_malformed_htlcs.is_empty());
3097 assert!(updates.update_fee.is_none());
3098 (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3100 _ => panic!("Unexpected event"),
3103 if messages_delivered >= 1 {
3104 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3106 let events_4 = nodes[0].node.get_and_clear_pending_events();
3107 assert_eq!(events_4.len(), 1);
3109 Event::PaymentSent { ref payment_preimage } => {
3110 assert_eq!(payment_preimage_1, *payment_preimage);
3112 _ => panic!("Unexpected event"),
3115 if messages_delivered >= 2 {
3116 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3117 check_added_monitors!(nodes[0], 1);
3118 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3120 if messages_delivered >= 3 {
3121 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3122 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3123 check_added_monitors!(nodes[1], 1);
3125 if messages_delivered >= 4 {
3126 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3127 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3128 // No commitment_signed so get_event_msg's assert(len == 1) passes
3129 check_added_monitors!(nodes[1], 1);
3131 if messages_delivered >= 5 {
3132 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3133 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3134 check_added_monitors!(nodes[0], 1);
3141 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3142 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3143 if messages_delivered < 2 {
3144 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3145 //TODO: Deduplicate PaymentSent events, then enable this if:
3146 //if messages_delivered < 1 {
3147 let events_4 = nodes[0].node.get_and_clear_pending_events();
3148 assert_eq!(events_4.len(), 1);
3150 Event::PaymentSent { ref payment_preimage } => {
3151 assert_eq!(payment_preimage_1, *payment_preimage);
3153 _ => panic!("Unexpected event"),
3156 } else if messages_delivered == 2 {
3157 // nodes[0] still wants its RAA + commitment_signed
3158 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3159 } else if messages_delivered == 3 {
3160 // nodes[0] still wants its commitment_signed
3161 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3162 } else if messages_delivered == 4 {
3163 // nodes[1] still wants its final RAA
3164 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3165 } else if messages_delivered == 5 {
3166 // Everything was delivered...
3167 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3170 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3171 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3172 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3174 // Channel should still work fine...
3175 let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3176 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3180 fn test_drop_messages_peer_disconnect_a() {
3181 do_test_drop_messages_peer_disconnect(0);
3182 do_test_drop_messages_peer_disconnect(1);
3183 do_test_drop_messages_peer_disconnect(2);
3184 do_test_drop_messages_peer_disconnect(3);
3188 fn test_drop_messages_peer_disconnect_b() {
3189 do_test_drop_messages_peer_disconnect(4);
3190 do_test_drop_messages_peer_disconnect(5);
3191 do_test_drop_messages_peer_disconnect(6);
3195 fn test_funding_peer_disconnect() {
3196 // Test that we can lock in our funding tx while disconnected
3197 let node_cfgs = create_node_cfgs(2);
3198 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3199 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3200 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
3202 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3203 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3205 confirm_transaction(&nodes[0].block_notifier, &nodes[0].chain_monitor, &tx, tx.version);
3206 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3207 assert_eq!(events_1.len(), 1);
3209 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3210 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3212 _ => panic!("Unexpected event"),
3215 reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3217 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3218 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3220 confirm_transaction(&nodes[1].block_notifier, &nodes[1].chain_monitor, &tx, tx.version);
3221 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3222 assert_eq!(events_2.len(), 2);
3223 let funding_locked = match events_2[0] {
3224 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3225 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3228 _ => panic!("Unexpected event"),
3230 let bs_announcement_sigs = match events_2[1] {
3231 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3232 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3235 _ => panic!("Unexpected event"),
3238 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3240 nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3241 nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3242 let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3243 assert_eq!(events_3.len(), 2);
3244 let as_announcement_sigs = match events_3[0] {
3245 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3246 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3249 _ => panic!("Unexpected event"),
3251 let (as_announcement, as_update) = match events_3[1] {
3252 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3253 (msg.clone(), update_msg.clone())
3255 _ => panic!("Unexpected event"),
3258 nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3259 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3260 assert_eq!(events_4.len(), 1);
3261 let (_, bs_update) = match events_4[0] {
3262 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3263 (msg.clone(), update_msg.clone())
3265 _ => panic!("Unexpected event"),
3268 nodes[0].router.handle_channel_announcement(&as_announcement).unwrap();
3269 nodes[0].router.handle_channel_update(&bs_update).unwrap();
3270 nodes[0].router.handle_channel_update(&as_update).unwrap();
3272 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
3273 let (payment_preimage, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3274 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage, 1_000_000);
3278 fn test_drop_messages_peer_disconnect_dual_htlc() {
3279 // Test that we can handle reconnecting when both sides of a channel have pending
3280 // commitment_updates when we disconnect.
3281 let node_cfgs = create_node_cfgs(2);
3282 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3283 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3284 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3286 let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3288 // Now try to send a second payment which will fail to send
3289 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
3290 let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
3292 nodes[0].node.send_payment(route.clone(), payment_hash_2).unwrap();
3293 check_added_monitors!(nodes[0], 1);
3295 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3296 assert_eq!(events_1.len(), 1);
3298 MessageSendEvent::UpdateHTLCs { .. } => {},
3299 _ => panic!("Unexpected event"),
3302 assert!(nodes[1].node.claim_funds(payment_preimage_1, 1_000_000));
3303 check_added_monitors!(nodes[1], 1);
3305 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3306 assert_eq!(events_2.len(), 1);
3308 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 } } => {
3309 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3310 assert!(update_add_htlcs.is_empty());
3311 assert_eq!(update_fulfill_htlcs.len(), 1);
3312 assert!(update_fail_htlcs.is_empty());
3313 assert!(update_fail_malformed_htlcs.is_empty());
3314 assert!(update_fee.is_none());
3316 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3317 let events_3 = nodes[0].node.get_and_clear_pending_events();
3318 assert_eq!(events_3.len(), 1);
3320 Event::PaymentSent { ref payment_preimage } => {
3321 assert_eq!(*payment_preimage, payment_preimage_1);
3323 _ => panic!("Unexpected event"),
3326 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
3327 let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3328 // No commitment_signed so get_event_msg's assert(len == 1) passes
3329 check_added_monitors!(nodes[0], 1);
3331 _ => panic!("Unexpected event"),
3334 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3335 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3337 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3338 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3339 assert_eq!(reestablish_1.len(), 1);
3340 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3341 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3342 assert_eq!(reestablish_2.len(), 1);
3344 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3345 let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3346 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3347 let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3349 assert!(as_resp.0.is_none());
3350 assert!(bs_resp.0.is_none());
3352 assert!(bs_resp.1.is_none());
3353 assert!(bs_resp.2.is_none());
3355 assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3357 assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3358 assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3359 assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3360 assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3361 assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3362 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
3363 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
3364 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3365 // No commitment_signed so get_event_msg's assert(len == 1) passes
3366 check_added_monitors!(nodes[1], 1);
3368 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
3369 let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3370 assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
3371 assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
3372 assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
3373 assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
3374 assert!(bs_second_commitment_signed.update_fee.is_none());
3375 check_added_monitors!(nodes[1], 1);
3377 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3378 let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3379 assert!(as_commitment_signed.update_add_htlcs.is_empty());
3380 assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
3381 assert!(as_commitment_signed.update_fail_htlcs.is_empty());
3382 assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
3383 assert!(as_commitment_signed.update_fee.is_none());
3384 check_added_monitors!(nodes[0], 1);
3386 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
3387 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3388 // No commitment_signed so get_event_msg's assert(len == 1) passes
3389 check_added_monitors!(nodes[0], 1);
3391 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
3392 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3393 // No commitment_signed so get_event_msg's assert(len == 1) passes
3394 check_added_monitors!(nodes[1], 1);
3396 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3397 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3398 check_added_monitors!(nodes[1], 1);
3400 expect_pending_htlcs_forwardable!(nodes[1]);
3402 let events_5 = nodes[1].node.get_and_clear_pending_events();
3403 assert_eq!(events_5.len(), 1);
3405 Event::PaymentReceived { ref payment_hash, amt: _ } => {
3406 assert_eq!(payment_hash_2, *payment_hash);
3408 _ => panic!("Unexpected event"),
3411 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
3412 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3413 check_added_monitors!(nodes[0], 1);
3415 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3419 fn test_invalid_channel_announcement() {
3420 //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
3421 let secp_ctx = Secp256k1::new();
3422 let node_cfgs = create_node_cfgs(2);
3423 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3424 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3426 let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::supported(), InitFeatures::supported());
3428 let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
3429 let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
3430 let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
3431 let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
3433 nodes[0].router.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap(), is_permanent: false } );
3435 let as_bitcoin_key = PublicKey::from_secret_key(&secp_ctx, &as_chan.get_local_keys().inner.funding_key);
3436 let bs_bitcoin_key = PublicKey::from_secret_key(&secp_ctx, &bs_chan.get_local_keys().inner.funding_key);
3438 let as_network_key = nodes[0].node.get_our_node_id();
3439 let bs_network_key = nodes[1].node.get_our_node_id();
3441 let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
3443 let mut chan_announcement;
3445 macro_rules! dummy_unsigned_msg {
3447 msgs::UnsignedChannelAnnouncement {
3448 features: ChannelFeatures::supported(),
3449 chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
3450 short_channel_id: as_chan.get_short_channel_id().unwrap(),
3451 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
3452 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
3453 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
3454 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
3455 excess_data: Vec::new(),
3460 macro_rules! sign_msg {
3461 ($unsigned_msg: expr) => {
3462 let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
3463 let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_local_keys().inner.funding_key);
3464 let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_local_keys().inner.funding_key);
3465 let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
3466 let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
3467 chan_announcement = msgs::ChannelAnnouncement {
3468 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
3469 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
3470 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
3471 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
3472 contents: $unsigned_msg
3477 let unsigned_msg = dummy_unsigned_msg!();
3478 sign_msg!(unsigned_msg);
3479 assert_eq!(nodes[0].router.handle_channel_announcement(&chan_announcement).unwrap(), true);
3480 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 } );
3482 // Configured with Network::Testnet
3483 let mut unsigned_msg = dummy_unsigned_msg!();
3484 unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.bitcoin_hash();
3485 sign_msg!(unsigned_msg);
3486 assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
3488 let mut unsigned_msg = dummy_unsigned_msg!();
3489 unsigned_msg.chain_hash = Sha256dHash::hash(&[1,2,3,4,5,6,7,8,9]);
3490 sign_msg!(unsigned_msg);
3491 assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
3495 fn test_no_txn_manager_serialize_deserialize() {
3496 let node_cfgs = create_node_cfgs(2);
3497 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3498 let new_chan_monitor: test_utils::TestChannelMonitor;
3499 let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor>;
3500 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3502 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
3504 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3506 let nodes_0_serialized = nodes[0].node.encode();
3507 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3508 nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
3510 new_chan_monitor = 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 }));
3511 nodes[0].chan_monitor = &new_chan_monitor;
3512 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3513 let (_, mut chan_0_monitor) = <(Sha256dHash, ChannelMonitor)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
3514 assert!(chan_0_monitor_read.is_empty());
3516 let mut nodes_0_read = &nodes_0_serialized[..];
3517 let config = UserConfig::default();
3518 let keys_manager = Arc::new(test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
3519 let (_, nodes_0_deserialized_tmp) = {
3520 let mut channel_monitors = HashMap::new();
3521 channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &mut chan_0_monitor);
3522 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3523 default_config: config,
3525 fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
3526 monitor: nodes[0].chan_monitor,
3527 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3528 logger: Arc::new(test_utils::TestLogger::new()),
3529 channel_monitors: &mut channel_monitors,
3532 nodes_0_deserialized = nodes_0_deserialized_tmp;
3533 assert!(nodes_0_read.is_empty());
3535 assert!(nodes[0].chan_monitor.add_update_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
3536 nodes[0].node = &nodes_0_deserialized;
3537 nodes[0].block_notifier.register_listener(nodes[0].node);
3538 assert_eq!(nodes[0].node.list_channels().len(), 1);
3539 check_added_monitors!(nodes[0], 1);
3541 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3542 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3543 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3544 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3546 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3547 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3548 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3549 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3551 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
3552 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
3553 for node in nodes.iter() {
3554 assert!(node.router.handle_channel_announcement(&announcement).unwrap());
3555 node.router.handle_channel_update(&as_update).unwrap();
3556 node.router.handle_channel_update(&bs_update).unwrap();
3559 send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
3563 fn test_simple_manager_serialize_deserialize() {
3564 let node_cfgs = create_node_cfgs(2);
3565 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3566 let new_chan_monitor: test_utils::TestChannelMonitor;
3567 let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor>;
3568 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3569 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3571 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3572 let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3574 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3576 let nodes_0_serialized = nodes[0].node.encode();
3577 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3578 nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
3580 new_chan_monitor = 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 }));
3581 nodes[0].chan_monitor = &new_chan_monitor;
3582 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3583 let (_, mut chan_0_monitor) = <(Sha256dHash, ChannelMonitor)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
3584 assert!(chan_0_monitor_read.is_empty());
3586 let mut nodes_0_read = &nodes_0_serialized[..];
3587 let keys_manager = Arc::new(test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
3588 let (_, nodes_0_deserialized_tmp) = {
3589 let mut channel_monitors = HashMap::new();
3590 channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &mut chan_0_monitor);
3591 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3592 default_config: UserConfig::default(),
3594 fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
3595 monitor: nodes[0].chan_monitor,
3596 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3597 logger: Arc::new(test_utils::TestLogger::new()),
3598 channel_monitors: &mut channel_monitors,
3601 nodes_0_deserialized = nodes_0_deserialized_tmp;
3602 assert!(nodes_0_read.is_empty());
3604 assert!(nodes[0].chan_monitor.add_update_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
3605 nodes[0].node = &nodes_0_deserialized;
3606 check_added_monitors!(nodes[0], 1);
3608 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3610 fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
3611 claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage, 1_000_000);
3615 fn test_manager_serialize_deserialize_inconsistent_monitor() {
3616 // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
3617 let node_cfgs = create_node_cfgs(4);
3618 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
3619 let new_chan_monitor: test_utils::TestChannelMonitor;
3620 let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor>;
3621 let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
3622 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3623 create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::supported(), InitFeatures::supported());
3624 let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::supported(), InitFeatures::supported());
3626 let (our_payment_preimage, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
3628 // Serialize the ChannelManager here, but the monitor we keep up-to-date
3629 let nodes_0_serialized = nodes[0].node.encode();
3631 route_payment(&nodes[0], &[&nodes[3]], 1000000);
3632 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3633 nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3634 nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3636 // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
3638 let mut node_0_monitors_serialized = Vec::new();
3639 for monitor in nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter() {
3640 let mut writer = test_utils::TestVecWriter(Vec::new());
3641 monitor.1.write_for_disk(&mut writer).unwrap();
3642 node_0_monitors_serialized.push(writer.0);
3645 new_chan_monitor = 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 }));
3646 nodes[0].chan_monitor = &new_chan_monitor;
3647 let mut node_0_monitors = Vec::new();
3648 for serialized in node_0_monitors_serialized.iter() {
3649 let mut read = &serialized[..];
3650 let (_, monitor) = <(Sha256dHash, ChannelMonitor)>::read(&mut read, Arc::new(test_utils::TestLogger::new())).unwrap();
3651 assert!(read.is_empty());
3652 node_0_monitors.push(monitor);
3655 let mut nodes_0_read = &nodes_0_serialized[..];
3656 let keys_manager = Arc::new(test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
3657 let (_, nodes_0_deserialized_tmp) = <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3658 default_config: UserConfig::default(),
3660 fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
3661 monitor: nodes[0].chan_monitor,
3662 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3663 logger: Arc::new(test_utils::TestLogger::new()),
3664 channel_monitors: &mut node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().unwrap(), monitor) }).collect(),
3666 nodes_0_deserialized = nodes_0_deserialized_tmp;
3667 assert!(nodes_0_read.is_empty());
3669 { // Channel close should result in a commitment tx and an HTLC tx
3670 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3671 assert_eq!(txn.len(), 2);
3672 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
3673 assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
3676 for monitor in node_0_monitors.drain(..) {
3677 assert!(nodes[0].chan_monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor).is_ok());
3678 check_added_monitors!(nodes[0], 1);
3680 nodes[0].node = &nodes_0_deserialized;
3682 // nodes[1] and nodes[2] have no lost state with nodes[0]...
3683 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3684 reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3685 //... and we can even still claim the payment!
3686 claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage, 1_000_000);
3688 nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3689 let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
3690 nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3691 nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
3692 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
3693 assert_eq!(msg_events.len(), 1);
3694 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
3696 &ErrorAction::SendErrorMessage { ref msg } => {
3697 assert_eq!(msg.channel_id, channel_id);
3699 _ => panic!("Unexpected event!"),
3704 macro_rules! check_spendable_outputs {
3705 ($node: expr, $der_idx: expr) => {
3707 let events = $node.chan_monitor.simple_monitor.get_and_clear_pending_events();
3708 let mut txn = Vec::new();
3709 for event in events {
3711 Event::SpendableOutputs { ref outputs } => {
3712 for outp in outputs {
3714 SpendableOutputDescriptor::DynamicOutputP2WPKH { ref outpoint, ref key, ref output } => {
3716 previous_output: outpoint.clone(),
3717 script_sig: Script::new(),
3719 witness: Vec::new(),
3722 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
3723 value: output.value,
3725 let mut spend_tx = Transaction {
3731 let secp_ctx = Secp256k1::new();
3732 let remotepubkey = PublicKey::from_secret_key(&secp_ctx, &key);
3733 let witness_script = Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: remotepubkey}, Network::Testnet).script_pubkey();
3734 let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
3735 let remotesig = secp_ctx.sign(&sighash, key);
3736 spend_tx.input[0].witness.push(remotesig.serialize_der().to_vec());
3737 spend_tx.input[0].witness[0].push(SigHashType::All as u8);
3738 spend_tx.input[0].witness.push(remotepubkey.serialize().to_vec());
3741 SpendableOutputDescriptor::DynamicOutputP2WSH { ref outpoint, ref key, ref witness_script, ref to_self_delay, ref output } => {
3743 previous_output: outpoint.clone(),
3744 script_sig: Script::new(),
3745 sequence: *to_self_delay as u32,
3746 witness: Vec::new(),
3749 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
3750 value: output.value,
3752 let mut spend_tx = Transaction {
3758 let secp_ctx = Secp256k1::new();
3759 let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], witness_script, output.value)[..]).unwrap();
3760 let local_delaysig = secp_ctx.sign(&sighash, key);
3761 spend_tx.input[0].witness.push(local_delaysig.serialize_der().to_vec());
3762 spend_tx.input[0].witness[0].push(SigHashType::All as u8);
3763 spend_tx.input[0].witness.push(vec!(0));
3764 spend_tx.input[0].witness.push(witness_script.clone().into_bytes());
3767 SpendableOutputDescriptor::StaticOutput { ref outpoint, ref output } => {
3768 let secp_ctx = Secp256k1::new();
3770 previous_output: outpoint.clone(),
3771 script_sig: Script::new(),
3773 witness: Vec::new(),
3776 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
3777 value: output.value,
3779 let mut spend_tx = Transaction {
3783 output: vec![outp.clone()],
3786 match ExtendedPrivKey::new_master(Network::Testnet, &$node.node_seed) {
3788 match master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx($der_idx).expect("key space exhausted")) {
3790 Err(_) => panic!("Your RNG is busted"),
3793 Err(_) => panic!("Your rng is busted"),
3796 let pubkey = ExtendedPubKey::from_private(&secp_ctx, &secret).public_key;
3797 let witness_script = Address::p2pkh(&pubkey, Network::Testnet).script_pubkey();
3798 let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
3799 let sig = secp_ctx.sign(&sighash, &secret.private_key.key);
3800 spend_tx.input[0].witness.push(sig.serialize_der().to_vec());
3801 spend_tx.input[0].witness[0].push(SigHashType::All as u8);
3802 spend_tx.input[0].witness.push(pubkey.key.serialize().to_vec());
3808 _ => panic!("Unexpected event"),
3817 fn test_claim_sizeable_push_msat() {
3818 // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
3819 let node_cfgs = create_node_cfgs(2);
3820 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3821 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3823 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::supported(), InitFeatures::supported());
3824 nodes[1].node.force_close_channel(&chan.2);
3825 check_closed_broadcast!(nodes[1], false);
3826 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3827 assert_eq!(node_txn.len(), 1);
3828 check_spends!(node_txn[0], chan.3.clone());
3829 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
3831 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3832 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
3833 let spend_txn = check_spendable_outputs!(nodes[1], 1);
3834 assert_eq!(spend_txn.len(), 1);
3835 check_spends!(spend_txn[0], node_txn[0].clone());
3839 fn test_claim_on_remote_sizeable_push_msat() {
3840 // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
3841 // to_remote output is encumbered by a P2WPKH
3842 let node_cfgs = create_node_cfgs(2);
3843 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3844 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3846 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::supported(), InitFeatures::supported());
3847 nodes[0].node.force_close_channel(&chan.2);
3848 check_closed_broadcast!(nodes[0], false);
3850 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3851 assert_eq!(node_txn.len(), 1);
3852 check_spends!(node_txn[0], chan.3.clone());
3853 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
3855 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3856 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
3857 check_closed_broadcast!(nodes[1], false);
3858 let spend_txn = check_spendable_outputs!(nodes[1], 1);
3859 assert_eq!(spend_txn.len(), 2);
3860 assert_eq!(spend_txn[0], spend_txn[1]);
3861 check_spends!(spend_txn[0], node_txn[0].clone());
3865 fn test_claim_on_remote_revoked_sizeable_push_msat() {
3866 // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
3867 // to_remote output is encumbered by a P2WPKH
3869 let node_cfgs = create_node_cfgs(2);
3870 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3871 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3873 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::supported(), InitFeatures::supported());
3874 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
3875 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();
3876 assert_eq!(revoked_local_txn[0].input.len(), 1);
3877 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
3879 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
3880 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3881 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3882 check_closed_broadcast!(nodes[1], false);
3884 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3885 let spend_txn = check_spendable_outputs!(nodes[1], 1);
3886 assert_eq!(spend_txn.len(), 4);
3887 assert_eq!(spend_txn[0], spend_txn[2]); // to_remote output on revoked remote commitment_tx
3888 check_spends!(spend_txn[0], revoked_local_txn[0].clone());
3889 assert_eq!(spend_txn[1], spend_txn[3]); // to_local output on local commitment tx
3890 check_spends!(spend_txn[1], node_txn[0].clone());
3894 fn test_static_spendable_outputs_preimage_tx() {
3895 let node_cfgs = create_node_cfgs(2);
3896 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3897 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3899 // Create some initial channels
3900 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3902 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
3904 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();
3905 assert_eq!(commitment_tx[0].input.len(), 1);
3906 assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
3908 // Settle A's commitment tx on B's chain
3909 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3910 assert!(nodes[1].node.claim_funds(payment_preimage, 3_000_000));
3911 check_added_monitors!(nodes[1], 1);
3912 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()] }, 1);
3913 let events = nodes[1].node.get_and_clear_pending_msg_events();
3915 MessageSendEvent::UpdateHTLCs { .. } => {},
3916 _ => panic!("Unexpected event"),
3919 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
3920 _ => panic!("Unexepected event"),
3923 // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
3924 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: 2 (1 preimage tx)
3925 assert_eq!(node_txn.len(), 4);
3926 check_spends!(node_txn[0], commitment_tx[0].clone());
3927 assert_eq!(node_txn[0], node_txn[3]);
3928 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3929 eprintln!("{:?}", node_txn[1]);
3930 check_spends!(node_txn[1], chan_1.3.clone());
3931 check_spends!(node_txn[2], node_txn[1]);
3933 let spend_txn = check_spendable_outputs!(nodes[1], 1); // , 0, 0, 1, 1);
3934 assert_eq!(spend_txn.len(), 2);
3935 assert_eq!(spend_txn[0], spend_txn[1]);
3936 check_spends!(spend_txn[0], node_txn[0].clone());
3940 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
3941 let node_cfgs = create_node_cfgs(2);
3942 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3943 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3945 // Create some initial channels
3946 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3948 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
3949 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();
3950 assert_eq!(revoked_local_txn[0].input.len(), 1);
3951 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
3953 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
3955 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3956 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3957 check_closed_broadcast!(nodes[1], false);
3959 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3960 assert_eq!(node_txn.len(), 3);
3961 assert_eq!(node_txn.pop().unwrap(), node_txn[0]);
3962 assert_eq!(node_txn[0].input.len(), 2);
3963 check_spends!(node_txn[0], revoked_local_txn[0].clone());
3965 let spend_txn = check_spendable_outputs!(nodes[1], 1);
3966 assert_eq!(spend_txn.len(), 2);
3967 assert_eq!(spend_txn[0], spend_txn[1]);
3968 check_spends!(spend_txn[0], node_txn[0].clone());
3972 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
3973 let node_cfgs = create_node_cfgs(2);
3974 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3975 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3977 // Create some initial channels
3978 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3980 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
3981 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();
3982 assert_eq!(revoked_local_txn[0].input.len(), 1);
3983 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
3985 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
3987 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3988 // A will generate HTLC-Timeout from revoked commitment tx
3989 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3990 check_closed_broadcast!(nodes[0], false);
3992 let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3993 assert_eq!(revoked_htlc_txn.len(), 3);
3994 assert_eq!(revoked_htlc_txn[0], revoked_htlc_txn[2]);
3995 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
3996 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3997 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
3998 check_spends!(revoked_htlc_txn[1], chan_1.3.clone());
4000 // B will generate justice tx from A's revoked commitment/HTLC tx
4001 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
4002 check_closed_broadcast!(nodes[1], false);
4004 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4005 assert_eq!(node_txn.len(), 5);
4006 assert_eq!(node_txn[3].input.len(), 1);
4007 check_spends!(node_txn[3], revoked_htlc_txn[0].clone());
4009 // Check B's ChannelMonitor was able to generate the right spendable output descriptor
4010 let spend_txn = check_spendable_outputs!(nodes[1], 1);
4011 assert_eq!(spend_txn.len(), 3);
4012 assert_eq!(spend_txn[0], spend_txn[1]);
4013 check_spends!(spend_txn[0], node_txn[0].clone());
4014 check_spends!(spend_txn[2], node_txn[3].clone());
4018 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
4019 let node_cfgs = create_node_cfgs(2);
4020 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4021 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4023 // Create some initial channels
4024 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4026 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4027 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();
4028 assert_eq!(revoked_local_txn[0].input.len(), 1);
4029 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4031 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4033 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4034 // B will generate HTLC-Success from revoked commitment tx
4035 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4036 check_closed_broadcast!(nodes[1], false);
4037 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4039 assert_eq!(revoked_htlc_txn.len(), 3);
4040 assert_eq!(revoked_htlc_txn[0], revoked_htlc_txn[2]);
4041 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4042 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4043 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
4045 // A will generate justice tx from B's revoked commitment/HTLC tx
4046 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
4047 check_closed_broadcast!(nodes[0], false);
4049 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4050 assert_eq!(node_txn.len(), 4);
4051 assert_eq!(node_txn[3].input.len(), 1);
4052 check_spends!(node_txn[3], revoked_htlc_txn[0].clone());
4054 // Check A's ChannelMonitor was able to generate the right spendable output descriptor
4055 let spend_txn = check_spendable_outputs!(nodes[0], 1);
4056 assert_eq!(spend_txn.len(), 5);
4057 assert_eq!(spend_txn[0], spend_txn[2]);
4058 assert_eq!(spend_txn[1], spend_txn[3]);
4059 check_spends!(spend_txn[0], revoked_local_txn[0].clone()); // spending to_remote output from revoked local tx
4060 check_spends!(spend_txn[1], node_txn[2].clone()); // spending justice tx output from revoked local tx htlc received output
4061 check_spends!(spend_txn[4], node_txn[3].clone()); // spending justice tx output on htlc success tx
4065 fn test_onchain_to_onchain_claim() {
4066 // Test that in case of channel closure, we detect the state of output thanks to
4067 // ChainWatchInterface and claim HTLC on downstream peer's remote commitment tx.
4068 // First, have C claim an HTLC against its own latest commitment transaction.
4069 // Then, broadcast these to B, which should update the monitor downstream on the A<->B
4071 // Finally, check that B will claim the HTLC output if A's latest commitment transaction
4074 let node_cfgs = create_node_cfgs(3);
4075 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4076 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4078 // Create some initial channels
4079 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4080 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
4082 // Rebalance the network a bit by relaying one payment through all the channels ...
4083 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
4084 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
4086 let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
4087 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
4088 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();
4089 check_spends!(commitment_tx[0], chan_2.3.clone());
4090 nodes[2].node.claim_funds(payment_preimage, 3_000_000);
4091 check_added_monitors!(nodes[2], 1);
4092 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
4093 assert!(updates.update_add_htlcs.is_empty());
4094 assert!(updates.update_fail_htlcs.is_empty());
4095 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4096 assert!(updates.update_fail_malformed_htlcs.is_empty());
4098 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
4099 check_closed_broadcast!(nodes[2], false);
4101 let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
4102 assert_eq!(c_txn.len(), 4);
4103 assert_eq!(c_txn[0], c_txn[2]);
4104 assert_eq!(c_txn[0], c_txn[3]);
4105 assert_eq!(commitment_tx[0], c_txn[1]);
4106 check_spends!(c_txn[1], chan_2.3.clone());
4107 check_spends!(c_txn[2], c_txn[1].clone());
4108 assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
4109 assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4110 assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
4111 assert_eq!(c_txn[0].lock_time, 0); // Success tx
4113 // 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
4114 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]}, 1);
4116 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4117 assert_eq!(b_txn.len(), 4);
4118 assert_eq!(b_txn[0], b_txn[3]);
4119 check_spends!(b_txn[1], chan_2.3); // B local commitment tx, issued by ChannelManager
4120 check_spends!(b_txn[2], b_txn[1].clone()); // HTLC-Timeout on B local commitment tx, issued by ChannelManager
4121 assert_eq!(b_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4122 assert!(b_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
4123 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
4124 check_spends!(b_txn[0], c_txn[1].clone()); // timeout tx on C remote commitment tx, issued by ChannelMonitor, * 2 due to block rescan
4125 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4126 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
4127 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
4130 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
4131 check_added_monitors!(nodes[1], 1);
4132 match msg_events[0] {
4133 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4134 _ => panic!("Unexpected event"),
4136 match msg_events[1] {
4137 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, .. } } => {
4138 assert!(update_add_htlcs.is_empty());
4139 assert!(update_fail_htlcs.is_empty());
4140 assert_eq!(update_fulfill_htlcs.len(), 1);
4141 assert!(update_fail_malformed_htlcs.is_empty());
4142 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
4144 _ => panic!("Unexpected event"),
4146 // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
4147 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();
4148 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
4149 let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4150 assert_eq!(b_txn.len(), 4);
4151 check_spends!(b_txn[1], chan_1.3); // Local commitment tx, issued by ChannelManager
4152 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
4153 assert_eq!(b_txn[0], b_txn[3]); // HTLC-Success tx, issued by ChannelMonitor, * 2 due to block rescan
4154 check_spends!(b_txn[0], commitment_tx[0].clone());
4155 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4156 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
4157 assert_eq!(b_txn[2].lock_time, 0); // Success tx
4159 check_closed_broadcast!(nodes[1], false);
4163 fn test_duplicate_payment_hash_one_failure_one_success() {
4164 // Topology : A --> B --> C
4165 // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
4166 let node_cfgs = create_node_cfgs(3);
4167 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4168 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4170 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4171 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
4173 let (our_payment_preimage, duplicate_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
4174 *nodes[0].network_payment_count.borrow_mut() -= 1;
4175 assert_eq!(route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000).1, duplicate_payment_hash);
4177 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();
4178 assert_eq!(commitment_txn[0].input.len(), 1);
4179 check_spends!(commitment_txn[0], chan_2.3.clone());
4181 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4182 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
4183 check_closed_broadcast!(nodes[1], false);
4185 let htlc_timeout_tx;
4186 { // Extract one of the two HTLC-Timeout transaction
4187 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4188 assert_eq!(node_txn.len(), 7);
4189 assert_eq!(node_txn[0], node_txn[5]);
4190 assert_eq!(node_txn[1], node_txn[6]);
4191 check_spends!(node_txn[0], commitment_txn[0].clone());
4192 assert_eq!(node_txn[0].input.len(), 1);
4193 check_spends!(node_txn[1], commitment_txn[0].clone());
4194 assert_eq!(node_txn[1].input.len(), 1);
4195 assert_ne!(node_txn[0].input[0], node_txn[1].input[0]);
4196 check_spends!(node_txn[2], chan_2.3.clone());
4197 check_spends!(node_txn[3], node_txn[2].clone());
4198 check_spends!(node_txn[4], node_txn[2].clone());
4199 htlc_timeout_tx = node_txn[1].clone();
4202 nodes[2].node.claim_funds(our_payment_preimage, 900_000);
4203 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
4204 check_added_monitors!(nodes[2], 2);
4205 let events = nodes[2].node.get_and_clear_pending_msg_events();
4207 MessageSendEvent::UpdateHTLCs { .. } => {},
4208 _ => panic!("Unexpected event"),
4211 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4212 _ => panic!("Unexepected event"),
4214 let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
4215 assert_eq!(htlc_success_txn.len(), 7);
4216 check_spends!(htlc_success_txn[2], chan_2.3.clone());
4217 check_spends!(htlc_success_txn[3], htlc_success_txn[2]);
4218 check_spends!(htlc_success_txn[4], htlc_success_txn[2]);
4219 assert_eq!(htlc_success_txn[0], htlc_success_txn[5]);
4220 assert_eq!(htlc_success_txn[0].input.len(), 1);
4221 assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4222 assert_eq!(htlc_success_txn[1], htlc_success_txn[4]);
4223 assert_eq!(htlc_success_txn[1].input.len(), 1);
4224 assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4225 assert_ne!(htlc_success_txn[0].input[0], htlc_success_txn[1].input[0]);
4226 check_spends!(htlc_success_txn[0], commitment_txn[0].clone());
4227 check_spends!(htlc_success_txn[1], commitment_txn[0].clone());
4229 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![htlc_timeout_tx] }, 200);
4230 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
4231 expect_pending_htlcs_forwardable!(nodes[1]);
4232 let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4233 assert!(htlc_updates.update_add_htlcs.is_empty());
4234 assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
4235 assert_eq!(htlc_updates.update_fail_htlcs[0].htlc_id, 1);
4236 assert!(htlc_updates.update_fulfill_htlcs.is_empty());
4237 assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
4238 check_added_monitors!(nodes[1], 1);
4240 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
4241 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4243 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
4244 let events = nodes[0].node.get_and_clear_pending_msg_events();
4245 assert_eq!(events.len(), 1);
4247 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. } } => {
4249 _ => { panic!("Unexpected event"); }
4252 let events = nodes[0].node.get_and_clear_pending_events();
4254 Event::PaymentFailed { ref payment_hash, .. } => {
4255 assert_eq!(*payment_hash, duplicate_payment_hash);
4257 _ => panic!("Unexpected event"),
4260 // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
4261 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![htlc_success_txn[0].clone()] }, 200);
4262 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4263 assert!(updates.update_add_htlcs.is_empty());
4264 assert!(updates.update_fail_htlcs.is_empty());
4265 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4266 assert_eq!(updates.update_fulfill_htlcs[0].htlc_id, 0);
4267 assert!(updates.update_fail_malformed_htlcs.is_empty());
4268 check_added_monitors!(nodes[1], 1);
4270 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
4271 commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
4273 let events = nodes[0].node.get_and_clear_pending_events();
4275 Event::PaymentSent { ref payment_preimage } => {
4276 assert_eq!(*payment_preimage, our_payment_preimage);
4278 _ => panic!("Unexpected event"),
4283 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
4284 let node_cfgs = create_node_cfgs(2);
4285 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4286 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4288 // Create some initial channels
4289 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4291 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
4292 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();
4293 assert_eq!(local_txn[0].input.len(), 1);
4294 check_spends!(local_txn[0], chan_1.3.clone());
4296 // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
4297 nodes[1].node.claim_funds(payment_preimage, 9_000_000);
4298 check_added_monitors!(nodes[1], 1);
4299 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4300 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![local_txn[0].clone()] }, 1);
4301 let events = nodes[1].node.get_and_clear_pending_msg_events();
4303 MessageSendEvent::UpdateHTLCs { .. } => {},
4304 _ => panic!("Unexpected event"),
4307 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4308 _ => panic!("Unexepected event"),
4310 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4311 assert_eq!(node_txn[0].input.len(), 1);
4312 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4313 check_spends!(node_txn[0], local_txn[0].clone());
4315 // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
4316 let spend_txn = check_spendable_outputs!(nodes[1], 1);
4317 assert_eq!(spend_txn.len(), 2);
4318 check_spends!(spend_txn[0], node_txn[0].clone());
4319 check_spends!(spend_txn[1], node_txn[2].clone());
4322 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
4323 // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
4324 // unrevoked commitment transaction.
4325 // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
4326 // a remote RAA before they could be failed backwards (and combinations thereof).
4327 // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
4328 // use the same payment hashes.
4329 // Thus, we use a six-node network:
4334 // And test where C fails back to A/B when D announces its latest commitment transaction
4335 let node_cfgs = create_node_cfgs(6);
4336 let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
4337 let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
4339 create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::supported(), InitFeatures::supported());
4340 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
4341 let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
4342 create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::supported(), InitFeatures::supported());
4343 create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::supported(), InitFeatures::supported());
4345 // Rebalance and check output sanity...
4346 send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000, 500_000);
4347 send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000, 500_000);
4348 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);
4350 let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
4352 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
4354 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
4355 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();
4357 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
4359 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
4361 let (_, payment_hash_3) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4363 let (_, payment_hash_4) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4364 let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4366 send_along_route_with_hash(&nodes[1], route.clone(), &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_3);
4368 send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_4);
4371 let (_, payment_hash_5) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4373 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();
4374 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
4377 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
4379 let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4380 send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_6);
4382 // Double-check that six of the new HTLC were added
4383 // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
4384 // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
4385 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);
4386 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);
4388 // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
4389 // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
4390 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1));
4391 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3));
4392 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5));
4393 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6));
4394 check_added_monitors!(nodes[4], 0);
4395 expect_pending_htlcs_forwardable!(nodes[4]);
4396 check_added_monitors!(nodes[4], 1);
4398 let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
4399 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
4400 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
4401 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
4402 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
4403 commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
4405 // Fail 3rd below-dust and 7th above-dust HTLCs
4406 assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2));
4407 assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4));
4408 check_added_monitors!(nodes[5], 0);
4409 expect_pending_htlcs_forwardable!(nodes[5]);
4410 check_added_monitors!(nodes[5], 1);
4412 let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
4413 nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
4414 nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
4415 commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
4417 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();
4419 expect_pending_htlcs_forwardable!(nodes[3]);
4420 check_added_monitors!(nodes[3], 1);
4421 let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
4422 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
4423 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
4424 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
4425 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
4426 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
4427 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
4428 if deliver_last_raa {
4429 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
4431 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
4434 // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
4435 // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
4436 // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
4437 // propagated back to A/B yet (and D has two unrevoked commitment transactions).
4439 // We now broadcast the latest commitment transaction, which *should* result in failures for
4440 // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
4441 // the non-broadcast above-dust HTLCs.
4443 // Alternatively, we may broadcast the previous commitment transaction, which should only
4444 // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
4445 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();
4447 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4448 if announce_latest {
4449 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![ds_last_commitment_tx[0].clone()]}, 1);
4451 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![ds_prev_commitment_tx[0].clone()]}, 1);
4453 connect_blocks(&nodes[2].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4454 check_closed_broadcast!(nodes[2], false);
4455 expect_pending_htlcs_forwardable!(nodes[2]);
4456 check_added_monitors!(nodes[2], 2);
4458 let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
4459 assert_eq!(cs_msgs.len(), 2);
4460 let mut a_done = false;
4461 for msg in cs_msgs {
4463 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
4464 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
4465 // should be failed-backwards here.
4466 let target = if *node_id == nodes[0].node.get_our_node_id() {
4467 // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
4468 for htlc in &updates.update_fail_htlcs {
4469 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 });
4471 assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
4476 // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
4477 for htlc in &updates.update_fail_htlcs {
4478 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
4480 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
4481 assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
4484 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
4485 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
4486 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
4487 if announce_latest {
4488 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
4489 if *node_id == nodes[0].node.get_our_node_id() {
4490 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
4493 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
4495 _ => panic!("Unexpected event"),
4499 let as_events = nodes[0].node.get_and_clear_pending_events();
4500 assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
4501 let mut as_failds = HashSet::new();
4502 for event in as_events.iter() {
4503 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
4504 assert!(as_failds.insert(*payment_hash));
4505 if *payment_hash != payment_hash_2 {
4506 assert_eq!(*rejected_by_dest, deliver_last_raa);
4508 assert!(!rejected_by_dest);
4510 } else { panic!("Unexpected event"); }
4512 assert!(as_failds.contains(&payment_hash_1));
4513 assert!(as_failds.contains(&payment_hash_2));
4514 if announce_latest {
4515 assert!(as_failds.contains(&payment_hash_3));
4516 assert!(as_failds.contains(&payment_hash_5));
4518 assert!(as_failds.contains(&payment_hash_6));
4520 let bs_events = nodes[1].node.get_and_clear_pending_events();
4521 assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
4522 let mut bs_failds = HashSet::new();
4523 for event in bs_events.iter() {
4524 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
4525 assert!(bs_failds.insert(*payment_hash));
4526 if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
4527 assert_eq!(*rejected_by_dest, deliver_last_raa);
4529 assert!(!rejected_by_dest);
4531 } else { panic!("Unexpected event"); }
4533 assert!(bs_failds.contains(&payment_hash_1));
4534 assert!(bs_failds.contains(&payment_hash_2));
4535 if announce_latest {
4536 assert!(bs_failds.contains(&payment_hash_4));
4538 assert!(bs_failds.contains(&payment_hash_5));
4540 // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
4541 // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
4542 // to unknown-preimage-etc, B should have gotten 2. Thus, in the
4543 // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
4544 // PaymentFailureNetworkUpdates.
4545 let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4546 assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
4547 let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
4548 assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
4549 for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
4551 &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
4552 _ => panic!("Unexpected event"),
4558 fn test_fail_backwards_latest_remote_announce_a() {
4559 do_test_fail_backwards_unrevoked_remote_announce(false, true);
4563 fn test_fail_backwards_latest_remote_announce_b() {
4564 do_test_fail_backwards_unrevoked_remote_announce(true, true);
4568 fn test_fail_backwards_previous_remote_announce() {
4569 do_test_fail_backwards_unrevoked_remote_announce(false, false);
4570 // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
4571 // tested for in test_commitment_revoked_fail_backward_exhaustive()
4575 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
4576 let node_cfgs = create_node_cfgs(2);
4577 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4578 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4580 // Create some initial channels
4581 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4583 route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
4584 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();
4585 assert_eq!(local_txn[0].input.len(), 1);
4586 check_spends!(local_txn[0], chan_1.3.clone());
4588 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
4589 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4590 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![local_txn[0].clone()] }, 200);
4591 check_closed_broadcast!(nodes[0], false);
4593 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4594 assert_eq!(node_txn[0].input.len(), 1);
4595 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4596 check_spends!(node_txn[0], local_txn[0].clone());
4598 // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
4599 let spend_txn = check_spendable_outputs!(nodes[0], 1);
4600 assert_eq!(spend_txn.len(), 8);
4601 assert_eq!(spend_txn[0], spend_txn[2]);
4602 assert_eq!(spend_txn[0], spend_txn[4]);
4603 assert_eq!(spend_txn[0], spend_txn[6]);
4604 assert_eq!(spend_txn[1], spend_txn[3]);
4605 assert_eq!(spend_txn[1], spend_txn[5]);
4606 assert_eq!(spend_txn[1], spend_txn[7]);
4607 check_spends!(spend_txn[0], local_txn[0].clone());
4608 check_spends!(spend_txn[1], node_txn[0].clone());
4612 fn test_static_output_closing_tx() {
4613 let node_cfgs = create_node_cfgs(2);
4614 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4615 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4617 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4619 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
4620 let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
4622 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4623 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![closing_tx.clone()] }, 1);
4624 let spend_txn = check_spendable_outputs!(nodes[0], 2);
4625 assert_eq!(spend_txn.len(), 1);
4626 check_spends!(spend_txn[0], closing_tx.clone());
4628 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![closing_tx.clone()] }, 1);
4629 let spend_txn = check_spendable_outputs!(nodes[1], 2);
4630 assert_eq!(spend_txn.len(), 1);
4631 check_spends!(spend_txn[0], closing_tx);
4634 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
4635 let node_cfgs = create_node_cfgs(2);
4636 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4637 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4638 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4640 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
4642 // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
4643 // present in B's local commitment transaction, but none of A's commitment transactions.
4644 assert!(nodes[1].node.claim_funds(our_payment_preimage, if use_dust { 50_000 } else { 3_000_000 }));
4645 check_added_monitors!(nodes[1], 1);
4647 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4648 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
4649 let events = nodes[0].node.get_and_clear_pending_events();
4650 assert_eq!(events.len(), 1);
4652 Event::PaymentSent { payment_preimage } => {
4653 assert_eq!(payment_preimage, our_payment_preimage);
4655 _ => panic!("Unexpected event"),
4658 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
4659 check_added_monitors!(nodes[0], 1);
4660 let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4661 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
4662 check_added_monitors!(nodes[1], 1);
4664 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4665 for i in 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + CHAN_CONFIRM_DEPTH + 1 {
4666 nodes[1].block_notifier.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
4667 header.prev_blockhash = header.bitcoin_hash();
4669 test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
4670 check_closed_broadcast!(nodes[1], false);
4673 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
4674 let node_cfgs = create_node_cfgs(2);
4675 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4676 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4677 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4679 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();
4680 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
4681 nodes[0].node.send_payment(route, payment_hash).unwrap();
4682 check_added_monitors!(nodes[0], 1);
4684 let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4686 // As far as A is concerned, the HTLC is now present only in the latest remote commitment
4687 // transaction, however it is not in A's latest local commitment, so we can just broadcast that
4688 // to "time out" the HTLC.
4690 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4692 for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
4693 nodes[0].block_notifier.block_connected(&Block { header, txdata: Vec::new()}, i);
4694 header.prev_blockhash = header.bitcoin_hash();
4696 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
4697 check_closed_broadcast!(nodes[0], false);
4700 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
4701 let node_cfgs = create_node_cfgs(3);
4702 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4703 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4704 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4706 // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
4707 // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
4708 // Also optionally test that we *don't* fail the channel in case the commitment transaction was
4709 // actually revoked.
4710 let htlc_value = if use_dust { 50000 } else { 3000000 };
4711 let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
4712 assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash));
4713 expect_pending_htlcs_forwardable!(nodes[1]);
4714 check_added_monitors!(nodes[1], 1);
4716 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4717 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
4718 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
4719 check_added_monitors!(nodes[0], 1);
4720 let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4721 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
4722 check_added_monitors!(nodes[1], 1);
4723 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
4724 check_added_monitors!(nodes[1], 1);
4725 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4727 if check_revoke_no_close {
4728 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
4729 check_added_monitors!(nodes[0], 1);
4732 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4733 for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
4734 nodes[0].block_notifier.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
4735 header.prev_blockhash = header.bitcoin_hash();
4737 if !check_revoke_no_close {
4738 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
4739 check_closed_broadcast!(nodes[0], false);
4741 let events = nodes[0].node.get_and_clear_pending_events();
4742 assert_eq!(events.len(), 1);
4744 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
4745 assert_eq!(payment_hash, our_payment_hash);
4746 assert!(rejected_by_dest);
4748 _ => panic!("Unexpected event"),
4753 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
4754 // There are only a few cases to test here:
4755 // * its not really normative behavior, but we test that below-dust HTLCs "included" in
4756 // broadcastable commitment transactions result in channel closure,
4757 // * its included in an unrevoked-but-previous remote commitment transaction,
4758 // * its included in the latest remote or local commitment transactions.
4759 // We test each of the three possible commitment transactions individually and use both dust and
4761 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
4762 // assume they are handled the same across all six cases, as both outbound and inbound failures are
4763 // tested for at least one of the cases in other tests.
4765 fn htlc_claim_single_commitment_only_a() {
4766 do_htlc_claim_local_commitment_only(true);
4767 do_htlc_claim_local_commitment_only(false);
4769 do_htlc_claim_current_remote_commitment_only(true);
4770 do_htlc_claim_current_remote_commitment_only(false);
4774 fn htlc_claim_single_commitment_only_b() {
4775 do_htlc_claim_previous_remote_commitment_only(true, false);
4776 do_htlc_claim_previous_remote_commitment_only(false, false);
4777 do_htlc_claim_previous_remote_commitment_only(true, true);
4778 do_htlc_claim_previous_remote_commitment_only(false, true);
4781 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>)
4782 where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
4785 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);
4789 // 0: node1 fails backward
4790 // 1: final node fails backward
4791 // 2: payment completed but the user rejects the payment
4792 // 3: final node fails backward (but tamper onion payloads from node0)
4793 // 100: trigger error in the intermediate node and tamper returning fail_htlc
4794 // 200: trigger error in the final node and tamper returning fail_htlc
4795 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>)
4796 where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
4797 F2: for <'a> FnMut(&'a mut msgs::UpdateFailHTLC),
4801 // reset block height
4802 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4803 for ix in 0..nodes.len() {
4804 nodes[ix].block_notifier.block_connected_checked(&header, 1, &[], &[]);
4807 macro_rules! expect_event {
4808 ($node: expr, $event_type: path) => {{
4809 let events = $node.node.get_and_clear_pending_events();
4810 assert_eq!(events.len(), 1);
4812 $event_type { .. } => {},
4813 _ => panic!("Unexpected event"),
4818 macro_rules! expect_htlc_forward {
4820 expect_event!($node, Event::PendingHTLCsForwardable);
4821 $node.node.process_pending_htlc_forwards();
4825 // 0 ~~> 2 send payment
4826 nodes[0].node.send_payment(route.clone(), payment_hash.clone()).unwrap();
4827 check_added_monitors!(nodes[0], 1);
4828 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4829 // temper update_add (0 => 1)
4830 let mut update_add_0 = update_0.update_add_htlcs[0].clone();
4831 if test_case == 0 || test_case == 3 || test_case == 100 {
4832 callback_msg(&mut update_add_0);
4835 // 0 => 1 update_add & CS
4836 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0);
4837 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
4839 let update_1_0 = match test_case {
4840 0|100 => { // intermediate node failure; fail backward to 0
4841 let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4842 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));
4845 1|2|3|200 => { // final node failure; forwarding to 2
4846 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4848 if test_case != 200 {
4851 expect_htlc_forward!(&nodes[1]);
4853 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
4854 check_added_monitors!(&nodes[1], 1);
4855 assert_eq!(update_1.update_add_htlcs.len(), 1);
4856 // tamper update_add (1 => 2)
4857 let mut update_add_1 = update_1.update_add_htlcs[0].clone();
4858 if test_case != 3 && test_case != 200 {
4859 callback_msg(&mut update_add_1);
4863 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1);
4864 commitment_signed_dance!(nodes[2], nodes[1], update_1.commitment_signed, false, true);
4866 if test_case == 2 || test_case == 200 {
4867 expect_htlc_forward!(&nodes[2]);
4868 expect_event!(&nodes[2], Event::PaymentReceived);
4870 expect_pending_htlcs_forwardable!(nodes[2]);
4873 let update_2_1 = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
4874 if test_case == 2 || test_case == 200 {
4875 check_added_monitors!(&nodes[2], 1);
4877 assert!(update_2_1.update_fail_htlcs.len() == 1);
4879 let mut fail_msg = update_2_1.update_fail_htlcs[0].clone();
4880 if test_case == 200 {
4881 callback_fail(&mut fail_msg);
4885 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &fail_msg);
4886 commitment_signed_dance!(nodes[1], nodes[2], update_2_1.commitment_signed, true);
4888 // backward fail on 1
4889 let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4890 assert!(update_1_0.update_fail_htlcs.len() == 1);
4893 _ => unreachable!(),
4896 // 1 => 0 commitment_signed_dance
4897 if update_1_0.update_fail_htlcs.len() > 0 {
4898 let mut fail_msg = update_1_0.update_fail_htlcs[0].clone();
4899 if test_case == 100 {
4900 callback_fail(&mut fail_msg);
4902 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
4904 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_1_0.update_fail_malformed_htlcs[0]);
4907 commitment_signed_dance!(nodes[0], nodes[1], update_1_0.commitment_signed, false, true);
4909 let events = nodes[0].node.get_and_clear_pending_events();
4910 assert_eq!(events.len(), 1);
4911 if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code } = &events[0] {
4912 assert_eq!(*rejected_by_dest, !expected_retryable);
4913 assert_eq!(*error_code, expected_error_code);
4915 panic!("Uexpected event");
4918 let events = nodes[0].node.get_and_clear_pending_msg_events();
4919 if expected_channel_update.is_some() {
4920 assert_eq!(events.len(), 1);
4922 MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
4924 &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {
4925 if let HTLCFailChannelUpdate::ChannelUpdateMessage { .. } = expected_channel_update.unwrap() {} else {
4926 panic!("channel_update not found!");
4929 &HTLCFailChannelUpdate::ChannelClosed { ref short_channel_id, ref is_permanent } => {
4930 if let HTLCFailChannelUpdate::ChannelClosed { short_channel_id: ref expected_short_channel_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
4931 assert!(*short_channel_id == *expected_short_channel_id);
4932 assert!(*is_permanent == *expected_is_permanent);
4934 panic!("Unexpected message event");
4937 &HTLCFailChannelUpdate::NodeFailure { ref node_id, ref is_permanent } => {
4938 if let HTLCFailChannelUpdate::NodeFailure { node_id: ref expected_node_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
4939 assert!(*node_id == *expected_node_id);
4940 assert!(*is_permanent == *expected_is_permanent);
4942 panic!("Unexpected message event");
4947 _ => panic!("Unexpected message event"),
4950 assert_eq!(events.len(), 0);
4954 impl msgs::ChannelUpdate {
4955 fn dummy() -> msgs::ChannelUpdate {
4956 use secp256k1::ffi::Signature as FFISignature;
4957 use secp256k1::Signature;
4958 msgs::ChannelUpdate {
4959 signature: Signature::from(FFISignature::new()),
4960 contents: msgs::UnsignedChannelUpdate {
4961 chain_hash: Sha256dHash::hash(&vec![0u8][..]),
4962 short_channel_id: 0,
4965 cltv_expiry_delta: 0,
4966 htlc_minimum_msat: 0,
4968 fee_proportional_millionths: 0,
4969 excess_data: vec![],
4975 struct BogusOnionHopData {
4978 impl BogusOnionHopData {
4979 fn new(orig: msgs::OnionHopData) -> Self {
4980 Self { data: orig.encode() }
4983 impl Writeable for BogusOnionHopData {
4984 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
4985 writer.write_all(&self.data[..])
4990 fn test_onion_failure() {
4991 use ln::msgs::ChannelUpdate;
4992 use ln::channelmanager::CLTV_FAR_FAR_AWAY;
4995 const BADONION: u16 = 0x8000;
4996 const PERM: u16 = 0x4000;
4997 const NODE: u16 = 0x2000;
4998 const UPDATE: u16 = 0x1000;
5000 let node_cfgs = create_node_cfgs(3);
5001 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5002 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5003 for node in nodes.iter() {
5004 *node.keys_manager.override_session_priv.lock().unwrap() = Some(SecretKey::from_slice(&[3; 32]).unwrap());
5006 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())];
5007 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
5008 let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV).unwrap();
5010 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 40000, 40_000);
5012 // intermediate node failure
5013 run_onion_failure_test("invalid_realm", 0, &nodes, &route, &payment_hash, |msg| {
5014 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5015 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5016 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5017 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
5018 let mut new_payloads = Vec::new();
5019 for payload in onion_payloads.drain(..) {
5020 new_payloads.push(BogusOnionHopData::new(payload));
5022 new_payloads[0].data[0] = 1;
5023 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
5024 }, ||{}, 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
5026 // final node failure
5027 run_onion_failure_test("invalid_realm", 3, &nodes, &route, &payment_hash, |msg| {
5028 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5029 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5030 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5031 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
5032 let mut new_payloads = Vec::new();
5033 for payload in onion_payloads.drain(..) {
5034 new_payloads.push(BogusOnionHopData::new(payload));
5036 new_payloads[1].data[0] = 1;
5037 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
5038 }, ||{}, false, Some(PERM|1), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
5040 // the following three with run_onion_failure_test_with_fail_intercept() test only the origin node
5041 // receiving simulated fail messages
5042 // intermediate node failure
5043 run_onion_failure_test_with_fail_intercept("temporary_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
5045 msg.amount_msat -= 1;
5047 // and tamper returning error message
5048 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5049 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5050 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], NODE|2, &[0;0]);
5051 }, ||{}, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: false}));
5053 // final node failure
5054 run_onion_failure_test_with_fail_intercept("temporary_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
5055 // and tamper returning error message
5056 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5057 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5058 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], NODE|2, &[0;0]);
5060 nodes[2].node.fail_htlc_backwards(&payment_hash);
5061 }, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: false}));
5063 // intermediate node failure
5064 run_onion_failure_test_with_fail_intercept("permanent_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
5065 msg.amount_msat -= 1;
5067 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5068 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5069 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|2, &[0;0]);
5070 }, ||{}, true, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: true}));
5072 // final node failure
5073 run_onion_failure_test_with_fail_intercept("permanent_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
5074 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5075 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5076 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|2, &[0;0]);
5078 nodes[2].node.fail_htlc_backwards(&payment_hash);
5079 }, false, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: true}));
5081 // intermediate node failure
5082 run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
5083 msg.amount_msat -= 1;
5085 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5086 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5087 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|3, &[0;0]);
5089 nodes[2].node.fail_htlc_backwards(&payment_hash);
5090 }, true, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: true}));
5092 // final node failure
5093 run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
5094 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5095 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5096 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|3, &[0;0]);
5098 nodes[2].node.fail_htlc_backwards(&payment_hash);
5099 }, false, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: true}));
5101 run_onion_failure_test("invalid_onion_version", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.version = 1; }, ||{}, true,
5102 Some(BADONION|PERM|4), None);
5104 run_onion_failure_test("invalid_onion_hmac", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.hmac = [3; 32]; }, ||{}, true,
5105 Some(BADONION|PERM|5), None);
5107 run_onion_failure_test("invalid_onion_key", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.public_key = Err(secp256k1::Error::InvalidPublicKey);}, ||{}, true,
5108 Some(BADONION|PERM|6), None);
5110 run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
5111 msg.amount_msat -= 1;
5113 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5114 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5115 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], UPDATE|7, &ChannelUpdate::dummy().encode_with_len()[..]);
5116 }, ||{}, true, Some(UPDATE|7), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5118 run_onion_failure_test_with_fail_intercept("permanent_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
5119 msg.amount_msat -= 1;
5121 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5122 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5123 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|8, &[0;0]);
5124 // short_channel_id from the processing node
5125 }, ||{}, true, Some(PERM|8), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
5127 run_onion_failure_test_with_fail_intercept("required_channel_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
5128 msg.amount_msat -= 1;
5130 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5131 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5132 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|9, &[0;0]);
5133 // short_channel_id from the processing node
5134 }, ||{}, true, Some(PERM|9), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
5136 let mut bogus_route = route.clone();
5137 bogus_route.hops[1].short_channel_id -= 1;
5138 run_onion_failure_test("unknown_next_peer", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(PERM|10),
5139 Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: bogus_route.hops[1].short_channel_id, is_permanent:true}));
5141 let amt_to_forward = nodes[1].node.channel_state.lock().unwrap().by_id.get(&channels[1].2).unwrap().get_their_htlc_minimum_msat() - 1;
5142 let mut bogus_route = route.clone();
5143 let route_len = bogus_route.hops.len();
5144 bogus_route.hops[route_len-1].fee_msat = amt_to_forward;
5145 run_onion_failure_test("amount_below_minimum", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(UPDATE|11), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5147 //TODO: with new config API, we will be able to generate both valid and
5148 //invalid channel_update cases.
5149 run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, |msg| {
5150 msg.amount_msat -= 1;
5151 }, || {}, true, Some(UPDATE|12), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
5153 run_onion_failure_test("incorrect_cltv_expiry", 0, &nodes, &route, &payment_hash, |msg| {
5154 // need to violate: cltv_expiry - cltv_expiry_delta >= outgoing_cltv_value
5155 msg.cltv_expiry -= 1;
5156 }, || {}, true, Some(UPDATE|13), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
5158 run_onion_failure_test("expiry_too_soon", 0, &nodes, &route, &payment_hash, |msg| {
5159 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
5160 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5162 nodes[1].block_notifier.block_connected_checked(&header, height, &[], &[]);
5163 }, ||{}, true, Some(UPDATE|14), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5165 run_onion_failure_test("unknown_payment_hash", 2, &nodes, &route, &payment_hash, |_| {}, || {
5166 nodes[2].node.fail_htlc_backwards(&payment_hash);
5167 }, false, Some(PERM|15), None);
5169 run_onion_failure_test("final_expiry_too_soon", 1, &nodes, &route, &payment_hash, |msg| {
5170 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
5171 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5173 nodes[2].block_notifier.block_connected_checked(&header, height, &[], &[]);
5174 }, || {}, true, Some(17), None);
5176 run_onion_failure_test("final_incorrect_cltv_expiry", 1, &nodes, &route, &payment_hash, |_| {}, || {
5177 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
5178 for f in pending_forwards.iter_mut() {
5180 &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
5181 forward_info.outgoing_cltv_value += 1,
5186 }, true, Some(18), None);
5188 run_onion_failure_test("final_incorrect_htlc_amount", 1, &nodes, &route, &payment_hash, |_| {}, || {
5189 // violate amt_to_forward > msg.amount_msat
5190 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
5191 for f in pending_forwards.iter_mut() {
5193 &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
5194 forward_info.amt_to_forward -= 1,
5199 }, true, Some(19), None);
5201 run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, |_| {}, || {
5202 // disconnect event to the channel between nodes[1] ~ nodes[2]
5203 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
5204 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5205 }, true, Some(UPDATE|20), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5206 reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
5208 run_onion_failure_test("expiry_too_far", 0, &nodes, &route, &payment_hash, |msg| {
5209 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5210 let mut route = route.clone();
5212 route.hops[1].cltv_expiry_delta += CLTV_FAR_FAR_AWAY + route.hops[0].cltv_expiry_delta + 1;
5213 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5214 let (onion_payloads, _, htlc_cltv) = onion_utils::build_onion_payloads(&route, height).unwrap();
5215 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
5216 msg.cltv_expiry = htlc_cltv;
5217 msg.onion_routing_packet = onion_packet;
5218 }, ||{}, true, Some(21), None);
5223 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
5224 let node_cfgs = create_node_cfgs(2);
5225 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5226 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5227 //Force duplicate channel ids
5228 for node in nodes.iter() {
5229 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
5232 // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
5233 let channel_value_satoshis=10000;
5234 let push_msat=10001;
5235 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).unwrap();
5236 let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5237 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::supported(), &node0_to_1_send_open_channel);
5239 //Create a second channel with a channel_id collision
5240 assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).is_err());
5244 fn bolt2_open_channel_sending_node_checks_part2() {
5245 let node_cfgs = create_node_cfgs(2);
5246 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5247 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5249 // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
5250 let channel_value_satoshis=2^24;
5251 let push_msat=10001;
5252 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).is_err());
5254 // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
5255 let channel_value_satoshis=10000;
5256 // Test when push_msat is equal to 1000 * funding_satoshis.
5257 let push_msat=1000*channel_value_satoshis+1;
5258 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).is_err());
5260 // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
5261 let channel_value_satoshis=10000;
5262 let push_msat=10001;
5263 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
5264 let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5265 assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
5267 // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
5268 // 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
5269 assert!(node0_to_1_send_open_channel.channel_flags<=1);
5271 // 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.
5272 assert!(BREAKDOWN_TIMEOUT>0);
5273 assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
5275 // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
5276 let chain_hash=genesis_block(Network::Testnet).header.bitcoin_hash();
5277 assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
5279 // 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.
5280 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
5281 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
5282 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
5283 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_basepoint.serialize()).is_ok());
5284 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
5287 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
5288 // 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.
5289 //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.
5292 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
5293 //BOLT2 Requirement: MUST offer amount_msat greater than 0.
5294 //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
5295 let node_cfgs = create_node_cfgs(2);
5296 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5297 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5298 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5299 let mut route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5300 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5302 route.hops[0].fee_msat = 0;
5304 let err = nodes[0].node.send_payment(route, our_payment_hash);
5306 if let Err(APIError::ChannelUnavailable{err}) = err {
5307 assert_eq!(err, "Cannot send less than their minimum HTLC value");
5311 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5312 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
5316 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
5317 //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
5318 //It is enforced when constructing a route.
5319 let node_cfgs = create_node_cfgs(2);
5320 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5321 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5322 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 0, InitFeatures::supported(), InitFeatures::supported());
5323 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000000, 500000001).unwrap();
5324 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5326 let err = nodes[0].node.send_payment(route, our_payment_hash);
5328 if let Err(APIError::RouteError{err}) = err {
5329 assert_eq!(err, "Channel CLTV overflowed?!");
5336 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
5337 //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.
5338 //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
5339 //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
5340 let node_cfgs = create_node_cfgs(2);
5341 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5342 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5343 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::supported(), InitFeatures::supported());
5344 let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().their_max_accepted_htlcs as u64;
5346 for i in 0..max_accepted_htlcs {
5347 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5348 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5349 let payment_event = {
5350 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5351 check_added_monitors!(nodes[0], 1);
5353 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5354 assert_eq!(events.len(), 1);
5355 if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
5356 assert_eq!(htlcs[0].htlc_id, i);
5360 SendEvent::from_event(events.remove(0))
5362 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
5363 check_added_monitors!(nodes[1], 0);
5364 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
5366 expect_pending_htlcs_forwardable!(nodes[1]);
5367 expect_payment_received!(nodes[1], our_payment_hash, 100000);
5369 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5370 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5371 let err = nodes[0].node.send_payment(route, our_payment_hash);
5373 if let Err(APIError::ChannelUnavailable{err}) = err {
5374 assert_eq!(err, "Cannot push more than their max accepted HTLCs");
5378 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5379 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
5383 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
5384 //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.
5385 let node_cfgs = create_node_cfgs(2);
5386 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5387 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5388 let channel_value = 100000;
5389 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::supported(), InitFeatures::supported());
5390 let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).their_max_htlc_value_in_flight_msat;
5392 send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight, max_in_flight);
5394 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], max_in_flight+1, TEST_FINAL_CLTV).unwrap();
5395 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5396 let err = nodes[0].node.send_payment(route, our_payment_hash);
5398 if let Err(APIError::ChannelUnavailable{err}) = err {
5399 assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight our peer will accept");
5403 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5404 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);
5406 send_payment(&nodes[0], &[&nodes[1]], max_in_flight, max_in_flight);
5409 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
5411 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
5412 //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
5413 let node_cfgs = create_node_cfgs(2);
5414 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5415 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5416 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5417 let htlc_minimum_msat: u64;
5419 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
5420 let channel = chan_lock.by_id.get(&chan.2).unwrap();
5421 htlc_minimum_msat = channel.get_our_htlc_minimum_msat();
5423 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], htlc_minimum_msat, TEST_FINAL_CLTV).unwrap();
5424 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5425 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5426 check_added_monitors!(nodes[0], 1);
5427 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5428 updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
5429 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5430 assert!(nodes[1].node.list_channels().is_empty());
5431 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5432 assert_eq!(err_msg.data, "Remote side tried to send less than our minimum HTLC value");
5436 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
5437 //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
5438 let node_cfgs = create_node_cfgs(2);
5439 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5440 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5441 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5443 let their_channel_reserve = get_channel_value_stat!(nodes[0], chan.2).channel_reserve_msat;
5445 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 5000000-their_channel_reserve, TEST_FINAL_CLTV).unwrap();
5446 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5447 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5448 check_added_monitors!(nodes[0], 1);
5449 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5451 updates.update_add_htlcs[0].amount_msat = 5000000-their_channel_reserve+1;
5452 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5454 assert!(nodes[1].node.list_channels().is_empty());
5455 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5456 assert_eq!(err_msg.data, "Remote HTLC add would put them over their reserve value");
5460 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
5461 //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
5462 //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
5463 let node_cfgs = create_node_cfgs(2);
5464 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5465 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5466 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5467 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 3999999, TEST_FINAL_CLTV).unwrap();
5468 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5470 let session_priv = SecretKey::from_slice(&{
5471 let mut session_key = [0; 32];
5472 let mut rng = thread_rng();
5473 rng.fill_bytes(&mut session_key);
5475 }).expect("RNG is bad!");
5477 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5478 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route, &session_priv).unwrap();
5479 let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
5480 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
5482 let mut msg = msgs::UpdateAddHTLC {
5486 payment_hash: our_payment_hash,
5487 cltv_expiry: htlc_cltv,
5488 onion_routing_packet: onion_packet.clone(),
5491 for i in 0..super::channel::OUR_MAX_HTLCS {
5492 msg.htlc_id = i as u64;
5493 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
5495 msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
5496 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
5498 assert!(nodes[1].node.list_channels().is_empty());
5499 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5500 assert_eq!(err_msg.data, "Remote tried to push more than our max accepted HTLCs");
5504 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
5505 //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
5506 let node_cfgs = create_node_cfgs(2);
5507 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5508 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5509 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
5510 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5511 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5512 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5513 check_added_monitors!(nodes[0], 1);
5514 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5515 updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).their_max_htlc_value_in_flight_msat + 1;
5516 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5518 assert!(nodes[1].node.list_channels().is_empty());
5519 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5520 assert_eq!(err_msg.data,"Remote HTLC add would put them over our max HTLC value");
5524 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
5525 //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
5526 let node_cfgs = create_node_cfgs(2);
5527 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5528 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5529 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5530 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 3999999, TEST_FINAL_CLTV).unwrap();
5531 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5532 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5533 check_added_monitors!(nodes[0], 1);
5534 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5535 updates.update_add_htlcs[0].cltv_expiry = 500000000;
5536 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5538 assert!(nodes[1].node.list_channels().is_empty());
5539 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5540 assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
5544 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
5545 //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
5546 // We test this by first testing that that repeated HTLCs pass commitment signature checks
5547 // after disconnect and that non-sequential htlc_ids result in a channel failure.
5548 let node_cfgs = create_node_cfgs(2);
5549 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5550 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5551 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5552 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5553 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5554 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5555 check_added_monitors!(nodes[0], 1);
5556 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5557 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5559 //Disconnect and Reconnect
5560 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5561 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5562 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
5563 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
5564 assert_eq!(reestablish_1.len(), 1);
5565 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
5566 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
5567 assert_eq!(reestablish_2.len(), 1);
5568 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
5569 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
5570 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
5571 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
5574 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5575 assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
5576 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
5577 check_added_monitors!(nodes[1], 1);
5578 let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5580 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5582 assert!(nodes[1].node.list_channels().is_empty());
5583 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5584 assert_eq!(err_msg.data, "Remote skipped HTLC ID");
5588 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
5589 //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.
5591 let node_cfgs = create_node_cfgs(2);
5592 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5593 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5594 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5596 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5597 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5598 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5599 check_added_monitors!(nodes[0], 1);
5600 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5601 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5603 let update_msg = msgs::UpdateFulfillHTLC{
5606 payment_preimage: our_payment_preimage,
5609 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5611 assert!(nodes[0].node.list_channels().is_empty());
5612 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5613 assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
5617 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
5618 //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.
5620 let node_cfgs = create_node_cfgs(2);
5621 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5622 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5623 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5625 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5626 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5627 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5628 check_added_monitors!(nodes[0], 1);
5629 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5630 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5632 let update_msg = msgs::UpdateFailHTLC{
5635 reason: msgs::OnionErrorPacket { data: Vec::new()},
5638 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5640 assert!(nodes[0].node.list_channels().is_empty());
5641 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5642 assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
5646 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
5647 //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.
5649 let node_cfgs = create_node_cfgs(2);
5650 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5651 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5652 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5654 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5655 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5656 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5657 check_added_monitors!(nodes[0], 1);
5658 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5659 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5661 let update_msg = msgs::UpdateFailMalformedHTLC{
5664 sha256_of_onion: [1; 32],
5665 failure_code: 0x8000,
5668 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5670 assert!(nodes[0].node.list_channels().is_empty());
5671 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5672 assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
5676 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
5677 //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
5679 let node_cfgs = create_node_cfgs(2);
5680 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5681 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5682 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5684 let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
5686 nodes[1].node.claim_funds(our_payment_preimage, 100_000);
5687 check_added_monitors!(nodes[1], 1);
5689 let events = nodes[1].node.get_and_clear_pending_msg_events();
5690 assert_eq!(events.len(), 1);
5691 let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
5693 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, .. } } => {
5694 assert!(update_add_htlcs.is_empty());
5695 assert_eq!(update_fulfill_htlcs.len(), 1);
5696 assert!(update_fail_htlcs.is_empty());
5697 assert!(update_fail_malformed_htlcs.is_empty());
5698 assert!(update_fee.is_none());
5699 update_fulfill_htlcs[0].clone()
5701 _ => panic!("Unexpected event"),
5705 update_fulfill_msg.htlc_id = 1;
5707 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
5709 assert!(nodes[0].node.list_channels().is_empty());
5710 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5711 assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
5715 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
5716 //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.
5718 let node_cfgs = create_node_cfgs(2);
5719 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5720 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5721 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5723 let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
5725 nodes[1].node.claim_funds(our_payment_preimage, 100_000);
5726 check_added_monitors!(nodes[1], 1);
5728 let events = nodes[1].node.get_and_clear_pending_msg_events();
5729 assert_eq!(events.len(), 1);
5730 let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
5732 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, .. } } => {
5733 assert!(update_add_htlcs.is_empty());
5734 assert_eq!(update_fulfill_htlcs.len(), 1);
5735 assert!(update_fail_htlcs.is_empty());
5736 assert!(update_fail_malformed_htlcs.is_empty());
5737 assert!(update_fee.is_none());
5738 update_fulfill_htlcs[0].clone()
5740 _ => panic!("Unexpected event"),
5744 update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
5746 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
5748 assert!(nodes[0].node.list_channels().is_empty());
5749 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5750 assert_eq!(err_msg.data, "Remote tried to fulfill HTLC with an incorrect preimage");
5755 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
5756 //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.
5758 let node_cfgs = create_node_cfgs(2);
5759 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5760 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5761 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
5762 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5763 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5764 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5765 check_added_monitors!(nodes[0], 1);
5767 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5768 updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
5770 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5771 check_added_monitors!(nodes[1], 0);
5772 commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
5774 let events = nodes[1].node.get_and_clear_pending_msg_events();
5776 let mut update_msg: msgs::UpdateFailMalformedHTLC = {
5778 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, .. } } => {
5779 assert!(update_add_htlcs.is_empty());
5780 assert!(update_fulfill_htlcs.is_empty());
5781 assert!(update_fail_htlcs.is_empty());
5782 assert_eq!(update_fail_malformed_htlcs.len(), 1);
5783 assert!(update_fee.is_none());
5784 update_fail_malformed_htlcs[0].clone()
5786 _ => panic!("Unexpected event"),
5789 update_msg.failure_code &= !0x8000;
5790 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5792 assert!(nodes[0].node.list_channels().is_empty());
5793 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5794 assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
5798 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
5799 //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
5800 // * 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.
5802 let node_cfgs = create_node_cfgs(3);
5803 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5804 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5805 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
5806 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
5808 let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
5809 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5812 let mut payment_event = {
5813 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5814 check_added_monitors!(nodes[0], 1);
5815 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5816 assert_eq!(events.len(), 1);
5817 SendEvent::from_event(events.remove(0))
5819 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
5820 check_added_monitors!(nodes[1], 0);
5821 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
5822 expect_pending_htlcs_forwardable!(nodes[1]);
5823 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
5824 assert_eq!(events_2.len(), 1);
5825 check_added_monitors!(nodes[1], 1);
5826 payment_event = SendEvent::from_event(events_2.remove(0));
5827 assert_eq!(payment_event.msgs.len(), 1);
5830 payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
5831 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
5832 check_added_monitors!(nodes[2], 0);
5833 commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
5835 let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
5836 assert_eq!(events_3.len(), 1);
5837 let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
5839 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 } } => {
5840 assert!(update_add_htlcs.is_empty());
5841 assert!(update_fulfill_htlcs.is_empty());
5842 assert!(update_fail_htlcs.is_empty());
5843 assert_eq!(update_fail_malformed_htlcs.len(), 1);
5844 assert!(update_fee.is_none());
5845 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
5847 _ => panic!("Unexpected event"),
5851 nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
5853 check_added_monitors!(nodes[1], 0);
5854 commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
5855 expect_pending_htlcs_forwardable!(nodes[1]);
5856 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
5857 assert_eq!(events_4.len(), 1);
5859 //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
5861 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, .. } } => {
5862 assert!(update_add_htlcs.is_empty());
5863 assert!(update_fulfill_htlcs.is_empty());
5864 assert_eq!(update_fail_htlcs.len(), 1);
5865 assert!(update_fail_malformed_htlcs.is_empty());
5866 assert!(update_fee.is_none());
5868 _ => panic!("Unexpected event"),
5871 check_added_monitors!(nodes[1], 1);
5874 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
5875 // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
5876 // 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
5877 // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
5879 let node_cfgs = create_node_cfgs(2);
5880 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5881 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5882 let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5884 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
5886 // We route 2 dust-HTLCs between A and B
5887 let (_, payment_hash_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
5888 let (_, payment_hash_2) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
5889 route_payment(&nodes[0], &[&nodes[1]], 1000000);
5891 // Cache one local commitment tx as previous
5892 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();
5894 // Fail one HTLC to prune it in the will-be-latest-local commitment tx
5895 assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2));
5896 check_added_monitors!(nodes[1], 0);
5897 expect_pending_htlcs_forwardable!(nodes[1]);
5898 check_added_monitors!(nodes[1], 1);
5900 let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5901 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
5902 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
5903 check_added_monitors!(nodes[0], 1);
5905 // Cache one local commitment tx as lastest
5906 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();
5908 let events = nodes[0].node.get_and_clear_pending_msg_events();
5910 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
5911 assert_eq!(node_id, nodes[1].node.get_our_node_id());
5913 _ => panic!("Unexpected event"),
5916 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
5917 assert_eq!(node_id, nodes[1].node.get_our_node_id());
5919 _ => panic!("Unexpected event"),
5922 assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
5923 // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
5924 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5926 if announce_latest {
5927 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_last_commitment_tx[0].clone()]}, 1);
5929 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_prev_commitment_tx[0].clone()]}, 1);
5932 let events = nodes[0].node.get_and_clear_pending_msg_events();
5933 assert_eq!(events.len(), 1);
5935 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5936 _ => panic!("Unexpected event"),
5939 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
5940 connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
5941 let events = nodes[0].node.get_and_clear_pending_events();
5942 // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
5943 assert_eq!(events.len(), 2);
5944 let mut first_failed = false;
5945 for event in events {
5947 Event::PaymentFailed { payment_hash, .. } => {
5948 if payment_hash == payment_hash_1 {
5949 assert!(!first_failed);
5950 first_failed = true;
5952 assert_eq!(payment_hash, payment_hash_2);
5955 _ => panic!("Unexpected event"),
5961 fn test_failure_delay_dust_htlc_local_commitment() {
5962 do_test_failure_delay_dust_htlc_local_commitment(true);
5963 do_test_failure_delay_dust_htlc_local_commitment(false);
5967 fn test_no_failure_dust_htlc_local_commitment() {
5968 // Transaction filters for failing back dust htlc based on local commitment txn infos has been
5969 // prone to error, we test here that a dummy transaction don't fail them.
5971 let node_cfgs = create_node_cfgs(2);
5972 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5973 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5974 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5977 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
5979 let as_dust_limit = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
5980 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
5982 // We route 2 dust-HTLCs between A and B
5983 let (preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
5984 let (preimage_2, _) = route_payment(&nodes[1], &[&nodes[0]], as_dust_limit*1000);
5986 // Build a dummy invalid transaction trying to spend a commitment tx
5988 previous_output: BitcoinOutPoint { txid: chan.3.txid(), vout: 0 },
5989 script_sig: Script::new(),
5991 witness: Vec::new(),
5995 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
5999 let dummy_tx = Transaction {
6006 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6007 nodes[0].chan_monitor.simple_monitor.block_connected(&header, 1, &[&dummy_tx], &[1;1]);
6008 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6009 assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
6010 // We broadcast a few more block to check everything is all right
6011 connect_blocks(&nodes[0].block_notifier, 20, 1, true, header.bitcoin_hash());
6012 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6013 assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
6015 claim_payment(&nodes[0], &vec!(&nodes[1])[..], preimage_1, bs_dust_limit*1000);
6016 claim_payment(&nodes[1], &vec!(&nodes[0])[..], preimage_2, as_dust_limit*1000);
6019 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
6020 // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
6021 // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
6022 // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
6023 // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
6024 // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
6025 // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
6027 let node_cfgs = create_node_cfgs(3);
6028 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6029 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6030 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6032 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6034 let (_payment_preimage_1, dust_hash) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6035 let (_payment_preimage_2, non_dust_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
6037 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();
6038 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();
6040 // We revoked bs_commitment_tx
6042 let (payment_preimage_3, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
6043 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 1_000_000);
6046 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6047 let mut timeout_tx = Vec::new();
6049 // We fail dust-HTLC 1 by broadcast of local commitment tx
6050 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_commitment_tx[0].clone()]}, 1);
6051 let events = nodes[0].node.get_and_clear_pending_msg_events();
6052 assert_eq!(events.len(), 1);
6054 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
6055 _ => panic!("Unexpected event"),
6057 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6058 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
6059 let parent_hash = connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
6060 let events = nodes[0].node.get_and_clear_pending_events();
6061 assert_eq!(events.len(), 1);
6063 Event::PaymentFailed { payment_hash, .. } => {
6064 assert_eq!(payment_hash, dust_hash);
6066 _ => panic!("Unexpected event"),
6068 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
6069 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
6070 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6071 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6072 nodes[0].block_notifier.block_connected(&Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
6073 let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6074 connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
6075 let events = nodes[0].node.get_and_clear_pending_events();
6076 assert_eq!(events.len(), 1);
6078 Event::PaymentFailed { payment_hash, .. } => {
6079 assert_eq!(payment_hash, non_dust_hash);
6081 _ => panic!("Unexpected event"),
6084 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
6085 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![bs_commitment_tx[0].clone()]}, 1);
6086 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6087 let events = nodes[0].node.get_and_clear_pending_msg_events();
6088 assert_eq!(events.len(), 1);
6090 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
6091 _ => panic!("Unexpected event"),
6093 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
6094 let parent_hash = connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
6095 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6097 let events = nodes[0].node.get_and_clear_pending_events();
6098 assert_eq!(events.len(), 1);
6100 Event::PaymentFailed { payment_hash, .. } => {
6101 assert_eq!(payment_hash, dust_hash);
6103 _ => panic!("Unexpected event"),
6105 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
6106 // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
6107 nodes[0].block_notifier.block_connected(&Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
6108 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6109 let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6110 connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
6111 let events = nodes[0].node.get_and_clear_pending_events();
6112 assert_eq!(events.len(), 1);
6114 Event::PaymentFailed { payment_hash, .. } => {
6115 assert_eq!(payment_hash, non_dust_hash);
6117 _ => panic!("Unexpected event"),
6120 // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
6122 let events = nodes[0].node.get_and_clear_pending_events();
6123 assert_eq!(events.len(), 2);
6126 Event::PaymentFailed { payment_hash, .. } => {
6127 if payment_hash == dust_hash { first = true; }
6128 else { first = false; }
6130 _ => panic!("Unexpected event"),
6133 Event::PaymentFailed { payment_hash, .. } => {
6134 if first { assert_eq!(payment_hash, non_dust_hash); }
6135 else { assert_eq!(payment_hash, dust_hash); }
6137 _ => panic!("Unexpected event"),
6144 fn test_sweep_outbound_htlc_failure_update() {
6145 do_test_sweep_outbound_htlc_failure_update(false, true);
6146 do_test_sweep_outbound_htlc_failure_update(false, false);
6147 do_test_sweep_outbound_htlc_failure_update(true, false);
6151 fn test_upfront_shutdown_script() {
6152 // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
6153 // enforce it at shutdown message
6155 let mut config = UserConfig::default();
6156 config.channel_options.announced_channel = true;
6157 config.peer_channel_config_limits.force_announced_channel_preference = false;
6158 config.channel_options.commit_upfront_shutdown_pubkey = false;
6159 let user_cfgs = [None, Some(config), None];
6160 let node_cfgs = create_node_cfgs(3);
6161 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
6162 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6164 // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
6165 let flags = InitFeatures::supported();
6166 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
6167 nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6168 let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
6169 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6170 // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that we disconnect peer
6171 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
6172 let events = nodes[2].node.get_and_clear_pending_msg_events();
6173 assert_eq!(events.len(), 2);
6175 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
6176 _ => panic!("Unexpected event"),
6178 if let MessageSendEvent::HandleError { ref action, .. } = events[1] {
6180 &ErrorAction::SendErrorMessage { ref msg } => {
6181 assert_eq!(msg.data,"Got shutdown request with a scriptpubkey which did not match their previous scriptpubkey");
6183 _ => { assert!(false); }
6185 } else { assert!(false); }
6187 // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
6188 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
6189 nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6190 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
6191 // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
6192 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
6193 let events = nodes[2].node.get_and_clear_pending_msg_events();
6194 assert_eq!(events.len(), 1);
6196 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
6197 _ => panic!("Unexpected event"),
6200 // We test that if case of peer non-signaling we don't enforce committed script at channel opening
6201 let mut flags_no = InitFeatures::supported();
6202 flags_no.unset_upfront_shutdown_script();
6203 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
6204 nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6205 let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
6206 node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6207 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_1_shutdown);
6208 let events = nodes[1].node.get_and_clear_pending_msg_events();
6209 assert_eq!(events.len(), 1);
6211 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
6212 _ => panic!("Unexpected event"),
6215 // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
6216 // channel smoothly, opt-out is from channel initiator here
6217 let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
6218 nodes[1].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6219 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
6220 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6221 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
6222 let events = nodes[0].node.get_and_clear_pending_msg_events();
6223 assert_eq!(events.len(), 1);
6225 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6226 _ => panic!("Unexpected event"),
6229 //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
6230 //// channel smoothly
6231 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
6232 nodes[1].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6233 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
6234 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6235 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
6236 let events = nodes[0].node.get_and_clear_pending_msg_events();
6237 assert_eq!(events.len(), 2);
6239 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6240 _ => panic!("Unexpected event"),
6243 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6244 _ => panic!("Unexpected event"),
6249 fn test_user_configurable_csv_delay() {
6250 // We test our channel constructors yield errors when we pass them absurd csv delay
6252 let mut low_our_to_self_config = UserConfig::default();
6253 low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
6254 let mut high_their_to_self_config = UserConfig::default();
6255 high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
6256 let user_cfgs = [Some(high_their_to_self_config.clone()), None];
6257 let node_cfgs = create_node_cfgs(2);
6258 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
6259 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6261 // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
6262 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())));
6263 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) {
6265 APIError::APIMisuseError { err } => { assert_eq!(err, "Configured with an unreasonable our_to_self_delay putting user funds at risks"); },
6266 _ => panic!("Unexpected event"),
6268 } else { assert!(false) }
6270 // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
6271 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42).unwrap();
6272 let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
6273 open_channel.to_self_delay = 200;
6274 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) {
6276 ChannelError::Close(err) => { assert_eq!(err, "Configured with an unreasonable our_to_self_delay putting user funds at risks"); },
6277 _ => panic!("Unexpected event"),
6279 } else { assert!(false); }
6281 // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
6282 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42).unwrap();
6283 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()));
6284 let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
6285 accept_channel.to_self_delay = 200;
6286 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::supported(), &accept_channel);
6287 if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
6289 &ErrorAction::SendErrorMessage { ref msg } => {
6290 assert_eq!(msg.data,"They wanted our payments to be delayed by a needlessly long period");
6292 _ => { assert!(false); }
6294 } else { assert!(false); }
6296 // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
6297 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42).unwrap();
6298 let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
6299 open_channel.to_self_delay = 200;
6300 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) {
6302 ChannelError::Close(err) => { assert_eq!(err, "They wanted our payments to be delayed by a needlessly long period"); },
6303 _ => panic!("Unexpected event"),
6305 } else { assert!(false); }
6309 fn test_data_loss_protect() {
6310 // We want to be sure that :
6311 // * we don't broadcast our Local Commitment Tx in case of fallen behind
6312 // * we close channel in case of detecting other being fallen behind
6313 // * we are able to claim our own outputs thanks to remote my_current_per_commitment_point
6316 let node_cfgs = create_node_cfgs(2);
6317 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6318 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6320 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
6322 // Cache node A state before any channel update
6323 let previous_node_state = nodes[0].node.encode();
6324 let mut previous_chan_monitor_state = test_utils::TestVecWriter(Vec::new());
6325 nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut previous_chan_monitor_state).unwrap();
6327 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
6328 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
6330 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6331 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6333 // Restore node A from previous state
6334 let logger: Arc<Logger> = Arc::new(test_utils::TestLogger::with_id(format!("node {}", 0)));
6335 let mut chan_monitor = <(Sha256dHash, ChannelMonitor)>::read(&mut ::std::io::Cursor::new(previous_chan_monitor_state.0), Arc::clone(&logger)).unwrap().1;
6336 let chain_monitor = Arc::new(ChainWatchInterfaceUtil::new(Network::Testnet, Arc::clone(&logger)));
6337 let tx_broadcaster = Arc::new(test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())});
6338 let feeest = Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 });
6339 monitor = test_utils::TestChannelMonitor::new(chain_monitor.clone(), tx_broadcaster.clone(), logger.clone(), feeest.clone());
6341 let mut channel_monitors = HashMap::new();
6342 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chan_monitor);
6343 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor>)>::read(&mut ::std::io::Cursor::new(previous_node_state), ChannelManagerReadArgs {
6344 keys_manager: Arc::new(test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::clone(&logger))),
6345 fee_estimator: feeest.clone(),
6347 logger: Arc::clone(&logger),
6349 default_config: UserConfig::default(),
6350 channel_monitors: &mut channel_monitors,
6353 nodes[0].node = &node_state_0;
6354 assert!(monitor.add_update_monitor(OutPoint { txid: chan.3.txid(), index: 0 }, chan_monitor.clone()).is_ok());
6355 nodes[0].chan_monitor = &monitor;
6356 nodes[0].chain_monitor = chain_monitor;
6358 nodes[0].block_notifier = BlockNotifier::new(nodes[0].chain_monitor.clone());
6359 nodes[0].block_notifier.register_listener(&nodes[0].chan_monitor.simple_monitor);
6360 nodes[0].block_notifier.register_listener(nodes[0].node);
6362 check_added_monitors!(nodes[0], 1);
6364 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6365 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6367 let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6369 // Check we update monitor following learning of per_commitment_point from B
6370 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
6371 check_added_monitors!(nodes[0], 1);
6374 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
6375 assert_eq!(node_txn.len(), 0);
6378 let mut reestablish_1 = Vec::with_capacity(1);
6379 for msg in nodes[0].node.get_and_clear_pending_msg_events() {
6380 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
6381 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
6382 reestablish_1.push(msg.clone());
6383 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
6384 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
6386 &ErrorAction::SendErrorMessage { ref msg } => {
6387 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");
6389 _ => panic!("Unexpected event!"),
6392 panic!("Unexpected event")
6396 // Check we close channel detecting A is fallen-behind
6397 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6398 let events = nodes[1].node.get_and_clear_pending_msg_events();
6399 assert_eq!(events.len(), 2);
6401 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
6402 _ => panic!("Unexpected event"),
6405 MessageSendEvent::HandleError { ref action, .. } => {
6407 &ErrorAction::SendErrorMessage { ref msg } => {
6408 assert_eq!(msg.data, "Peer attempted to reestablish channel with a very old local commitment transaction"); },
6409 _ => panic!("Unexpected event!"),
6412 _ => panic!("Unexpected event"),
6415 // Check A is able to claim to_remote output
6416 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
6417 assert_eq!(node_txn.len(), 1);
6418 check_spends!(node_txn[0], chan.3.clone());
6419 assert_eq!(node_txn[0].output.len(), 2);
6420 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
6421 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()]}, 1);
6422 let spend_txn = check_spendable_outputs!(nodes[0], 1);
6423 assert_eq!(spend_txn.len(), 1);
6424 check_spends!(spend_txn[0], node_txn[0].clone());
6428 fn test_check_htlc_underpaying() {
6429 // Send payment through A -> B but A is maliciously
6430 // sending a probe payment (i.e less than expected value0
6431 // to B, B should refuse payment.
6433 let node_cfgs = create_node_cfgs(2);
6434 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6435 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6437 // Create some initial channels
6438 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6440 let (payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 10_000);
6442 // Node 3 is expecting payment of 100_000 but receive 10_000,
6443 // fail htlc like we didn't know the preimage.
6444 nodes[1].node.claim_funds(payment_preimage, 100_000);
6445 nodes[1].node.process_pending_htlc_forwards();
6447 let events = nodes[1].node.get_and_clear_pending_msg_events();
6448 assert_eq!(events.len(), 1);
6449 let (update_fail_htlc, commitment_signed) = match events[0] {
6450 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 } } => {
6451 assert!(update_add_htlcs.is_empty());
6452 assert!(update_fulfill_htlcs.is_empty());
6453 assert_eq!(update_fail_htlcs.len(), 1);
6454 assert!(update_fail_malformed_htlcs.is_empty());
6455 assert!(update_fee.is_none());
6456 (update_fail_htlcs[0].clone(), commitment_signed)
6458 _ => panic!("Unexpected event"),
6460 check_added_monitors!(nodes[1], 1);
6462 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
6463 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
6465 let events = nodes[0].node.get_and_clear_pending_events();
6466 assert_eq!(events.len(), 1);
6467 if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code } = &events[0] {
6468 assert_eq!(*rejected_by_dest, true);
6469 assert_eq!(error_code.unwrap(), 0x4000|15);
6471 panic!("Unexpected event");
6473 nodes[1].node.get_and_clear_pending_events();
6477 fn test_announce_disable_channels() {
6478 // Create 2 channels between A and B. Disconnect B. Call timer_chan_freshness_every_min and check for generated
6479 // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
6481 let node_cfgs = create_node_cfgs(2);
6482 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6483 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6485 let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
6486 let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
6487 let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
6490 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6491 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6493 nodes[0].node.timer_chan_freshness_every_min(); // dirty -> stagged
6494 nodes[0].node.timer_chan_freshness_every_min(); // staged -> fresh
6495 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
6496 assert_eq!(msg_events.len(), 3);
6497 for e in msg_events {
6499 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
6500 let short_id = msg.contents.short_channel_id;
6501 // Check generated channel_update match list in PendingChannelUpdate
6502 if short_id != short_id_1 && short_id != short_id_2 && short_id != short_id_3 {
6503 panic!("Generated ChannelUpdate for wrong chan!");
6506 _ => panic!("Unexpected event"),
6510 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6511 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6512 assert_eq!(reestablish_1.len(), 3);
6513 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6514 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6515 assert_eq!(reestablish_2.len(), 3);
6517 // Reestablish chan_1
6518 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6519 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6520 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6521 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6522 // Reestablish chan_2
6523 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
6524 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6525 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
6526 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6527 // Reestablish chan_3
6528 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
6529 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6530 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
6531 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6533 nodes[0].node.timer_chan_freshness_every_min();
6534 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6538 fn test_bump_penalty_txn_on_revoked_commitment() {
6539 // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
6540 // we're able to claim outputs on revoked commitment transaction before timelocks expiration
6542 let node_cfgs = create_node_cfgs(2);
6543 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6544 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6546 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
6547 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
6548 let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 3000000, 30).unwrap();
6549 send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
6551 let revoked_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
6552 // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
6553 assert_eq!(revoked_txn[0].output.len(), 4);
6554 assert_eq!(revoked_txn[0].input.len(), 1);
6555 assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
6556 let revoked_txid = revoked_txn[0].txid();
6558 let mut penalty_sum = 0;
6559 for outp in revoked_txn[0].output.iter() {
6560 if outp.script_pubkey.is_v0_p2wsh() {
6561 penalty_sum += outp.value;
6565 // Connect blocks to change height_timer range to see if we use right soonest_timelock
6566 let header_114 = connect_blocks(&nodes[1].block_notifier, 114, 0, false, Default::default());
6568 // Actually revoke tx by claiming a HTLC
6569 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
6570 let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6571 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_txn[0].clone()] }, 115);
6573 // One or more justice tx should have been broadcast, check it
6577 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6578 assert_eq!(node_txn.len(), 4); // justice tx (broadcasted from ChannelMonitor) * 2 (block-reparsing) + local commitment tx + local HTLC-timeout (broadcasted from ChannelManager)
6579 assert_eq!(node_txn[0], node_txn[3]);
6580 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
6581 assert_eq!(node_txn[0].output.len(), 1);
6582 check_spends!(node_txn[0], revoked_txn[0].clone());
6583 let fee_1 = penalty_sum - node_txn[0].output[0].value;
6584 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
6585 penalty_1 = node_txn[0].txid();
6589 // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
6590 let header = connect_blocks(&nodes[1].block_notifier, 3, 115, true, header.bitcoin_hash());
6591 let mut penalty_2 = penalty_1;
6592 let mut feerate_2 = 0;
6594 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6595 assert_eq!(node_txn.len(), 1);
6596 if node_txn[0].input[0].previous_output.txid == revoked_txid {
6597 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
6598 assert_eq!(node_txn[0].output.len(), 1);
6599 check_spends!(node_txn[0], revoked_txn[0].clone());
6600 penalty_2 = node_txn[0].txid();
6601 // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
6602 assert_ne!(penalty_2, penalty_1);
6603 let fee_2 = penalty_sum - node_txn[0].output[0].value;
6604 feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
6605 // Verify 25% bump heuristic
6606 assert!(feerate_2 * 100 >= feerate_1 * 125);
6610 assert_ne!(feerate_2, 0);
6612 // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
6613 connect_blocks(&nodes[1].block_notifier, 3, 118, true, header);
6615 let mut feerate_3 = 0;
6617 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6618 assert_eq!(node_txn.len(), 1);
6619 if node_txn[0].input[0].previous_output.txid == revoked_txid {
6620 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
6621 assert_eq!(node_txn[0].output.len(), 1);
6622 check_spends!(node_txn[0], revoked_txn[0].clone());
6623 penalty_3 = node_txn[0].txid();
6624 // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
6625 assert_ne!(penalty_3, penalty_2);
6626 let fee_3 = penalty_sum - node_txn[0].output[0].value;
6627 feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
6628 // Verify 25% bump heuristic
6629 assert!(feerate_3 * 100 >= feerate_2 * 125);
6633 assert_ne!(feerate_3, 0);
6635 nodes[1].node.get_and_clear_pending_events();
6636 nodes[1].node.get_and_clear_pending_msg_events();
6640 fn test_bump_penalty_txn_on_revoked_htlcs() {
6641 // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
6642 // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
6644 let node_cfgs = create_node_cfgs(2);
6645 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6646 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6648 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
6649 // Lock HTLC in both directions
6650 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3_000_000).0;
6651 route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
6653 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();
6654 assert_eq!(revoked_local_txn[0].input.len(), 1);
6655 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
6657 // Revoke local commitment tx
6658 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
6660 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6661 // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
6662 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
6663 check_closed_broadcast!(nodes[1], false);
6665 let mut received = ::std::usize::MAX;
6666 let mut offered = ::std::usize::MAX;
6667 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6668 assert_eq!(revoked_htlc_txn.len(), 6);
6669 if revoked_htlc_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
6670 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
6671 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
6672 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
6673 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
6674 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0].clone());
6677 } else if revoked_htlc_txn[1].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
6678 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
6679 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0].clone());
6680 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
6681 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
6682 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
6687 // Broadcast set of revoked txn on A
6688 let header_128 = connect_blocks(&nodes[0].block_notifier, 128, 0, true, header.bitcoin_hash());
6689 let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6690 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);
6696 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6697 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
6698 // Verify claim tx are spending revoked HTLC txn
6699 assert_eq!(node_txn[7].input.len(), 1);
6700 assert_eq!(node_txn[7].output.len(), 1);
6701 check_spends!(node_txn[7], revoked_htlc_txn[0].clone());
6702 first = node_txn[7].txid();
6703 assert_eq!(node_txn[8].input.len(), 1);
6704 assert_eq!(node_txn[8].output.len(), 1);
6705 check_spends!(node_txn[8], revoked_htlc_txn[1].clone());
6706 second = node_txn[8].txid();
6707 // Store both feerates for later comparison
6708 let fee_1 = revoked_htlc_txn[0].output[0].value - node_txn[7].output[0].value;
6709 feerate_1 = fee_1 * 1000 / node_txn[7].get_weight() as u64;
6710 let fee_2 = revoked_htlc_txn[1].output[0].value - node_txn[8].output[0].value;
6711 feerate_2 = fee_2 * 1000 / node_txn[8].get_weight() as u64;
6715 // Connect three more block to see if bumped penalty are issued for HTLC txn
6716 let header_132 = connect_blocks(&nodes[0].block_notifier, 3, 129, true, header_129.bitcoin_hash());
6717 let penalty_local_tx;
6719 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6720 assert_eq!(node_txn.len(), 3); // 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
6722 check_spends!(node_txn[0], revoked_local_txn[0].clone());
6723 check_spends!(node_txn[1], revoked_local_txn[0].clone());
6725 check_spends!(node_txn[2], revoked_local_txn[0].clone());
6727 penalty_local_tx = node_txn[2].clone();
6730 // Few more blocks to broadcast and confirm penalty_local_tx
6731 let header_133 = BlockHeader { version: 0x20000000, prev_blockhash: header_132, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6732 nodes[0].block_notifier.block_connected(&Block { header: header_133, txdata: vec![penalty_local_tx] }, 133);
6733 let header_135 = connect_blocks(&nodes[0].block_notifier, 2, 133, true, header_133.bitcoin_hash());
6735 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6736 assert_eq!(node_txn.len(), 1);
6737 check_spends!(node_txn[0], revoked_local_txn[0].clone());
6740 let header_144 = connect_blocks(&nodes[0].block_notifier, 9, 135, true, header_135);
6742 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6743 assert_eq!(node_txn.len(), 2);
6745 let mut penalty_offered = ::std::usize::MAX;
6746 let mut penalty_received = ::std::usize::MAX;
6749 for (i, tx) in node_txn.iter().enumerate() {
6750 if tx.input[0].previous_output.txid == revoked_htlc_txn[offered].txid() {
6751 penalty_offered = i;
6752 } else if tx.input[0].previous_output.txid == revoked_htlc_txn[received].txid() {
6753 penalty_received = i;
6758 assert_eq!(node_txn[penalty_received].input.len(), 1);
6759 assert_eq!(node_txn[penalty_received].output.len(), 1);
6760 assert_eq!(node_txn[penalty_offered].input.len(), 1);
6761 assert_eq!(node_txn[penalty_offered].output.len(), 1);
6762 // Verify bumped tx is different and 25% bump heuristic
6763 check_spends!(node_txn[penalty_offered], revoked_htlc_txn[offered].clone());
6764 assert_ne!(first, node_txn[penalty_offered].txid());
6765 let fee = revoked_htlc_txn[offered].output[0].value - node_txn[penalty_offered].output[0].value;
6766 let new_feerate = fee * 1000 / node_txn[penalty_offered].get_weight() as u64;
6767 assert!(new_feerate * 100 > feerate_1 * 125);
6769 check_spends!(node_txn[penalty_received], revoked_htlc_txn[received].clone());
6770 assert_ne!(second, node_txn[penalty_received].txid());
6771 let fee = revoked_htlc_txn[received].output[0].value - node_txn[penalty_received].output[0].value;
6772 let new_feerate = fee * 1000 / node_txn[penalty_received].get_weight() as u64;
6773 assert!(new_feerate * 100 > feerate_2 * 125);
6774 let txn = vec![node_txn[0].clone(), node_txn[1].clone()];
6778 // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
6779 let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6780 nodes[0].block_notifier.block_connected(&Block { header: header_145, txdata: node_txn }, 145);
6781 connect_blocks(&nodes[0].block_notifier, 20, 145, true, header_145.bitcoin_hash());
6783 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6784 assert_eq!(node_txn.len(), 2); //TODO: fix check_spend_remote_htlc lack of watch output
6787 check_closed_broadcast!(nodes[0], false);
6791 fn test_bump_penalty_txn_on_remote_commitment() {
6792 // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
6793 // we're able to claim outputs on remote commitment transaction before timelocks expiration
6796 // Provide preimage for one
6797 // Check aggregation
6799 let node_cfgs = create_node_cfgs(2);
6800 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6801 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6803 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
6804 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
6805 route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
6807 // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
6808 let remote_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
6809 assert_eq!(remote_txn[0].output.len(), 4);
6810 assert_eq!(remote_txn[0].input.len(), 1);
6811 assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
6813 // Claim a HTLC without revocation (provide B monitor with preimage)
6814 nodes[1].node.claim_funds(payment_preimage, 3_000_000);
6815 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6816 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
6817 check_added_monitors!(nodes[1], 1);
6819 // One or more claim tx should have been broadcast, check it
6822 let feerate_timeout;
6823 let feerate_preimage;
6825 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6826 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)
6827 assert_eq!(node_txn[0], node_txn[5]);
6828 assert_eq!(node_txn[1], node_txn[6]);
6829 assert_eq!(node_txn[0].input.len(), 1);
6830 assert_eq!(node_txn[1].input.len(), 1);
6831 check_spends!(node_txn[0], remote_txn[0].clone());
6832 check_spends!(node_txn[1], remote_txn[0].clone());
6833 check_spends!(node_txn[2], chan.3);
6834 check_spends!(node_txn[3], node_txn[2]);
6835 check_spends!(node_txn[4], node_txn[2]);
6836 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
6837 timeout = node_txn[0].txid();
6838 let index = node_txn[0].input[0].previous_output.vout;
6839 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
6840 feerate_timeout = fee * 1000 / node_txn[0].get_weight() as u64;
6842 preimage = node_txn[1].txid();
6843 let index = node_txn[1].input[0].previous_output.vout;
6844 let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
6845 feerate_preimage = fee * 1000 / node_txn[1].get_weight() as u64;
6847 timeout = node_txn[1].txid();
6848 let index = node_txn[1].input[0].previous_output.vout;
6849 let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
6850 feerate_timeout = fee * 1000 / node_txn[1].get_weight() as u64;
6852 preimage = node_txn[0].txid();
6853 let index = node_txn[0].input[0].previous_output.vout;
6854 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
6855 feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
6859 assert_ne!(feerate_timeout, 0);
6860 assert_ne!(feerate_preimage, 0);
6862 // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
6863 connect_blocks(&nodes[1].block_notifier, 15, 1, true, header.bitcoin_hash());
6865 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6866 assert_eq!(node_txn.len(), 2);
6867 assert_eq!(node_txn[0].input.len(), 1);
6868 assert_eq!(node_txn[1].input.len(), 1);
6869 check_spends!(node_txn[0], remote_txn[0].clone());
6870 check_spends!(node_txn[1], remote_txn[0].clone());
6871 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
6872 let index = node_txn[0].input[0].previous_output.vout;
6873 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
6874 let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
6875 assert!(new_feerate * 100 > feerate_timeout * 125);
6876 assert_ne!(timeout, node_txn[0].txid());
6878 let index = node_txn[1].input[0].previous_output.vout;
6879 let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
6880 let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
6881 assert!(new_feerate * 100 > feerate_preimage * 125);
6882 assert_ne!(preimage, node_txn[1].txid());
6884 let index = node_txn[1].input[0].previous_output.vout;
6885 let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
6886 let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
6887 assert!(new_feerate * 100 > feerate_timeout * 125);
6888 assert_ne!(timeout, node_txn[1].txid());
6890 let index = node_txn[0].input[0].previous_output.vout;
6891 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
6892 let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
6893 assert!(new_feerate * 100 > feerate_preimage * 125);
6894 assert_ne!(preimage, node_txn[0].txid());
6899 nodes[1].node.get_and_clear_pending_events();
6900 nodes[1].node.get_and_clear_pending_msg_events();
6904 fn test_set_outpoints_partial_claiming() {
6905 // - remote party claim tx, new bump tx
6906 // - disconnect remote claiming tx, new bump
6907 // - disconnect tx, see no tx anymore
6908 let node_cfgs = create_node_cfgs(2);
6909 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6910 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6912 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
6913 let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
6914 let payment_preimage_2 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
6916 // Remote commitment txn with 4 outputs: to_local, to_remote, 2 outgoing HTLC
6917 let remote_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
6918 assert_eq!(remote_txn.len(), 3);
6919 assert_eq!(remote_txn[0].output.len(), 4);
6920 assert_eq!(remote_txn[0].input.len(), 1);
6921 assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
6922 check_spends!(remote_txn[1], remote_txn[0].clone());
6923 check_spends!(remote_txn[2], remote_txn[0].clone());
6925 // Connect blocks on node A to advance height towards TEST_FINAL_CLTV
6926 let prev_header_100 = connect_blocks(&nodes[1].block_notifier, 100, 0, false, Default::default());
6927 // Provide node A with both preimage
6928 nodes[0].node.claim_funds(payment_preimage_1, 3_000_000);
6929 nodes[0].node.claim_funds(payment_preimage_2, 3_000_000);
6930 check_added_monitors!(nodes[0], 2);
6931 nodes[0].node.get_and_clear_pending_events();
6932 nodes[0].node.get_and_clear_pending_msg_events();
6934 // Connect blocks on node A commitment transaction
6935 let header = BlockHeader { version: 0x20000000, prev_blockhash: prev_header_100, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6936 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 101);
6937 // Verify node A broadcast tx claiming both HTLCs
6939 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6940 assert_eq!(node_txn.len(), 5);
6941 assert_eq!(node_txn[0], node_txn[4]);
6942 check_spends!(node_txn[0], remote_txn[0].clone());
6943 check_spends!(node_txn[1], chan.3.clone());
6944 check_spends!(node_txn[2], node_txn[1]);
6945 check_spends!(node_txn[3], node_txn[1]);
6946 assert_eq!(node_txn[0].input.len(), 2);
6949 nodes[0].node.get_and_clear_pending_msg_events();
6951 // Connect blocks on node B
6952 connect_blocks(&nodes[1].block_notifier, 135, 0, false, Default::default());
6953 // Verify node B broadcast 2 HTLC-timeout txn
6954 let partial_claim_tx = {
6955 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6956 assert_eq!(node_txn.len(), 3);
6957 check_spends!(node_txn[1], node_txn[0].clone());
6958 check_spends!(node_txn[2], node_txn[0].clone());
6959 assert_eq!(node_txn[1].input.len(), 1);
6960 assert_eq!(node_txn[2].input.len(), 1);
6963 nodes[1].node.get_and_clear_pending_msg_events();
6965 // Broadcast partial claim on node A, should regenerate a claiming tx with HTLC dropped
6966 let header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6967 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![partial_claim_tx.clone()] }, 102);
6969 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6970 assert_eq!(node_txn.len(), 1);
6971 check_spends!(node_txn[0], remote_txn[0].clone());
6972 assert_eq!(node_txn[0].input.len(), 1); //dropped HTLC
6975 nodes[0].node.get_and_clear_pending_msg_events();
6977 // Disconnect last block on node A, should regenerate a claiming tx with HTLC dropped
6978 nodes[0].block_notifier.block_disconnected(&header, 102);
6980 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6981 assert_eq!(node_txn.len(), 1);
6982 check_spends!(node_txn[0], remote_txn[0].clone());
6983 assert_eq!(node_txn[0].input.len(), 2); //resurrected HTLC
6987 //// Disconnect one more block and then reconnect multiple no transaction should be generated
6988 nodes[0].block_notifier.block_disconnected(&header, 101);
6989 connect_blocks(&nodes[1].block_notifier, 15, 101, false, prev_header_100);
6991 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6992 assert_eq!(node_txn.len(), 0);
6998 fn test_bump_txn_sanitize_tracking_maps() {
6999 // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
7000 // verify we clean then right after expiration of ANTI_REORG_DELAY.
7002 let node_cfgs = create_node_cfgs(2);
7003 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7004 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7006 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
7007 // Lock HTLC in both directions
7008 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
7009 route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
7011 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();
7012 assert_eq!(revoked_local_txn[0].input.len(), 1);
7013 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7015 // Revoke local commitment tx
7016 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 9_000_000);
7018 // Broadcast set of revoked txn on A
7019 let header_128 = connect_blocks(&nodes[0].block_notifier, 128, 0, false, Default::default());
7020 let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7021 nodes[0].block_notifier.block_connected(&Block { header: header_129, txdata: vec![revoked_local_txn[0].clone()] }, 129);
7022 check_closed_broadcast!(nodes[0], false);
7024 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7025 assert_eq!(node_txn.len(), 7);
7026 check_spends!(node_txn[0], revoked_local_txn[0].clone());
7027 check_spends!(node_txn[1], revoked_local_txn[0].clone());
7028 check_spends!(node_txn[2], revoked_local_txn[0].clone());
7029 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
7033 let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7034 nodes[0].block_notifier.block_connected(&Block { header: header_130, txdata: penalty_txn }, 130);
7035 connect_blocks(&nodes[0].block_notifier, 5, 130, false, header_130.bitcoin_hash());
7037 let monitors = nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap();
7038 if let Some(monitor) = monitors.get(&OutPoint::new(chan.3.txid(), 0)) {
7039 assert!(monitor.pending_claim_requests.is_empty());
7040 assert!(monitor.claimable_outpoints.is_empty());