1 //! Tests that test standing up a network of ChannelManagers, creating channels, sending
2 //! payments/messages between them, and often checking the resulting ChannelMonitors are able to
3 //! claim outputs on-chain.
5 use chain::transaction::OutPoint;
6 use chain::chaininterface::{ChainListener, ChainWatchInterface};
7 use chain::keysinterface::{KeysInterface, SpendableOutputDescriptor};
8 use chain::keysinterface;
9 use ln::channel::{COMMITMENT_TX_BASE_WEIGHT, COMMITMENT_TX_WEIGHT_PER_HTLC, BREAKDOWN_TIMEOUT};
10 use ln::channelmanager::{ChannelManager,ChannelManagerReadArgs,HTLCForwardInfo,RAACommitmentOrder, PaymentPreimage, PaymentHash};
11 use ln::channelmonitor::{ChannelMonitor, CLTV_CLAIM_BUFFER, HTLC_FAIL_TIMEOUT_BLOCKS, ManyChannelMonitor};
12 use ln::channel::{ACCEPTED_HTLC_SCRIPT_WEIGHT, OFFERED_HTLC_SCRIPT_WEIGHT};
14 use ln::router::{Route, RouteHop};
16 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler,HTLCFailChannelUpdate};
18 use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
19 use util::errors::APIError;
20 use util::ser::{Writeable, ReadableArgs};
21 use util::config::UserConfig;
24 use bitcoin::util::hash::BitcoinHash;
25 use bitcoin_hashes::sha256d::Hash as Sha256dHash;
26 use bitcoin::util::bip143;
27 use bitcoin::util::address::Address;
28 use bitcoin::util::bip32::{ChildNumber, ExtendedPubKey, ExtendedPrivKey};
29 use bitcoin::blockdata::block::{Block, BlockHeader};
30 use bitcoin::blockdata::transaction::{Transaction, TxOut, TxIn, SigHashType};
31 use bitcoin::blockdata::script::{Builder, Script};
32 use bitcoin::blockdata::opcodes;
33 use bitcoin::blockdata::constants::genesis_block;
34 use bitcoin::network::constants::Network;
36 use bitcoin_hashes::sha256::Hash as Sha256;
37 use bitcoin_hashes::Hash;
39 use secp256k1::{Secp256k1, Message};
40 use secp256k1::key::{PublicKey,SecretKey};
42 use std::collections::{BTreeSet, HashMap, HashSet};
43 use std::default::Default;
45 use std::sync::atomic::Ordering;
46 use std::time::Instant;
49 use ln::functional_test_utils::*;
52 fn test_async_inbound_update_fee() {
53 let mut nodes = create_network(2);
54 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
55 let channel_id = chan.2;
58 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
62 // send (1) commitment_signed -.
63 // <- update_add_htlc/commitment_signed
64 // send (2) RAA (awaiting remote revoke) -.
65 // (1) commitment_signed is delivered ->
66 // .- send (3) RAA (awaiting remote revoke)
67 // (2) RAA is delivered ->
68 // .- send (4) commitment_signed
69 // <- (3) RAA is delivered
70 // send (5) commitment_signed -.
71 // <- (4) commitment_signed is delivered
73 // (5) commitment_signed is delivered ->
75 // (6) RAA is delivered ->
77 // First nodes[0] generates an update_fee
78 nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
79 check_added_monitors!(nodes[0], 1);
81 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
82 assert_eq!(events_0.len(), 1);
83 let (update_msg, commitment_signed) = match events_0[0] { // (1)
84 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
85 (update_fee.as_ref(), commitment_signed)
87 _ => panic!("Unexpected event"),
90 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
92 // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
93 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
94 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();
95 check_added_monitors!(nodes[1], 1);
98 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
99 assert_eq!(events_1.len(), 1);
100 SendEvent::from_event(events_1.remove(0))
102 assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
103 assert_eq!(payment_event.msgs.len(), 1);
105 // ...now when the messages get delivered everyone should be happy
106 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
107 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg).unwrap(); // (2)
108 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
109 // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
110 check_added_monitors!(nodes[0], 1);
112 // deliver(1), generate (3):
113 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
114 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
115 // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
116 check_added_monitors!(nodes[1], 1);
118 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap(); // deliver (2)
119 let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
120 assert!(bs_update.update_add_htlcs.is_empty()); // (4)
121 assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
122 assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
123 assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
124 assert!(bs_update.update_fee.is_none()); // (4)
125 check_added_monitors!(nodes[1], 1);
127 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap(); // deliver (3)
128 let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
129 assert!(as_update.update_add_htlcs.is_empty()); // (5)
130 assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
131 assert!(as_update.update_fail_htlcs.is_empty()); // (5)
132 assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
133 assert!(as_update.update_fee.is_none()); // (5)
134 check_added_monitors!(nodes[0], 1);
136 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed).unwrap(); // deliver (4)
137 let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
138 // only (6) so get_event_msg's assert(len == 1) passes
139 check_added_monitors!(nodes[0], 1);
141 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed).unwrap(); // deliver (5)
142 let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
143 check_added_monitors!(nodes[1], 1);
145 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke).unwrap();
146 check_added_monitors!(nodes[0], 1);
148 let events_2 = nodes[0].node.get_and_clear_pending_events();
149 assert_eq!(events_2.len(), 1);
151 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
152 _ => panic!("Unexpected event"),
155 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke).unwrap(); // deliver (6)
156 check_added_monitors!(nodes[1], 1);
160 fn test_update_fee_unordered_raa() {
161 // Just the intro to the previous test followed by an out-of-order RAA (which caused a
162 // crash in an earlier version of the update_fee patch)
163 let mut nodes = create_network(2);
164 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
165 let channel_id = chan.2;
168 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
170 // First nodes[0] generates an update_fee
171 nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
172 check_added_monitors!(nodes[0], 1);
174 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
175 assert_eq!(events_0.len(), 1);
176 let update_msg = match events_0[0] { // (1)
177 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
180 _ => panic!("Unexpected event"),
183 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
185 // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
186 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
187 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();
188 check_added_monitors!(nodes[1], 1);
190 let payment_event = {
191 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
192 assert_eq!(events_1.len(), 1);
193 SendEvent::from_event(events_1.remove(0))
195 assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
196 assert_eq!(payment_event.msgs.len(), 1);
198 // ...now when the messages get delivered everyone should be happy
199 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
200 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg).unwrap(); // (2)
201 let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
202 // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
203 check_added_monitors!(nodes[0], 1);
205 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg).unwrap(); // deliver (2)
206 check_added_monitors!(nodes[1], 1);
208 // We can't continue, sadly, because our (1) now has a bogus signature
212 fn test_multi_flight_update_fee() {
213 let nodes = create_network(2);
214 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
215 let channel_id = chan.2;
218 // update_fee/commitment_signed ->
219 // .- send (1) RAA and (2) commitment_signed
220 // update_fee (never committed) ->
222 // We have to manually generate the above update_fee, it is allowed by the protocol but we
223 // don't track which updates correspond to which revoke_and_ack responses so we're in
224 // AwaitingRAA mode and will not generate the update_fee yet.
225 // <- (1) RAA delivered
226 // (3) is generated and send (4) CS -.
227 // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
228 // know the per_commitment_point to use for it.
229 // <- (2) commitment_signed delivered
231 // B should send no response here
232 // (4) commitment_signed delivered ->
233 // <- RAA/commitment_signed delivered
236 // First nodes[0] generates an update_fee
237 let initial_feerate = get_feerate!(nodes[0], channel_id);
238 nodes[0].node.update_fee(channel_id, initial_feerate + 20).unwrap();
239 check_added_monitors!(nodes[0], 1);
241 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
242 assert_eq!(events_0.len(), 1);
243 let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
244 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
245 (update_fee.as_ref().unwrap(), commitment_signed)
247 _ => panic!("Unexpected event"),
250 // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
251 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1).unwrap();
252 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1).unwrap();
253 let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
254 check_added_monitors!(nodes[1], 1);
256 // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
258 nodes[0].node.update_fee(channel_id, initial_feerate + 40).unwrap();
259 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
260 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
262 // Create the (3) update_fee message that nodes[0] will generate before it does...
263 let mut update_msg_2 = msgs::UpdateFee {
264 channel_id: update_msg_1.channel_id.clone(),
265 feerate_per_kw: (initial_feerate + 30) as u32,
268 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2).unwrap();
270 update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
272 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2).unwrap();
274 // Deliver (1), generating (3) and (4)
275 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg).unwrap();
276 let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
277 check_added_monitors!(nodes[0], 1);
278 assert!(as_second_update.update_add_htlcs.is_empty());
279 assert!(as_second_update.update_fulfill_htlcs.is_empty());
280 assert!(as_second_update.update_fail_htlcs.is_empty());
281 assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
282 // Check that the update_fee newly generated matches what we delivered:
283 assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
284 assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
286 // Deliver (2) commitment_signed
287 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed).unwrap();
288 let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
289 check_added_monitors!(nodes[0], 1);
290 // No commitment_signed so get_event_msg's assert(len == 1) passes
292 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg).unwrap();
293 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
294 check_added_monitors!(nodes[1], 1);
297 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed).unwrap();
298 let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
299 check_added_monitors!(nodes[1], 1);
301 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke).unwrap();
302 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
303 check_added_monitors!(nodes[0], 1);
305 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment).unwrap();
306 let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
307 // No commitment_signed so get_event_msg's assert(len == 1) passes
308 check_added_monitors!(nodes[0], 1);
310 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke).unwrap();
311 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
312 check_added_monitors!(nodes[1], 1);
316 fn test_update_fee_vanilla() {
317 let nodes = create_network(2);
318 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
319 let channel_id = chan.2;
321 let feerate = get_feerate!(nodes[0], channel_id);
322 nodes[0].node.update_fee(channel_id, feerate+25).unwrap();
323 check_added_monitors!(nodes[0], 1);
325 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
326 assert_eq!(events_0.len(), 1);
327 let (update_msg, commitment_signed) = match events_0[0] {
328 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 } } => {
329 (update_fee.as_ref(), commitment_signed)
331 _ => panic!("Unexpected event"),
333 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
335 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
336 let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
337 check_added_monitors!(nodes[1], 1);
339 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg).unwrap();
340 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
341 check_added_monitors!(nodes[0], 1);
343 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed).unwrap();
344 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
345 // No commitment_signed so get_event_msg's assert(len == 1) passes
346 check_added_monitors!(nodes[0], 1);
348 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg).unwrap();
349 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
350 check_added_monitors!(nodes[1], 1);
354 fn test_update_fee_that_funder_cannot_afford() {
355 let nodes = create_network(2);
356 let channel_value = 1888;
357 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000);
358 let channel_id = chan.2;
361 nodes[0].node.update_fee(channel_id, feerate).unwrap();
362 check_added_monitors!(nodes[0], 1);
363 let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
365 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap()).unwrap();
367 commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
369 //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
370 //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
372 let chan_lock = nodes[1].node.channel_state.lock().unwrap();
373 let chan = chan_lock.by_id.get(&channel_id).unwrap();
375 //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
376 let num_htlcs = chan.last_local_commitment_txn[0].output.len() - 2;
377 let total_fee: u64 = feerate * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
378 let mut actual_fee = chan.last_local_commitment_txn[0].output.iter().fold(0, |acc, output| acc + output.value);
379 actual_fee = channel_value - actual_fee;
380 assert_eq!(total_fee, actual_fee);
383 //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
384 //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
385 nodes[0].node.update_fee(channel_id, feerate+2).unwrap();
386 check_added_monitors!(nodes[0], 1);
388 let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
390 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap()).unwrap();
392 //While producing the commitment_signed response after handling a received update_fee request the
393 //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
394 //Should produce and error.
395 let err = nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed).unwrap_err();
397 assert!(match err.err {
398 "Funding remote cannot afford proposed new fee" => true,
402 //clear the message we could not handle
403 nodes[1].node.get_and_clear_pending_msg_events();
407 fn test_update_fee_with_fundee_update_add_htlc() {
408 let mut nodes = create_network(2);
409 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
410 let channel_id = chan.2;
413 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
415 let feerate = get_feerate!(nodes[0], channel_id);
416 nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
417 check_added_monitors!(nodes[0], 1);
419 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
420 assert_eq!(events_0.len(), 1);
421 let (update_msg, commitment_signed) = match events_0[0] {
422 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 } } => {
423 (update_fee.as_ref(), commitment_signed)
425 _ => panic!("Unexpected event"),
427 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
428 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
429 let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
430 check_added_monitors!(nodes[1], 1);
432 let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 800000, TEST_FINAL_CLTV).unwrap();
434 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[1]);
436 // nothing happens since node[1] is in AwaitingRemoteRevoke
437 nodes[1].node.send_payment(route, our_payment_hash).unwrap();
439 let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
440 assert_eq!(added_monitors.len(), 0);
441 added_monitors.clear();
443 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
444 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
445 // node[1] has nothing to do
447 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg).unwrap();
448 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
449 check_added_monitors!(nodes[0], 1);
451 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed).unwrap();
452 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
453 // No commitment_signed so get_event_msg's assert(len == 1) passes
454 check_added_monitors!(nodes[0], 1);
455 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg).unwrap();
456 check_added_monitors!(nodes[1], 1);
457 // AwaitingRemoteRevoke ends here
459 let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
460 assert_eq!(commitment_update.update_add_htlcs.len(), 1);
461 assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
462 assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
463 assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
464 assert_eq!(commitment_update.update_fee.is_none(), true);
466 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]).unwrap();
467 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed).unwrap();
468 check_added_monitors!(nodes[0], 1);
469 let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
471 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke).unwrap();
472 check_added_monitors!(nodes[1], 1);
473 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
475 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed).unwrap();
476 check_added_monitors!(nodes[1], 1);
477 let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
478 // No commitment_signed so get_event_msg's assert(len == 1) passes
480 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke).unwrap();
481 check_added_monitors!(nodes[0], 1);
482 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
484 expect_pending_htlcs_forwardable!(nodes[0]);
486 let events = nodes[0].node.get_and_clear_pending_events();
487 assert_eq!(events.len(), 1);
489 Event::PaymentReceived { .. } => { },
490 _ => panic!("Unexpected event"),
493 claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage);
495 send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000);
496 send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000);
497 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
501 fn test_update_fee() {
502 let nodes = create_network(2);
503 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
504 let channel_id = chan.2;
507 // (1) update_fee/commitment_signed ->
508 // <- (2) revoke_and_ack
509 // .- send (3) commitment_signed
510 // (4) update_fee/commitment_signed ->
511 // .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
512 // <- (3) commitment_signed delivered
513 // send (6) revoke_and_ack -.
514 // <- (5) deliver revoke_and_ack
515 // (6) deliver revoke_and_ack ->
516 // .- send (7) commitment_signed in response to (4)
517 // <- (7) deliver commitment_signed
520 // Create and deliver (1)...
521 let feerate = get_feerate!(nodes[0], channel_id);
522 nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
523 check_added_monitors!(nodes[0], 1);
525 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
526 assert_eq!(events_0.len(), 1);
527 let (update_msg, commitment_signed) = match events_0[0] {
528 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 } } => {
529 (update_fee.as_ref(), commitment_signed)
531 _ => panic!("Unexpected event"),
533 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
535 // Generate (2) and (3):
536 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
537 let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
538 check_added_monitors!(nodes[1], 1);
541 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg).unwrap();
542 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
543 check_added_monitors!(nodes[0], 1);
545 // Create and deliver (4)...
546 nodes[0].node.update_fee(channel_id, feerate+30).unwrap();
547 check_added_monitors!(nodes[0], 1);
548 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
549 assert_eq!(events_0.len(), 1);
550 let (update_msg, commitment_signed) = match events_0[0] {
551 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 } } => {
552 (update_fee.as_ref(), commitment_signed)
554 _ => panic!("Unexpected event"),
557 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
558 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
559 check_added_monitors!(nodes[1], 1);
561 let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
562 // No commitment_signed so get_event_msg's assert(len == 1) passes
564 // Handle (3), creating (6):
565 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0).unwrap();
566 check_added_monitors!(nodes[0], 1);
567 let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
568 // No commitment_signed so get_event_msg's assert(len == 1) passes
571 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg).unwrap();
572 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
573 check_added_monitors!(nodes[0], 1);
575 // Deliver (6), creating (7):
576 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0).unwrap();
577 let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
578 assert!(commitment_update.update_add_htlcs.is_empty());
579 assert!(commitment_update.update_fulfill_htlcs.is_empty());
580 assert!(commitment_update.update_fail_htlcs.is_empty());
581 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
582 assert!(commitment_update.update_fee.is_none());
583 check_added_monitors!(nodes[1], 1);
586 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed).unwrap();
587 check_added_monitors!(nodes[0], 1);
588 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
589 // No commitment_signed so get_event_msg's assert(len == 1) passes
591 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg).unwrap();
592 check_added_monitors!(nodes[1], 1);
593 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
595 assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
596 assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
597 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
601 fn pre_funding_lock_shutdown_test() {
602 // Test sending a shutdown prior to funding_locked after funding generation
603 let nodes = create_network(2);
604 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0);
605 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
606 nodes[0].chain_monitor.block_connected_checked(&header, 1, &[&tx; 1], &[1; 1]);
607 nodes[1].chain_monitor.block_connected_checked(&header, 1, &[&tx; 1], &[1; 1]);
609 nodes[0].node.close_channel(&OutPoint::new(tx.txid(), 0).to_channel_id()).unwrap();
610 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
611 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown).unwrap();
612 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
613 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown).unwrap();
615 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
616 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed).unwrap();
617 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
618 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap()).unwrap();
619 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
620 assert!(node_0_none.is_none());
622 assert!(nodes[0].node.list_channels().is_empty());
623 assert!(nodes[1].node.list_channels().is_empty());
627 fn updates_shutdown_wait() {
628 // Test sending a shutdown with outstanding updates pending
629 let mut nodes = create_network(3);
630 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
631 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
632 let route_1 = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
633 let route_2 = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
635 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
637 nodes[0].node.close_channel(&chan_1.2).unwrap();
638 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
639 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown).unwrap();
640 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
641 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown).unwrap();
643 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
644 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
646 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
647 if let Err(APIError::ChannelUnavailable {..}) = nodes[0].node.send_payment(route_1, payment_hash) {}
648 else { panic!("New sends should fail!") };
649 if let Err(APIError::ChannelUnavailable {..}) = nodes[1].node.send_payment(route_2, payment_hash) {}
650 else { panic!("New sends should fail!") };
652 assert!(nodes[2].node.claim_funds(our_payment_preimage));
653 check_added_monitors!(nodes[2], 1);
654 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
655 assert!(updates.update_add_htlcs.is_empty());
656 assert!(updates.update_fail_htlcs.is_empty());
657 assert!(updates.update_fail_malformed_htlcs.is_empty());
658 assert!(updates.update_fee.is_none());
659 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
660 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]).unwrap();
661 check_added_monitors!(nodes[1], 1);
662 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
663 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
665 assert!(updates_2.update_add_htlcs.is_empty());
666 assert!(updates_2.update_fail_htlcs.is_empty());
667 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
668 assert!(updates_2.update_fee.is_none());
669 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
670 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]).unwrap();
671 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
673 let events = nodes[0].node.get_and_clear_pending_events();
674 assert_eq!(events.len(), 1);
676 Event::PaymentSent { ref payment_preimage } => {
677 assert_eq!(our_payment_preimage, *payment_preimage);
679 _ => panic!("Unexpected event"),
682 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
683 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed).unwrap();
684 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
685 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap()).unwrap();
686 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
687 assert!(node_0_none.is_none());
689 assert!(nodes[0].node.list_channels().is_empty());
691 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
692 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
693 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
694 assert!(nodes[1].node.list_channels().is_empty());
695 assert!(nodes[2].node.list_channels().is_empty());
699 fn htlc_fail_async_shutdown() {
700 // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
701 let mut nodes = create_network(3);
702 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
703 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
705 let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
706 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
707 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
708 check_added_monitors!(nodes[0], 1);
709 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
710 assert_eq!(updates.update_add_htlcs.len(), 1);
711 assert!(updates.update_fulfill_htlcs.is_empty());
712 assert!(updates.update_fail_htlcs.is_empty());
713 assert!(updates.update_fail_malformed_htlcs.is_empty());
714 assert!(updates.update_fee.is_none());
716 nodes[1].node.close_channel(&chan_1.2).unwrap();
717 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
718 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown).unwrap();
719 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
721 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]).unwrap();
722 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed).unwrap();
723 check_added_monitors!(nodes[1], 1);
724 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown).unwrap();
725 commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
727 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
728 assert!(updates_2.update_add_htlcs.is_empty());
729 assert!(updates_2.update_fulfill_htlcs.is_empty());
730 assert_eq!(updates_2.update_fail_htlcs.len(), 1);
731 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
732 assert!(updates_2.update_fee.is_none());
734 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]).unwrap();
735 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
737 let events = nodes[0].node.get_and_clear_pending_events();
738 assert_eq!(events.len(), 1);
740 Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } => {
741 assert_eq!(our_payment_hash, *payment_hash);
742 assert!(!rejected_by_dest);
744 _ => panic!("Unexpected event"),
747 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
748 assert_eq!(msg_events.len(), 2);
749 let node_0_closing_signed = match msg_events[0] {
750 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
751 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
754 _ => panic!("Unexpected event"),
756 match msg_events[1] {
757 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
758 assert_eq!(msg.contents.short_channel_id, chan_1.0.contents.short_channel_id);
760 _ => panic!("Unexpected event"),
763 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
764 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed).unwrap();
765 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
766 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap()).unwrap();
767 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
768 assert!(node_0_none.is_none());
770 assert!(nodes[0].node.list_channels().is_empty());
772 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
773 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
774 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
775 assert!(nodes[1].node.list_channels().is_empty());
776 assert!(nodes[2].node.list_channels().is_empty());
779 fn do_test_shutdown_rebroadcast(recv_count: u8) {
780 // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
781 // messages delivered prior to disconnect
782 let nodes = create_network(3);
783 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
784 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
786 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
788 nodes[1].node.close_channel(&chan_1.2).unwrap();
789 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
791 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown).unwrap();
792 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
794 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown).unwrap();
798 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
799 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
801 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
802 let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
803 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
804 let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
806 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish).unwrap();
807 let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
808 assert!(node_1_shutdown == node_1_2nd_shutdown);
810 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish).unwrap();
811 let node_0_2nd_shutdown = if recv_count > 0 {
812 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
813 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown).unwrap();
816 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
817 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown).unwrap();
818 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
820 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_2nd_shutdown).unwrap();
822 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
823 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
825 assert!(nodes[2].node.claim_funds(our_payment_preimage));
826 check_added_monitors!(nodes[2], 1);
827 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
828 assert!(updates.update_add_htlcs.is_empty());
829 assert!(updates.update_fail_htlcs.is_empty());
830 assert!(updates.update_fail_malformed_htlcs.is_empty());
831 assert!(updates.update_fee.is_none());
832 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
833 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]).unwrap();
834 check_added_monitors!(nodes[1], 1);
835 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
836 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
838 assert!(updates_2.update_add_htlcs.is_empty());
839 assert!(updates_2.update_fail_htlcs.is_empty());
840 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
841 assert!(updates_2.update_fee.is_none());
842 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
843 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]).unwrap();
844 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
846 let events = nodes[0].node.get_and_clear_pending_events();
847 assert_eq!(events.len(), 1);
849 Event::PaymentSent { ref payment_preimage } => {
850 assert_eq!(our_payment_preimage, *payment_preimage);
852 _ => panic!("Unexpected event"),
855 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
857 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed).unwrap();
858 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
859 assert!(node_1_closing_signed.is_some());
862 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
863 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
865 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
866 let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
867 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
869 // If all closing_signeds weren't delivered we can just resume where we left off...
870 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
872 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish).unwrap();
873 let node_0_3rd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
874 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
876 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish).unwrap();
877 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
878 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
880 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_3rd_shutdown).unwrap();
881 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
883 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_3rd_shutdown).unwrap();
884 let node_0_2nd_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
885 assert!(node_0_closing_signed == node_0_2nd_closing_signed);
887 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed).unwrap();
888 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
889 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap()).unwrap();
890 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
891 assert!(node_0_none.is_none());
893 // If one node, however, received + responded with an identical closing_signed we end
894 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
895 // There isn't really anything better we can do simply, but in the future we might
896 // explore storing a set of recently-closed channels that got disconnected during
897 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
898 // give our counterparty enough time to (potentially) broadcast a cooperative closing
900 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
902 if let Err(msgs::HandleError{action: Some(msgs::ErrorAction::SendErrorMessage{msg}), ..}) =
903 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish) {
904 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msg);
905 let msgs::ErrorMessage {ref channel_id, ..} = msg;
906 assert_eq!(*channel_id, chan_1.2);
907 } else { panic!("Needed SendErrorMessage close"); }
909 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
910 // checks it, but in this case nodes[0] didn't ever get a chance to receive a
911 // closing_signed so we do it ourselves
912 check_closed_broadcast!(nodes[0]);
915 assert!(nodes[0].node.list_channels().is_empty());
917 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
918 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
919 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
920 assert!(nodes[1].node.list_channels().is_empty());
921 assert!(nodes[2].node.list_channels().is_empty());
925 fn test_shutdown_rebroadcast() {
926 do_test_shutdown_rebroadcast(0);
927 do_test_shutdown_rebroadcast(1);
928 do_test_shutdown_rebroadcast(2);
932 fn fake_network_test() {
933 // Simple test which builds a network of ChannelManagers, connects them to each other, and
934 // tests that payments get routed and transactions broadcast in semi-reasonable ways.
935 let nodes = create_network(4);
937 // Create some initial channels
938 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
939 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
940 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3);
942 // Rebalance the network a bit by relaying one payment through all the channels...
943 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
944 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
945 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
946 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
948 // Send some more payments
949 send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000);
950 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000);
951 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000);
953 // Test failure packets
954 let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
955 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
957 // Add a new channel that skips 3
958 let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3);
960 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000);
961 send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000);
962 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
963 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
964 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
965 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
966 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
968 // Do some rebalance loop payments, simultaneously
969 let mut hops = Vec::with_capacity(3);
971 pubkey: nodes[2].node.get_our_node_id(),
972 short_channel_id: chan_2.0.contents.short_channel_id,
974 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
977 pubkey: nodes[3].node.get_our_node_id(),
978 short_channel_id: chan_3.0.contents.short_channel_id,
980 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
983 pubkey: nodes[1].node.get_our_node_id(),
984 short_channel_id: chan_4.0.contents.short_channel_id,
986 cltv_expiry_delta: TEST_FINAL_CLTV,
988 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;
989 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;
990 let payment_preimage_1 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
992 let mut hops = Vec::with_capacity(3);
994 pubkey: nodes[3].node.get_our_node_id(),
995 short_channel_id: chan_4.0.contents.short_channel_id,
997 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
1000 pubkey: nodes[2].node.get_our_node_id(),
1001 short_channel_id: chan_3.0.contents.short_channel_id,
1003 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
1005 hops.push(RouteHop {
1006 pubkey: nodes[1].node.get_our_node_id(),
1007 short_channel_id: chan_2.0.contents.short_channel_id,
1009 cltv_expiry_delta: TEST_FINAL_CLTV,
1011 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;
1012 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;
1013 let payment_hash_2 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1015 // Claim the rebalances...
1016 fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1017 claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1);
1019 // Add a duplicate new channel from 2 to 4
1020 let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3);
1022 // Send some payments across both channels
1023 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1024 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1025 let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1027 route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
1029 //TODO: Test that routes work again here as we've been notified that the channel is full
1031 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3);
1032 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4);
1033 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5);
1035 // Close down the channels...
1036 close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1037 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1038 close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1039 close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1040 close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
1044 fn holding_cell_htlc_counting() {
1045 // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1046 // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1047 // commitment dance rounds.
1048 let mut nodes = create_network(3);
1049 create_announced_chan_between_nodes(&nodes, 0, 1);
1050 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
1052 let mut payments = Vec::new();
1053 for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1054 let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
1055 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1056 nodes[1].node.send_payment(route, payment_hash).unwrap();
1057 payments.push((payment_preimage, payment_hash));
1059 check_added_monitors!(nodes[1], 1);
1061 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1062 assert_eq!(events.len(), 1);
1063 let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1064 assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1066 // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1067 // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1069 let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
1070 let (_, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
1071 if let APIError::ChannelUnavailable { err } = nodes[1].node.send_payment(route, payment_hash_1).unwrap_err() {
1072 assert_eq!(err, "Cannot push more than their max accepted HTLCs");
1073 } else { panic!("Unexpected event"); }
1075 // This should also be true if we try to forward a payment.
1076 let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
1077 let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
1078 nodes[0].node.send_payment(route, payment_hash_2).unwrap();
1079 check_added_monitors!(nodes[0], 1);
1081 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1082 assert_eq!(events.len(), 1);
1083 let payment_event = SendEvent::from_event(events.pop().unwrap());
1084 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1086 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
1087 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1088 // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1089 // fails), the second will process the resulting failure and fail the HTLC backward.
1090 expect_pending_htlcs_forwardable!(nodes[1]);
1091 expect_pending_htlcs_forwardable!(nodes[1]);
1092 check_added_monitors!(nodes[1], 1);
1094 let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1095 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]).unwrap();
1096 commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1098 let events = nodes[0].node.get_and_clear_pending_msg_events();
1099 assert_eq!(events.len(), 1);
1101 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
1102 assert_eq!(msg.contents.short_channel_id, chan_2.0.contents.short_channel_id);
1104 _ => panic!("Unexpected event"),
1107 let events = nodes[0].node.get_and_clear_pending_events();
1108 assert_eq!(events.len(), 1);
1110 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
1111 assert_eq!(payment_hash, payment_hash_2);
1112 assert!(!rejected_by_dest);
1114 _ => panic!("Unexpected event"),
1117 // Now forward all the pending HTLCs and claim them back
1118 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]).unwrap();
1119 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg).unwrap();
1120 check_added_monitors!(nodes[2], 1);
1122 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1123 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
1124 check_added_monitors!(nodes[1], 1);
1125 let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1127 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed).unwrap();
1128 check_added_monitors!(nodes[1], 1);
1129 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1131 for ref update in as_updates.update_add_htlcs.iter() {
1132 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update).unwrap();
1134 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed).unwrap();
1135 check_added_monitors!(nodes[2], 1);
1136 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa).unwrap();
1137 check_added_monitors!(nodes[2], 1);
1138 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1140 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
1141 check_added_monitors!(nodes[1], 1);
1142 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed).unwrap();
1143 check_added_monitors!(nodes[1], 1);
1144 let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1146 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa).unwrap();
1147 check_added_monitors!(nodes[2], 1);
1149 expect_pending_htlcs_forwardable!(nodes[2]);
1151 let events = nodes[2].node.get_and_clear_pending_events();
1152 assert_eq!(events.len(), payments.len());
1153 for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1155 &Event::PaymentReceived { ref payment_hash, .. } => {
1156 assert_eq!(*payment_hash, *hash);
1158 _ => panic!("Unexpected event"),
1162 for (preimage, _) in payments.drain(..) {
1163 claim_payment(&nodes[1], &[&nodes[2]], preimage);
1166 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
1170 fn duplicate_htlc_test() {
1171 // Test that we accept duplicate payment_hash HTLCs across the network and that
1172 // claiming/failing them are all separate and don't affect each other
1173 let mut nodes = create_network(6);
1175 // Create some initial channels to route via 3 to 4/5 from 0/1/2
1176 create_announced_chan_between_nodes(&nodes, 0, 3);
1177 create_announced_chan_between_nodes(&nodes, 1, 3);
1178 create_announced_chan_between_nodes(&nodes, 2, 3);
1179 create_announced_chan_between_nodes(&nodes, 3, 4);
1180 create_announced_chan_between_nodes(&nodes, 3, 5);
1182 let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1184 *nodes[0].network_payment_count.borrow_mut() -= 1;
1185 assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1187 *nodes[0].network_payment_count.borrow_mut() -= 1;
1188 assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1190 claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage);
1191 fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1192 claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage);
1195 fn do_channel_reserve_test(test_recv: bool) {
1197 use std::sync::atomic::Ordering;
1198 use ln::msgs::HandleError;
1200 let mut nodes = create_network(3);
1201 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1900, 1001);
1202 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1900, 1001);
1204 let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1205 let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1207 let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1208 let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1210 macro_rules! get_route_and_payment_hash {
1211 ($recv_value: expr) => {{
1212 let route = nodes[0].router.get_route(&nodes.last().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV).unwrap();
1213 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1214 (route, payment_hash, payment_preimage)
1218 macro_rules! expect_forward {
1220 let mut events = $node.node.get_and_clear_pending_msg_events();
1221 assert_eq!(events.len(), 1);
1222 check_added_monitors!($node, 1);
1223 let payment_event = SendEvent::from_event(events.remove(0));
1228 let feemsat = 239; // somehow we know?
1229 let total_fee_msat = (nodes.len() - 2) as u64 * 239;
1231 let recv_value_0 = stat01.their_max_htlc_value_in_flight_msat - total_fee_msat;
1233 // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1235 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_0 + 1);
1236 assert!(route.hops.iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1237 let err = nodes[0].node.send_payment(route, our_payment_hash).err().unwrap();
1239 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight"),
1240 _ => panic!("Unknown error variants"),
1244 let mut htlc_id = 0;
1245 // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1246 // nodes[0]'s wealth
1248 let amt_msat = recv_value_0 + total_fee_msat;
1249 if stat01.value_to_self_msat - amt_msat < stat01.channel_reserve_msat {
1252 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0);
1255 let (stat01_, stat11_, stat12_, stat22_) = (
1256 get_channel_value_stat!(nodes[0], chan_1.2),
1257 get_channel_value_stat!(nodes[1], chan_1.2),
1258 get_channel_value_stat!(nodes[1], chan_2.2),
1259 get_channel_value_stat!(nodes[2], chan_2.2),
1262 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1263 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1264 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1265 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1266 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1270 let recv_value = stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat;
1271 // attempt to get channel_reserve violation
1272 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value + 1);
1273 let err = nodes[0].node.send_payment(route.clone(), our_payment_hash).err().unwrap();
1275 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over the reserve value"),
1276 _ => panic!("Unknown error variants"),
1280 // adding pending output
1281 let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat)/2;
1282 let amt_msat_1 = recv_value_1 + total_fee_msat;
1284 let (route_1, our_payment_hash_1, our_payment_preimage_1) = get_route_and_payment_hash!(recv_value_1);
1285 let payment_event_1 = {
1286 nodes[0].node.send_payment(route_1, our_payment_hash_1).unwrap();
1287 check_added_monitors!(nodes[0], 1);
1289 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1290 assert_eq!(events.len(), 1);
1291 SendEvent::from_event(events.remove(0))
1293 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]).unwrap();
1295 // channel reserve test with htlc pending output > 0
1296 let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat;
1298 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
1299 match nodes[0].node.send_payment(route, our_payment_hash).err().unwrap() {
1300 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over the reserve value"),
1301 _ => panic!("Unknown error variants"),
1306 // test channel_reserve test on nodes[1] side
1307 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
1309 // Need to manually create update_add_htlc message to go around the channel reserve check in send_htlc()
1310 let secp_ctx = Secp256k1::new();
1311 let session_priv = SecretKey::from_slice(&{
1312 let mut session_key = [0; 32];
1313 rng::fill_bytes(&mut session_key);
1315 }).expect("RNG is bad!");
1317 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1318 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route, &session_priv).unwrap();
1319 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
1320 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, &our_payment_hash);
1321 let msg = msgs::UpdateAddHTLC {
1322 channel_id: chan_1.2,
1324 amount_msat: htlc_msat,
1325 payment_hash: our_payment_hash,
1326 cltv_expiry: htlc_cltv,
1327 onion_routing_packet: onion_packet,
1331 let err = nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg).err().unwrap();
1333 HandleError{err, .. } => assert_eq!(err, "Remote HTLC add would put them over their reserve value"),
1335 // If we send a garbage message, the channel should get closed, making the rest of this test case fail.
1336 assert_eq!(nodes[1].node.list_channels().len(), 1);
1337 assert_eq!(nodes[1].node.list_channels().len(), 1);
1338 check_closed_broadcast!(nodes[1]);
1343 // split the rest to test holding cell
1344 let recv_value_21 = recv_value_2/2;
1345 let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat;
1347 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
1348 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);
1351 // now see if they go through on both sides
1352 let (route_21, our_payment_hash_21, our_payment_preimage_21) = get_route_and_payment_hash!(recv_value_21);
1353 // but this will stuck in the holding cell
1354 nodes[0].node.send_payment(route_21, our_payment_hash_21).unwrap();
1355 check_added_monitors!(nodes[0], 0);
1356 let events = nodes[0].node.get_and_clear_pending_events();
1357 assert_eq!(events.len(), 0);
1359 // test with outbound holding cell amount > 0
1361 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_22+1);
1362 match nodes[0].node.send_payment(route, our_payment_hash).err().unwrap() {
1363 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over the reserve value"),
1364 _ => panic!("Unknown error variants"),
1368 let (route_22, our_payment_hash_22, our_payment_preimage_22) = get_route_and_payment_hash!(recv_value_22);
1369 // this will also stuck in the holding cell
1370 nodes[0].node.send_payment(route_22, our_payment_hash_22).unwrap();
1371 check_added_monitors!(nodes[0], 0);
1372 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1373 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1375 // flush the pending htlc
1376 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg).unwrap();
1377 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1378 check_added_monitors!(nodes[1], 1);
1380 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
1381 check_added_monitors!(nodes[0], 1);
1382 let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1384 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed).unwrap();
1385 let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1386 // No commitment_signed so get_event_msg's assert(len == 1) passes
1387 check_added_monitors!(nodes[0], 1);
1389 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
1390 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1391 check_added_monitors!(nodes[1], 1);
1393 expect_pending_htlcs_forwardable!(nodes[1]);
1395 let ref payment_event_11 = expect_forward!(nodes[1]);
1396 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]).unwrap();
1397 commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
1399 expect_pending_htlcs_forwardable!(nodes[2]);
1400 expect_payment_received!(nodes[2], our_payment_hash_1, recv_value_1);
1402 // flush the htlcs in the holding cell
1403 assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
1404 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]).unwrap();
1405 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]).unwrap();
1406 commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
1407 expect_pending_htlcs_forwardable!(nodes[1]);
1409 let ref payment_event_3 = expect_forward!(nodes[1]);
1410 assert_eq!(payment_event_3.msgs.len(), 2);
1411 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]).unwrap();
1412 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]).unwrap();
1414 commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
1415 expect_pending_htlcs_forwardable!(nodes[2]);
1417 let events = nodes[2].node.get_and_clear_pending_events();
1418 assert_eq!(events.len(), 2);
1420 Event::PaymentReceived { ref payment_hash, amt } => {
1421 assert_eq!(our_payment_hash_21, *payment_hash);
1422 assert_eq!(recv_value_21, amt);
1424 _ => panic!("Unexpected event"),
1427 Event::PaymentReceived { ref payment_hash, amt } => {
1428 assert_eq!(our_payment_hash_22, *payment_hash);
1429 assert_eq!(recv_value_22, amt);
1431 _ => panic!("Unexpected event"),
1434 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1);
1435 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21);
1436 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22);
1438 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);
1439 let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
1440 assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
1441 assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat);
1443 let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
1444 assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22);
1448 fn channel_reserve_test() {
1449 do_channel_reserve_test(false);
1450 do_channel_reserve_test(true);
1454 fn channel_reserve_in_flight_removes() {
1455 // In cases where one side claims an HTLC, it thinks it has additional available funds that it
1456 // can send to its counterparty, but due to update ordering, the other side may not yet have
1457 // considered those HTLCs fully removed.
1458 // This tests that we don't count HTLCs which will not be included in the next remote
1459 // commitment transaction towards the reserve value (as it implies no commitment transaction
1460 // will be generated which violates the remote reserve value).
1461 // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
1463 // * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
1464 // you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
1465 // you only consider the value of the first HTLC, it may not),
1466 // * start routing a third HTLC from A to B,
1467 // * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
1468 // the other claim in its holding cell, as it immediately goes into AwaitingRAA),
1469 // * deliver the first fulfill from B
1470 // * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
1472 // * deliver A's response CS and RAA.
1473 // This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
1474 // removed it fully. B now has the push_msat plus the first two HTLCs in value.
1475 // * Now B happily sends another HTLC, potentially violating its reserve value from A's point
1476 // of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
1477 let mut nodes = create_network(2);
1478 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
1480 let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
1481 // Route the first two HTLCs.
1482 let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
1483 let (payment_preimage_2, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
1485 // Start routing the third HTLC (this is just used to get everyone in the right state).
1486 let (payment_preimage_3, payment_hash_3) = get_payment_preimage_hash!(nodes[0]);
1488 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
1489 nodes[0].node.send_payment(route, payment_hash_3).unwrap();
1490 check_added_monitors!(nodes[0], 1);
1491 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1492 assert_eq!(events.len(), 1);
1493 SendEvent::from_event(events.remove(0))
1496 // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
1497 // initial fulfill/CS.
1498 assert!(nodes[1].node.claim_funds(payment_preimage_1));
1499 check_added_monitors!(nodes[1], 1);
1500 let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1502 // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
1503 // remove the second HTLC when we send the HTLC back from B to A.
1504 assert!(nodes[1].node.claim_funds(payment_preimage_2));
1505 check_added_monitors!(nodes[1], 1);
1506 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1508 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]).unwrap();
1509 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed).unwrap();
1510 check_added_monitors!(nodes[0], 1);
1511 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1512 expect_payment_sent!(nodes[0], payment_preimage_1);
1514 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]).unwrap();
1515 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg).unwrap();
1516 check_added_monitors!(nodes[1], 1);
1517 // B is already AwaitingRAA, so cant generate a CS here
1518 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1520 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa).unwrap();
1521 check_added_monitors!(nodes[1], 1);
1522 let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1524 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa).unwrap();
1525 check_added_monitors!(nodes[0], 1);
1526 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1528 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed).unwrap();
1529 check_added_monitors!(nodes[1], 1);
1530 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1532 // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
1533 // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
1534 // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
1535 // can no longer broadcast a commitment transaction with it and B has the preimage so can go
1536 // on-chain as necessary).
1537 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]).unwrap();
1538 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed).unwrap();
1539 check_added_monitors!(nodes[0], 1);
1540 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1541 expect_payment_sent!(nodes[0], payment_preimage_2);
1543 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa).unwrap();
1544 check_added_monitors!(nodes[1], 1);
1545 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1547 expect_pending_htlcs_forwardable!(nodes[1]);
1548 expect_payment_received!(nodes[1], payment_hash_3, 100000);
1550 // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
1551 // resolve the second HTLC from A's point of view.
1552 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa).unwrap();
1553 check_added_monitors!(nodes[0], 1);
1554 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1556 // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
1557 // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
1558 let (payment_preimage_4, payment_hash_4) = get_payment_preimage_hash!(nodes[1]);
1560 let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &[], 10000, TEST_FINAL_CLTV).unwrap();
1561 nodes[1].node.send_payment(route, payment_hash_4).unwrap();
1562 check_added_monitors!(nodes[1], 1);
1563 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1564 assert_eq!(events.len(), 1);
1565 SendEvent::from_event(events.remove(0))
1568 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]).unwrap();
1569 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg).unwrap();
1570 check_added_monitors!(nodes[0], 1);
1571 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1573 // Now just resolve all the outstanding messages/HTLCs for completeness...
1575 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed).unwrap();
1576 check_added_monitors!(nodes[1], 1);
1577 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1579 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa).unwrap();
1580 check_added_monitors!(nodes[1], 1);
1582 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa).unwrap();
1583 check_added_monitors!(nodes[0], 1);
1584 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1586 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed).unwrap();
1587 check_added_monitors!(nodes[1], 1);
1588 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1590 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa).unwrap();
1591 check_added_monitors!(nodes[0], 1);
1593 expect_pending_htlcs_forwardable!(nodes[0]);
1594 expect_payment_received!(nodes[0], payment_hash_4, 10000);
1596 claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4);
1597 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3);
1601 fn channel_monitor_network_test() {
1602 // Simple test which builds a network of ChannelManagers, connects them to each other, and
1603 // tests that ChannelMonitor is able to recover from various states.
1604 let nodes = create_network(5);
1606 // Create some initial channels
1607 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
1608 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
1609 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3);
1610 let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4);
1612 // Rebalance the network a bit by relaying one payment through all the channels...
1613 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
1614 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
1615 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
1616 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
1618 // Simple case with no pending HTLCs:
1619 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
1621 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
1622 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1623 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
1624 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
1626 get_announce_close_broadcast_events(&nodes, 0, 1);
1627 assert_eq!(nodes[0].node.list_channels().len(), 0);
1628 assert_eq!(nodes[1].node.list_channels().len(), 1);
1630 // One pending HTLC is discarded by the force-close:
1631 let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
1633 // Simple case of one pending HTLC to HTLC-Timeout
1634 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
1636 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
1637 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1638 nodes[2].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
1639 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
1641 get_announce_close_broadcast_events(&nodes, 1, 2);
1642 assert_eq!(nodes[1].node.list_channels().len(), 0);
1643 assert_eq!(nodes[2].node.list_channels().len(), 1);
1645 macro_rules! claim_funds {
1646 ($node: expr, $prev_node: expr, $preimage: expr) => {
1648 assert!($node.node.claim_funds($preimage));
1649 check_added_monitors!($node, 1);
1651 let events = $node.node.get_and_clear_pending_msg_events();
1652 assert_eq!(events.len(), 1);
1654 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
1655 assert!(update_add_htlcs.is_empty());
1656 assert!(update_fail_htlcs.is_empty());
1657 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
1659 _ => panic!("Unexpected event"),
1665 // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
1666 // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
1667 nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
1669 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
1671 // Claim the payment on nodes[3], giving it knowledge of the preimage
1672 claim_funds!(nodes[3], nodes[2], payment_preimage_1);
1674 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1675 nodes[3].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, 1);
1677 check_preimage_claim(&nodes[3], &node_txn);
1679 get_announce_close_broadcast_events(&nodes, 2, 3);
1680 assert_eq!(nodes[2].node.list_channels().len(), 0);
1681 assert_eq!(nodes[3].node.list_channels().len(), 1);
1683 { // Cheat and reset nodes[4]'s height to 1
1684 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1685 nodes[4].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![] }, 1);
1688 assert_eq!(nodes[3].node.latest_block_height.load(Ordering::Acquire), 1);
1689 assert_eq!(nodes[4].node.latest_block_height.load(Ordering::Acquire), 1);
1690 // One pending HTLC to time out:
1691 let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
1692 // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
1696 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1697 nodes[3].chain_monitor.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
1698 for i in 3..TEST_FINAL_CLTV + 2 + HTLC_FAIL_TIMEOUT_BLOCKS + 1 {
1699 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1700 nodes[3].chain_monitor.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
1703 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
1705 // Claim the payment on nodes[4], giving it knowledge of the preimage
1706 claim_funds!(nodes[4], nodes[3], payment_preimage_2);
1708 header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1709 nodes[4].chain_monitor.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
1710 for i in 3..TEST_FINAL_CLTV + 2 - CLTV_CLAIM_BUFFER + 1 {
1711 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1712 nodes[4].chain_monitor.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
1715 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
1717 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1718 nodes[4].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, TEST_FINAL_CLTV - 5);
1720 check_preimage_claim(&nodes[4], &node_txn);
1722 get_announce_close_broadcast_events(&nodes, 3, 4);
1723 assert_eq!(nodes[3].node.list_channels().len(), 0);
1724 assert_eq!(nodes[4].node.list_channels().len(), 0);
1728 fn test_justice_tx() {
1729 // Test justice txn built on revoked HTLC-Success tx, against both sides
1731 let nodes = create_network(2);
1732 // Create some new channels:
1733 let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1);
1735 // A pending HTLC which will be revoked:
1736 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
1737 // Get the will-be-revoked local txn from nodes[0]
1738 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.iter().next().unwrap().1.last_local_commitment_txn.clone();
1739 assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
1740 assert_eq!(revoked_local_txn[0].input.len(), 1);
1741 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
1742 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
1743 assert_eq!(revoked_local_txn[1].input.len(), 1);
1744 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
1745 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
1746 // Revoke the old state
1747 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
1750 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1751 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
1753 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
1754 assert_eq!(node_txn.len(), 3);
1755 assert_eq!(node_txn.pop().unwrap(), node_txn[0]); // An outpoint registration will result in a 2nd block_connected
1756 assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
1758 check_spends!(node_txn[0], revoked_local_txn[0].clone());
1759 node_txn.swap_remove(0);
1761 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
1763 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
1764 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
1765 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1766 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
1767 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone());
1769 get_announce_close_broadcast_events(&nodes, 0, 1);
1771 assert_eq!(nodes[0].node.list_channels().len(), 0);
1772 assert_eq!(nodes[1].node.list_channels().len(), 0);
1774 // We test justice_tx build by A on B's revoked HTLC-Success tx
1775 // Create some new channels:
1776 let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1);
1778 // A pending HTLC which will be revoked:
1779 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
1780 // Get the will-be-revoked local txn from B
1781 let revoked_local_txn = nodes[1].node.channel_state.lock().unwrap().by_id.iter().next().unwrap().1.last_local_commitment_txn.clone();
1782 assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
1783 assert_eq!(revoked_local_txn[0].input.len(), 1);
1784 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
1785 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
1786 // Revoke the old state
1787 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4);
1789 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1790 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
1792 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
1793 assert_eq!(node_txn.len(), 3);
1794 assert_eq!(node_txn.pop().unwrap(), node_txn[0]); // An outpoint registration will result in a 2nd block_connected
1795 assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
1797 check_spends!(node_txn[0], revoked_local_txn[0].clone());
1798 node_txn.swap_remove(0);
1800 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
1802 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
1803 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
1804 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1805 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
1806 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone());
1808 get_announce_close_broadcast_events(&nodes, 0, 1);
1809 assert_eq!(nodes[0].node.list_channels().len(), 0);
1810 assert_eq!(nodes[1].node.list_channels().len(), 0);
1814 fn revoked_output_claim() {
1815 // Simple test to ensure a node will claim a revoked output when a stale remote commitment
1816 // transaction is broadcast by its counterparty
1817 let nodes = create_network(2);
1818 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
1819 // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
1820 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
1821 assert_eq!(revoked_local_txn.len(), 1);
1822 // Only output is the full channel value back to nodes[0]:
1823 assert_eq!(revoked_local_txn[0].output.len(), 1);
1824 // Send a payment through, updating everyone's latest commitment txn
1825 send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000);
1827 // Inform nodes[1] that nodes[0] broadcast a stale tx
1828 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1829 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
1830 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
1831 assert_eq!(node_txn.len(), 3); // nodes[1] will broadcast justice tx twice, and its own local state once
1833 assert_eq!(node_txn[0], node_txn[2]);
1835 check_spends!(node_txn[0], revoked_local_txn[0].clone());
1836 check_spends!(node_txn[1], chan_1.3.clone());
1838 // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
1839 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
1840 get_announce_close_broadcast_events(&nodes, 0, 1);
1844 fn claim_htlc_outputs_shared_tx() {
1845 // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
1846 let nodes = create_network(2);
1848 // Create some new channel:
1849 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
1851 // Rebalance the network to generate htlc in the two directions
1852 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
1853 // 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
1854 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
1855 let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
1857 // Get the will-be-revoked local txn from node[0]
1858 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
1859 assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
1860 assert_eq!(revoked_local_txn[0].input.len(), 1);
1861 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
1862 assert_eq!(revoked_local_txn[1].input.len(), 1);
1863 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
1864 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
1865 check_spends!(revoked_local_txn[1], revoked_local_txn[0].clone());
1867 //Revoke the old state
1868 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
1871 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1872 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
1873 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
1875 let events = nodes[1].node.get_and_clear_pending_events();
1876 assert_eq!(events.len(), 1);
1878 Event::PaymentFailed { payment_hash, .. } => {
1879 assert_eq!(payment_hash, payment_hash_2);
1881 _ => panic!("Unexpected event"),
1884 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
1885 assert_eq!(node_txn.len(), 4);
1887 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
1888 check_spends!(node_txn[0], revoked_local_txn[0].clone());
1890 assert_eq!(node_txn[0], node_txn[3]); // justice tx is duplicated due to block re-scanning
1892 let mut witness_lens = BTreeSet::new();
1893 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
1894 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
1895 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
1896 assert_eq!(witness_lens.len(), 3);
1897 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
1898 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
1899 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
1901 // Next nodes[1] broadcasts its current local tx state:
1902 assert_eq!(node_txn[1].input.len(), 1);
1903 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
1905 assert_eq!(node_txn[2].input.len(), 1);
1906 let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
1907 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
1908 assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
1909 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
1910 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
1912 get_announce_close_broadcast_events(&nodes, 0, 1);
1913 assert_eq!(nodes[0].node.list_channels().len(), 0);
1914 assert_eq!(nodes[1].node.list_channels().len(), 0);
1918 fn claim_htlc_outputs_single_tx() {
1919 // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
1920 let nodes = create_network(2);
1922 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
1924 // Rebalance the network to generate htlc in the two directions
1925 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
1926 // 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
1927 // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
1928 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
1929 let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
1931 // Get the will-be-revoked local txn from node[0]
1932 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
1934 //Revoke the old state
1935 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
1938 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1939 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
1940 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
1942 let events = nodes[1].node.get_and_clear_pending_events();
1943 assert_eq!(events.len(), 1);
1945 Event::PaymentFailed { payment_hash, .. } => {
1946 assert_eq!(payment_hash, payment_hash_2);
1948 _ => panic!("Unexpected event"),
1951 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
1952 assert_eq!(node_txn.len(), 12); // ChannelManager : 2, ChannelMontitor: 8 (1 standard revoked output, 2 revocation htlc tx, 1 local commitment tx + 1 htlc timeout tx) * 2 (block-rescan)
1954 assert_eq!(node_txn[0], node_txn[7]);
1955 assert_eq!(node_txn[1], node_txn[8]);
1956 assert_eq!(node_txn[2], node_txn[9]);
1957 assert_eq!(node_txn[3], node_txn[10]);
1958 assert_eq!(node_txn[4], node_txn[11]);
1959 assert_eq!(node_txn[3], node_txn[5]); //local commitment tx + htlc timeout tx broadcasted by ChannelManger
1960 assert_eq!(node_txn[4], node_txn[6]);
1962 assert_eq!(node_txn[0].input.len(), 1);
1963 assert_eq!(node_txn[1].input.len(), 1);
1964 assert_eq!(node_txn[2].input.len(), 1);
1966 let mut revoked_tx_map = HashMap::new();
1967 revoked_tx_map.insert(revoked_local_txn[0].txid(), revoked_local_txn[0].clone());
1968 node_txn[0].verify(&revoked_tx_map).unwrap();
1969 node_txn[1].verify(&revoked_tx_map).unwrap();
1970 node_txn[2].verify(&revoked_tx_map).unwrap();
1972 let mut witness_lens = BTreeSet::new();
1973 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
1974 witness_lens.insert(node_txn[1].input[0].witness.last().unwrap().len());
1975 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
1976 assert_eq!(witness_lens.len(), 3);
1977 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
1978 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
1979 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
1981 assert_eq!(node_txn[3].input.len(), 1);
1982 check_spends!(node_txn[3], chan_1.3.clone());
1984 assert_eq!(node_txn[4].input.len(), 1);
1985 let witness_script = node_txn[4].input[0].witness.last().unwrap();
1986 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
1987 assert_eq!(node_txn[4].input[0].previous_output.txid, node_txn[3].txid());
1988 assert_ne!(node_txn[4].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
1989 assert_ne!(node_txn[4].input[0].previous_output.txid, node_txn[1].input[0].previous_output.txid);
1991 get_announce_close_broadcast_events(&nodes, 0, 1);
1992 assert_eq!(nodes[0].node.list_channels().len(), 0);
1993 assert_eq!(nodes[1].node.list_channels().len(), 0);
1997 fn test_htlc_on_chain_success() {
1998 // Test that in case of a unilateral close onchain, we detect the state of output thanks to
1999 // ChainWatchInterface and pass the preimage backward accordingly. So here we test that ChannelManager is
2000 // broadcasting the right event to other nodes in payment path.
2001 // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2002 // A --------------------> B ----------------------> C (preimage)
2003 // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2004 // commitment transaction was broadcast.
2005 // Then, B should learn the preimage from said transactions, attempting to claim backwards
2007 // B should be able to claim via preimage if A then broadcasts its local tx.
2008 // Finally, when A sees B's latest local commitment transaction it should be able to claim
2009 // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2010 // PaymentSent event).
2012 let nodes = create_network(3);
2014 // Create some initial channels
2015 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
2016 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
2018 // Rebalance the network a bit by relaying one payment through all the channels...
2019 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2020 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2022 let (our_payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2023 let (our_payment_preimage_2, _payment_hash_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2024 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2026 // Broadcast legit commitment tx from C on B's chain
2027 // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2028 let commitment_tx = nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().last_local_commitment_txn.clone();
2029 assert_eq!(commitment_tx.len(), 1);
2030 check_spends!(commitment_tx[0], chan_2.3.clone());
2031 nodes[2].node.claim_funds(our_payment_preimage);
2032 nodes[2].node.claim_funds(our_payment_preimage_2);
2033 check_added_monitors!(nodes[2], 2);
2034 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2035 assert!(updates.update_add_htlcs.is_empty());
2036 assert!(updates.update_fail_htlcs.is_empty());
2037 assert!(updates.update_fail_malformed_htlcs.is_empty());
2038 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2040 nodes[2].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2041 check_closed_broadcast!(nodes[2]);
2042 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx), ChannelMonitor : 4 (2*2 * HTLC-Success tx)
2043 assert_eq!(node_txn.len(), 5);
2044 assert_eq!(node_txn[0], node_txn[3]);
2045 assert_eq!(node_txn[1], node_txn[4]);
2046 assert_eq!(node_txn[2], commitment_tx[0]);
2047 check_spends!(node_txn[0], commitment_tx[0].clone());
2048 check_spends!(node_txn[1], commitment_tx[0].clone());
2049 assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2050 assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2051 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2052 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2053 assert_eq!(node_txn[0].lock_time, 0);
2054 assert_eq!(node_txn[1].lock_time, 0);
2056 // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2057 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: node_txn}, 1);
2058 let events = nodes[1].node.get_and_clear_pending_msg_events();
2060 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
2061 assert_eq!(added_monitors.len(), 2);
2062 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2063 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2064 added_monitors.clear();
2066 assert_eq!(events.len(), 2);
2068 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2069 _ => panic!("Unexpected event"),
2072 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, .. } } => {
2073 assert!(update_add_htlcs.is_empty());
2074 assert!(update_fail_htlcs.is_empty());
2075 assert_eq!(update_fulfill_htlcs.len(), 1);
2076 assert!(update_fail_malformed_htlcs.is_empty());
2077 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2079 _ => panic!("Unexpected event"),
2081 macro_rules! check_tx_local_broadcast {
2082 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2083 // ChannelManager : 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor : 2 (timeout tx) * 2 (block-rescan)
2084 let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2085 assert_eq!(node_txn.len(), 7);
2086 assert_eq!(node_txn[0], node_txn[5]);
2087 assert_eq!(node_txn[1], node_txn[6]);
2088 check_spends!(node_txn[0], $commitment_tx.clone());
2089 check_spends!(node_txn[1], $commitment_tx.clone());
2090 assert_ne!(node_txn[0].lock_time, 0);
2091 assert_ne!(node_txn[1].lock_time, 0);
2093 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2094 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2095 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2096 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2098 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2099 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2100 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2101 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2103 check_spends!(node_txn[2], $chan_tx.clone());
2104 check_spends!(node_txn[3], node_txn[2].clone());
2105 check_spends!(node_txn[4], node_txn[2].clone());
2106 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), 71);
2107 assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2108 assert_eq!(node_txn[4].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2109 assert!(node_txn[3].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2110 assert!(node_txn[4].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2111 assert_ne!(node_txn[3].lock_time, 0);
2112 assert_ne!(node_txn[4].lock_time, 0);
2116 // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2117 // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2118 // timeout-claim of the output that nodes[2] just claimed via success.
2119 check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2121 // Broadcast legit commitment tx from A on B's chain
2122 // Broadcast preimage tx by B on offered output from A commitment tx on A's chain
2123 let commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
2124 check_spends!(commitment_tx[0], chan_1.3.clone());
2125 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2126 check_closed_broadcast!(nodes[1]);
2127 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx), ChannelMonitor : 1 (HTLC-Success) * 2 (block-rescan)
2128 assert_eq!(node_txn.len(), 3);
2129 assert_eq!(node_txn[0], node_txn[2]);
2130 check_spends!(node_txn[0], commitment_tx[0].clone());
2131 assert_eq!(node_txn[0].input.len(), 2);
2132 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2133 assert_eq!(node_txn[0].input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2134 assert_eq!(node_txn[0].lock_time, 0);
2135 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2136 check_spends!(node_txn[1], chan_1.3.clone());
2137 assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2138 // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2139 // we already checked the same situation with A.
2141 // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2142 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone(), node_txn[0].clone()] }, 1);
2143 check_closed_broadcast!(nodes[0]);
2144 let events = nodes[0].node.get_and_clear_pending_events();
2145 assert_eq!(events.len(), 2);
2146 let mut first_claimed = false;
2147 for event in events {
2149 Event::PaymentSent { payment_preimage } => {
2150 if payment_preimage == our_payment_preimage {
2151 assert!(!first_claimed);
2152 first_claimed = true;
2154 assert_eq!(payment_preimage, our_payment_preimage_2);
2157 _ => panic!("Unexpected event"),
2160 check_tx_local_broadcast!(nodes[0], true, commitment_tx[0], chan_1.3);
2164 fn test_htlc_on_chain_timeout() {
2165 // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2166 // ChainWatchInterface and timeout the HTLC backward accordingly. So here we test that ChannelManager is
2167 // broadcasting the right event to other nodes in payment path.
2168 // A ------------------> B ----------------------> C (timeout)
2169 // B's commitment tx C's commitment tx
2171 // B's HTLC timeout tx B's timeout tx
2173 let nodes = create_network(3);
2175 // Create some intial channels
2176 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
2177 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
2179 // Rebalance the network a bit by relaying one payment thorugh all the channels...
2180 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2181 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2183 let (_payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2184 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2186 // Broadcast legit commitment tx from C on B's chain
2187 let commitment_tx = nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().last_local_commitment_txn.clone();
2188 check_spends!(commitment_tx[0], chan_2.3.clone());
2189 nodes[2].node.fail_htlc_backwards(&payment_hash);
2190 check_added_monitors!(nodes[2], 0);
2191 expect_pending_htlcs_forwardable!(nodes[2]);
2192 check_added_monitors!(nodes[2], 1);
2194 let events = nodes[2].node.get_and_clear_pending_msg_events();
2195 assert_eq!(events.len(), 1);
2197 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, .. } } => {
2198 assert!(update_add_htlcs.is_empty());
2199 assert!(!update_fail_htlcs.is_empty());
2200 assert!(update_fulfill_htlcs.is_empty());
2201 assert!(update_fail_malformed_htlcs.is_empty());
2202 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2204 _ => panic!("Unexpected event"),
2206 nodes[2].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2207 check_closed_broadcast!(nodes[2]);
2208 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2209 assert_eq!(node_txn.len(), 1);
2210 check_spends!(node_txn[0], chan_2.3.clone());
2211 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2213 // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2214 // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2215 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2218 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2219 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)
2220 assert_eq!(node_txn[0], node_txn[5]);
2221 assert_eq!(node_txn[1], node_txn[6]);
2222 assert_eq!(node_txn[2], node_txn[7]);
2223 check_spends!(node_txn[0], commitment_tx[0].clone());
2224 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2225 check_spends!(node_txn[1], chan_2.3.clone());
2226 check_spends!(node_txn[2], node_txn[1].clone());
2227 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2228 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2229 check_spends!(node_txn[3], chan_2.3.clone());
2230 check_spends!(node_txn[4], node_txn[3].clone());
2231 assert_eq!(node_txn[3].input[0].witness.clone().last().unwrap().len(), 71);
2232 assert_eq!(node_txn[4].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2233 timeout_tx = node_txn[0].clone();
2237 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![timeout_tx]}, 1);
2238 check_added_monitors!(nodes[1], 0);
2239 check_closed_broadcast!(nodes[1]);
2241 expect_pending_htlcs_forwardable!(nodes[1]);
2242 check_added_monitors!(nodes[1], 1);
2243 let events = nodes[1].node.get_and_clear_pending_msg_events();
2244 assert_eq!(events.len(), 1);
2246 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, .. } } => {
2247 assert!(update_add_htlcs.is_empty());
2248 assert!(!update_fail_htlcs.is_empty());
2249 assert!(update_fulfill_htlcs.is_empty());
2250 assert!(update_fail_malformed_htlcs.is_empty());
2251 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2253 _ => panic!("Unexpected event"),
2255 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
2256 assert_eq!(node_txn.len(), 0);
2258 // Broadcast legit commitment tx from B on A's chain
2259 let commitment_tx = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
2260 check_spends!(commitment_tx[0], chan_1.3.clone());
2262 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2263 check_closed_broadcast!(nodes[0]);
2264 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
2265 assert_eq!(node_txn.len(), 4);
2266 assert_eq!(node_txn[0], node_txn[3]);
2267 check_spends!(node_txn[0], commitment_tx[0].clone());
2268 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2269 check_spends!(node_txn[1], chan_1.3.clone());
2270 check_spends!(node_txn[2], node_txn[1].clone());
2271 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2272 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2276 fn test_simple_commitment_revoked_fail_backward() {
2277 // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
2278 // and fail backward accordingly.
2280 let nodes = create_network(3);
2282 // Create some initial channels
2283 create_announced_chan_between_nodes(&nodes, 0, 1);
2284 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
2286 let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2287 // Get the will-be-revoked local txn from nodes[2]
2288 let revoked_local_txn = nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().last_local_commitment_txn.clone();
2289 // Revoke the old state
2290 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
2292 route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2294 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2295 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2296 check_added_monitors!(nodes[1], 0);
2297 check_closed_broadcast!(nodes[1]);
2299 expect_pending_htlcs_forwardable!(nodes[1]);
2300 check_added_monitors!(nodes[1], 1);
2301 let events = nodes[1].node.get_and_clear_pending_msg_events();
2302 assert_eq!(events.len(), 1);
2304 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, .. } } => {
2305 assert!(update_add_htlcs.is_empty());
2306 assert_eq!(update_fail_htlcs.len(), 1);
2307 assert!(update_fulfill_htlcs.is_empty());
2308 assert!(update_fail_malformed_htlcs.is_empty());
2309 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2311 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]).unwrap();
2312 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2314 let events = nodes[0].node.get_and_clear_pending_msg_events();
2315 assert_eq!(events.len(), 1);
2317 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
2318 _ => panic!("Unexpected event"),
2320 let events = nodes[0].node.get_and_clear_pending_events();
2321 assert_eq!(events.len(), 1);
2323 Event::PaymentFailed { .. } => {},
2324 _ => panic!("Unexpected event"),
2327 _ => panic!("Unexpected event"),
2331 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
2332 // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
2333 // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
2334 // commitment transaction anymore.
2335 // To do this, we have the peer which will broadcast a revoked commitment transaction send
2336 // a number of update_fail/commitment_signed updates without ever sending the RAA in
2337 // response to our commitment_signed. This is somewhat misbehavior-y, though not
2338 // technically disallowed and we should probably handle it reasonably.
2339 // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
2340 // failed/fulfilled backwards must be in at least one of the latest two remote commitment
2342 // * Once we move it out of our holding cell/add it, we will immediately include it in a
2343 // commitment_signed (implying it will be in the latest remote commitment transaction).
2344 // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
2345 // and once they revoke the previous commitment transaction (allowing us to send a new
2346 // commitment_signed) we will be free to fail/fulfill the HTLC backwards.
2347 let mut nodes = create_network(3);
2349 // Create some initial channels
2350 create_announced_chan_between_nodes(&nodes, 0, 1);
2351 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
2353 let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], if no_to_remote { 10_000 } else { 3_000_000 });
2354 // Get the will-be-revoked local txn from nodes[2]
2355 let revoked_local_txn = nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().last_local_commitment_txn.clone();
2356 assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
2357 // Revoke the old state
2358 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
2360 let value = if use_dust {
2361 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
2362 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
2363 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().our_dust_limit_satoshis * 1000
2366 let (_, first_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2367 let (_, second_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2368 let (_, third_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2370 assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash));
2371 expect_pending_htlcs_forwardable!(nodes[2]);
2372 check_added_monitors!(nodes[2], 1);
2373 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2374 assert!(updates.update_add_htlcs.is_empty());
2375 assert!(updates.update_fulfill_htlcs.is_empty());
2376 assert!(updates.update_fail_malformed_htlcs.is_empty());
2377 assert_eq!(updates.update_fail_htlcs.len(), 1);
2378 assert!(updates.update_fee.is_none());
2379 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]).unwrap();
2380 let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
2381 // Drop the last RAA from 3 -> 2
2383 assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash));
2384 expect_pending_htlcs_forwardable!(nodes[2]);
2385 check_added_monitors!(nodes[2], 1);
2386 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2387 assert!(updates.update_add_htlcs.is_empty());
2388 assert!(updates.update_fulfill_htlcs.is_empty());
2389 assert!(updates.update_fail_malformed_htlcs.is_empty());
2390 assert_eq!(updates.update_fail_htlcs.len(), 1);
2391 assert!(updates.update_fee.is_none());
2392 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]).unwrap();
2393 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed).unwrap();
2394 check_added_monitors!(nodes[1], 1);
2395 // Note that nodes[1] is in AwaitingRAA, so won't send a CS
2396 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2397 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa).unwrap();
2398 check_added_monitors!(nodes[2], 1);
2400 assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash));
2401 expect_pending_htlcs_forwardable!(nodes[2]);
2402 check_added_monitors!(nodes[2], 1);
2403 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2404 assert!(updates.update_add_htlcs.is_empty());
2405 assert!(updates.update_fulfill_htlcs.is_empty());
2406 assert!(updates.update_fail_malformed_htlcs.is_empty());
2407 assert_eq!(updates.update_fail_htlcs.len(), 1);
2408 assert!(updates.update_fee.is_none());
2409 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]).unwrap();
2410 // At this point first_payment_hash has dropped out of the latest two commitment
2411 // transactions that nodes[1] is tracking...
2412 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed).unwrap();
2413 check_added_monitors!(nodes[1], 1);
2414 // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
2415 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2416 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa).unwrap();
2417 check_added_monitors!(nodes[2], 1);
2419 // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
2420 // on nodes[2]'s RAA.
2421 let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
2422 let (_, fourth_payment_hash) = get_payment_preimage_hash!(nodes[0]);
2423 nodes[1].node.send_payment(route, fourth_payment_hash).unwrap();
2424 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2425 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2426 check_added_monitors!(nodes[1], 0);
2429 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa).unwrap();
2430 // One monitor for the new revocation preimage, no second on as we won't generate a new
2431 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
2432 check_added_monitors!(nodes[1], 1);
2433 let events = nodes[1].node.get_and_clear_pending_events();
2434 assert_eq!(events.len(), 1);
2436 Event::PendingHTLCsForwardable { .. } => { },
2437 _ => panic!("Unexpected event"),
2439 // Deliberately don't process the pending fail-back so they all fail back at once after
2440 // block connection just like the !deliver_bs_raa case
2443 let mut failed_htlcs = HashSet::new();
2444 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2446 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2447 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2449 let events = nodes[1].node.get_and_clear_pending_events();
2450 assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
2452 Event::PaymentFailed { ref payment_hash, .. } => {
2453 assert_eq!(*payment_hash, fourth_payment_hash);
2455 _ => panic!("Unexpected event"),
2457 if !deliver_bs_raa {
2459 Event::PendingHTLCsForwardable { .. } => { },
2460 _ => panic!("Unexpected event"),
2463 nodes[1].node.channel_state.lock().unwrap().next_forward = Instant::now();
2464 nodes[1].node.process_pending_htlc_forwards();
2465 check_added_monitors!(nodes[1], 1);
2467 let events = nodes[1].node.get_and_clear_pending_msg_events();
2468 assert_eq!(events.len(), if deliver_bs_raa { 3 } else { 2 });
2469 match events[if deliver_bs_raa { 1 } else { 0 }] {
2470 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
2471 _ => panic!("Unexpected event"),
2475 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, .. } } => {
2476 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
2477 assert_eq!(update_add_htlcs.len(), 1);
2478 assert!(update_fulfill_htlcs.is_empty());
2479 assert!(update_fail_htlcs.is_empty());
2480 assert!(update_fail_malformed_htlcs.is_empty());
2482 _ => panic!("Unexpected event"),
2485 match events[if deliver_bs_raa { 2 } else { 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, ref commitment_signed, .. } } => {
2487 assert!(update_add_htlcs.is_empty());
2488 assert_eq!(update_fail_htlcs.len(), 3);
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 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]).unwrap();
2494 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]).unwrap();
2495 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]).unwrap();
2497 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2499 let events = nodes[0].node.get_and_clear_pending_msg_events();
2500 // If we delivered B's RAA we got an unknown preimage error, not something
2501 // that we should update our routing table for.
2502 assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
2503 for event in events {
2505 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
2506 _ => panic!("Unexpected event"),
2509 let events = nodes[0].node.get_and_clear_pending_events();
2510 assert_eq!(events.len(), 3);
2512 Event::PaymentFailed { ref payment_hash, .. } => {
2513 assert!(failed_htlcs.insert(payment_hash.0));
2515 _ => panic!("Unexpected event"),
2518 Event::PaymentFailed { ref payment_hash, .. } => {
2519 assert!(failed_htlcs.insert(payment_hash.0));
2521 _ => panic!("Unexpected event"),
2524 Event::PaymentFailed { ref payment_hash, .. } => {
2525 assert!(failed_htlcs.insert(payment_hash.0));
2527 _ => panic!("Unexpected event"),
2530 _ => panic!("Unexpected event"),
2533 assert!(failed_htlcs.contains(&first_payment_hash.0));
2534 assert!(failed_htlcs.contains(&second_payment_hash.0));
2535 assert!(failed_htlcs.contains(&third_payment_hash.0));
2539 fn test_commitment_revoked_fail_backward_exhaustive_a() {
2540 do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
2541 do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
2542 do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
2543 do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
2547 fn test_commitment_revoked_fail_backward_exhaustive_b() {
2548 do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
2549 do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
2550 do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
2551 do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
2555 fn test_htlc_ignore_latest_remote_commitment() {
2556 // Test that HTLC transactions spending the latest remote commitment transaction are simply
2557 // ignored if we cannot claim them. This originally tickled an invalid unwrap().
2558 let nodes = create_network(2);
2559 create_announced_chan_between_nodes(&nodes, 0, 1);
2561 route_payment(&nodes[0], &[&nodes[1]], 10000000);
2562 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id);
2563 check_closed_broadcast!(nodes[0]);
2565 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2566 assert_eq!(node_txn.len(), 2);
2568 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2569 nodes[1].chain_monitor.block_connected_checked(&header, 1, &[&node_txn[0], &node_txn[1]], &[1; 2]);
2570 check_closed_broadcast!(nodes[1]);
2572 // Duplicate the block_connected call since this may happen due to other listeners
2573 // registering new transactions
2574 nodes[1].chain_monitor.block_connected_checked(&header, 1, &[&node_txn[0], &node_txn[1]], &[1; 2]);
2578 fn test_force_close_fail_back() {
2579 // Check which HTLCs are failed-backwards on channel force-closure
2580 let mut nodes = create_network(3);
2581 create_announced_chan_between_nodes(&nodes, 0, 1);
2582 create_announced_chan_between_nodes(&nodes, 1, 2);
2584 let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, 42).unwrap();
2586 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
2588 let mut payment_event = {
2589 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
2590 check_added_monitors!(nodes[0], 1);
2592 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2593 assert_eq!(events.len(), 1);
2594 SendEvent::from_event(events.remove(0))
2597 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
2598 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
2600 expect_pending_htlcs_forwardable!(nodes[1]);
2602 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
2603 assert_eq!(events_2.len(), 1);
2604 payment_event = SendEvent::from_event(events_2.remove(0));
2605 assert_eq!(payment_event.msgs.len(), 1);
2607 check_added_monitors!(nodes[1], 1);
2608 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
2609 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg).unwrap();
2610 check_added_monitors!(nodes[2], 1);
2611 let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2613 // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
2614 // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
2615 // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
2617 nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id);
2618 check_closed_broadcast!(nodes[2]);
2620 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
2621 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
2622 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
2623 // back to nodes[1] upon timeout otherwise.
2624 assert_eq!(node_txn.len(), 1);
2628 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2629 nodes[1].chain_monitor.block_connected_checked(&header, 1, &[&tx], &[1]);
2631 // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
2632 check_closed_broadcast!(nodes[1]);
2634 // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
2636 let mut monitors = nodes[2].chan_monitor.simple_monitor.monitors.lock().unwrap();
2637 monitors.get_mut(&OutPoint::new(Sha256dHash::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), 0)).unwrap()
2638 .provide_payment_preimage(&our_payment_hash, &our_payment_preimage);
2640 nodes[2].chain_monitor.block_connected_checked(&header, 1, &[&tx], &[1]);
2641 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
2642 assert_eq!(node_txn.len(), 1);
2643 assert_eq!(node_txn[0].input.len(), 1);
2644 assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
2645 assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
2646 assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
2648 check_spends!(node_txn[0], tx);
2652 fn test_unconf_chan() {
2653 // After creating a chan between nodes, we disconnect all blocks previously seen to force a channel close on nodes[0] side
2654 let nodes = create_network(2);
2655 create_announced_chan_between_nodes(&nodes, 0, 1);
2657 let channel_state = nodes[0].node.channel_state.lock().unwrap();
2658 assert_eq!(channel_state.by_id.len(), 1);
2659 assert_eq!(channel_state.short_to_id.len(), 1);
2660 mem::drop(channel_state);
2662 let mut headers = Vec::new();
2663 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2664 headers.push(header.clone());
2666 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2667 headers.push(header.clone());
2669 while !headers.is_empty() {
2670 nodes[0].node.block_disconnected(&headers.pop().unwrap());
2672 check_closed_broadcast!(nodes[0]);
2673 let channel_state = nodes[0].node.channel_state.lock().unwrap();
2674 assert_eq!(channel_state.by_id.len(), 0);
2675 assert_eq!(channel_state.short_to_id.len(), 0);
2679 fn test_simple_peer_disconnect() {
2680 // Test that we can reconnect when there are no lost messages
2681 let nodes = create_network(3);
2682 create_announced_chan_between_nodes(&nodes, 0, 1);
2683 create_announced_chan_between_nodes(&nodes, 1, 2);
2685 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2686 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2687 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
2689 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
2690 let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
2691 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
2692 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1);
2694 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2695 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2696 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
2698 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
2699 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
2700 let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
2701 let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
2703 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2704 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2706 claim_payment_along_route(&nodes[0], &vec!(&nodes[1], &nodes[2]), true, payment_preimage_3);
2707 fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
2709 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
2711 let events = nodes[0].node.get_and_clear_pending_events();
2712 assert_eq!(events.len(), 2);
2714 Event::PaymentSent { payment_preimage } => {
2715 assert_eq!(payment_preimage, payment_preimage_3);
2717 _ => panic!("Unexpected event"),
2720 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
2721 assert_eq!(payment_hash, payment_hash_5);
2722 assert!(rejected_by_dest);
2724 _ => panic!("Unexpected event"),
2728 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4);
2729 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
2732 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
2733 // Test that we can reconnect when in-flight HTLC updates get dropped
2734 let mut nodes = create_network(2);
2735 if messages_delivered == 0 {
2736 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001);
2737 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
2739 create_announced_chan_between_nodes(&nodes, 0, 1);
2742 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();
2743 let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
2745 let payment_event = {
2746 nodes[0].node.send_payment(route.clone(), payment_hash_1).unwrap();
2747 check_added_monitors!(nodes[0], 1);
2749 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2750 assert_eq!(events.len(), 1);
2751 SendEvent::from_event(events.remove(0))
2753 assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
2755 if messages_delivered < 2 {
2756 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
2758 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
2759 if messages_delivered >= 3 {
2760 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg).unwrap();
2761 check_added_monitors!(nodes[1], 1);
2762 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2764 if messages_delivered >= 4 {
2765 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
2766 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2767 check_added_monitors!(nodes[0], 1);
2769 if messages_delivered >= 5 {
2770 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed).unwrap();
2771 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2772 // No commitment_signed so get_event_msg's assert(len == 1) passes
2773 check_added_monitors!(nodes[0], 1);
2775 if messages_delivered >= 6 {
2776 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
2777 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2778 check_added_monitors!(nodes[1], 1);
2785 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2786 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2787 if messages_delivered < 3 {
2788 // Even if the funding_locked messages get exchanged, as long as nothing further was
2789 // received on either side, both sides will need to resend them.
2790 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
2791 } else if messages_delivered == 3 {
2792 // nodes[0] still wants its RAA + commitment_signed
2793 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
2794 } else if messages_delivered == 4 {
2795 // nodes[0] still wants its commitment_signed
2796 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
2797 } else if messages_delivered == 5 {
2798 // nodes[1] still wants its final RAA
2799 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
2800 } else if messages_delivered == 6 {
2801 // Everything was delivered...
2802 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
2805 let events_1 = nodes[1].node.get_and_clear_pending_events();
2806 assert_eq!(events_1.len(), 1);
2808 Event::PendingHTLCsForwardable { .. } => { },
2809 _ => panic!("Unexpected event"),
2812 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2813 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2814 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
2816 nodes[1].node.channel_state.lock().unwrap().next_forward = Instant::now();
2817 nodes[1].node.process_pending_htlc_forwards();
2819 let events_2 = nodes[1].node.get_and_clear_pending_events();
2820 assert_eq!(events_2.len(), 1);
2822 Event::PaymentReceived { ref payment_hash, amt } => {
2823 assert_eq!(payment_hash_1, *payment_hash);
2824 assert_eq!(amt, 1000000);
2826 _ => panic!("Unexpected event"),
2829 nodes[1].node.claim_funds(payment_preimage_1);
2830 check_added_monitors!(nodes[1], 1);
2832 let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
2833 assert_eq!(events_3.len(), 1);
2834 let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
2835 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2836 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
2837 assert!(updates.update_add_htlcs.is_empty());
2838 assert!(updates.update_fail_htlcs.is_empty());
2839 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2840 assert!(updates.update_fail_malformed_htlcs.is_empty());
2841 assert!(updates.update_fee.is_none());
2842 (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
2844 _ => panic!("Unexpected event"),
2847 if messages_delivered >= 1 {
2848 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc).unwrap();
2850 let events_4 = nodes[0].node.get_and_clear_pending_events();
2851 assert_eq!(events_4.len(), 1);
2853 Event::PaymentSent { ref payment_preimage } => {
2854 assert_eq!(payment_preimage_1, *payment_preimage);
2856 _ => panic!("Unexpected event"),
2859 if messages_delivered >= 2 {
2860 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed).unwrap();
2861 check_added_monitors!(nodes[0], 1);
2862 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2864 if messages_delivered >= 3 {
2865 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
2866 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2867 check_added_monitors!(nodes[1], 1);
2869 if messages_delivered >= 4 {
2870 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed).unwrap();
2871 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2872 // No commitment_signed so get_event_msg's assert(len == 1) passes
2873 check_added_monitors!(nodes[1], 1);
2875 if messages_delivered >= 5 {
2876 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
2877 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2878 check_added_monitors!(nodes[0], 1);
2885 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2886 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2887 if messages_delivered < 2 {
2888 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
2889 //TODO: Deduplicate PaymentSent events, then enable this if:
2890 //if messages_delivered < 1 {
2891 let events_4 = nodes[0].node.get_and_clear_pending_events();
2892 assert_eq!(events_4.len(), 1);
2894 Event::PaymentSent { ref payment_preimage } => {
2895 assert_eq!(payment_preimage_1, *payment_preimage);
2897 _ => panic!("Unexpected event"),
2900 } else if messages_delivered == 2 {
2901 // nodes[0] still wants its RAA + commitment_signed
2902 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
2903 } else if messages_delivered == 3 {
2904 // nodes[0] still wants its commitment_signed
2905 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
2906 } else if messages_delivered == 4 {
2907 // nodes[1] still wants its final RAA
2908 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
2909 } else if messages_delivered == 5 {
2910 // Everything was delivered...
2911 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
2914 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2915 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2916 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
2918 // Channel should still work fine...
2919 let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
2920 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
2924 fn test_drop_messages_peer_disconnect_a() {
2925 do_test_drop_messages_peer_disconnect(0);
2926 do_test_drop_messages_peer_disconnect(1);
2927 do_test_drop_messages_peer_disconnect(2);
2928 do_test_drop_messages_peer_disconnect(3);
2932 fn test_drop_messages_peer_disconnect_b() {
2933 do_test_drop_messages_peer_disconnect(4);
2934 do_test_drop_messages_peer_disconnect(5);
2935 do_test_drop_messages_peer_disconnect(6);
2939 fn test_funding_peer_disconnect() {
2940 // Test that we can lock in our funding tx while disconnected
2941 let nodes = create_network(2);
2942 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001);
2944 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2945 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2947 confirm_transaction(&nodes[0].chain_monitor, &tx, tx.version);
2948 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
2949 assert_eq!(events_1.len(), 1);
2951 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
2952 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
2954 _ => panic!("Unexpected event"),
2957 reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
2959 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2960 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2962 confirm_transaction(&nodes[1].chain_monitor, &tx, tx.version);
2963 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
2964 assert_eq!(events_2.len(), 2);
2966 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
2967 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
2969 _ => panic!("Unexpected event"),
2972 MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ } => {
2973 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
2975 _ => panic!("Unexpected event"),
2978 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
2980 // TODO: We shouldn't need to manually pass list_usable_chanels here once we support
2981 // rebroadcasting announcement_signatures upon reconnect.
2983 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();
2984 let (payment_preimage, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
2985 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
2989 fn test_drop_messages_peer_disconnect_dual_htlc() {
2990 // Test that we can handle reconnecting when both sides of a channel have pending
2991 // commitment_updates when we disconnect.
2992 let mut nodes = create_network(2);
2993 create_announced_chan_between_nodes(&nodes, 0, 1);
2995 let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
2997 // Now try to send a second payment which will fail to send
2998 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
2999 let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
3001 nodes[0].node.send_payment(route.clone(), payment_hash_2).unwrap();
3002 check_added_monitors!(nodes[0], 1);
3004 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3005 assert_eq!(events_1.len(), 1);
3007 MessageSendEvent::UpdateHTLCs { .. } => {},
3008 _ => panic!("Unexpected event"),
3011 assert!(nodes[1].node.claim_funds(payment_preimage_1));
3012 check_added_monitors!(nodes[1], 1);
3014 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3015 assert_eq!(events_2.len(), 1);
3017 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 } } => {
3018 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3019 assert!(update_add_htlcs.is_empty());
3020 assert_eq!(update_fulfill_htlcs.len(), 1);
3021 assert!(update_fail_htlcs.is_empty());
3022 assert!(update_fail_malformed_htlcs.is_empty());
3023 assert!(update_fee.is_none());
3025 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]).unwrap();
3026 let events_3 = nodes[0].node.get_and_clear_pending_events();
3027 assert_eq!(events_3.len(), 1);
3029 Event::PaymentSent { ref payment_preimage } => {
3030 assert_eq!(*payment_preimage, payment_preimage_1);
3032 _ => panic!("Unexpected event"),
3035 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed).unwrap();
3036 let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3037 // No commitment_signed so get_event_msg's assert(len == 1) passes
3038 check_added_monitors!(nodes[0], 1);
3040 _ => panic!("Unexpected event"),
3043 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3044 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3046 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
3047 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3048 assert_eq!(reestablish_1.len(), 1);
3049 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
3050 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3051 assert_eq!(reestablish_2.len(), 1);
3053 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]).unwrap();
3054 let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3055 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]).unwrap();
3056 let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3058 assert!(as_resp.0.is_none());
3059 assert!(bs_resp.0.is_none());
3061 assert!(bs_resp.1.is_none());
3062 assert!(bs_resp.2.is_none());
3064 assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3066 assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3067 assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3068 assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3069 assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3070 assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3071 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]).unwrap();
3072 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed).unwrap();
3073 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3074 // No commitment_signed so get_event_msg's assert(len == 1) passes
3075 check_added_monitors!(nodes[1], 1);
3077 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap()).unwrap();
3078 let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3079 assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
3080 assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
3081 assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
3082 assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
3083 assert!(bs_second_commitment_signed.update_fee.is_none());
3084 check_added_monitors!(nodes[1], 1);
3086 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
3087 let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3088 assert!(as_commitment_signed.update_add_htlcs.is_empty());
3089 assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
3090 assert!(as_commitment_signed.update_fail_htlcs.is_empty());
3091 assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
3092 assert!(as_commitment_signed.update_fee.is_none());
3093 check_added_monitors!(nodes[0], 1);
3095 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed).unwrap();
3096 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3097 // No commitment_signed so get_event_msg's assert(len == 1) passes
3098 check_added_monitors!(nodes[0], 1);
3100 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed).unwrap();
3101 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3102 // No commitment_signed so get_event_msg's assert(len == 1) passes
3103 check_added_monitors!(nodes[1], 1);
3105 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
3106 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3107 check_added_monitors!(nodes[1], 1);
3109 expect_pending_htlcs_forwardable!(nodes[1]);
3111 let events_5 = nodes[1].node.get_and_clear_pending_events();
3112 assert_eq!(events_5.len(), 1);
3114 Event::PaymentReceived { ref payment_hash, amt: _ } => {
3115 assert_eq!(payment_hash_2, *payment_hash);
3117 _ => panic!("Unexpected event"),
3120 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack).unwrap();
3121 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3122 check_added_monitors!(nodes[0], 1);
3124 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
3128 fn test_invalid_channel_announcement() {
3129 //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
3130 let secp_ctx = Secp256k1::new();
3131 let nodes = create_network(2);
3133 let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1]);
3135 let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
3136 let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
3137 let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
3138 let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
3140 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 } );
3142 let as_bitcoin_key = PublicKey::from_secret_key(&secp_ctx, &as_chan.get_local_keys().funding_key);
3143 let bs_bitcoin_key = PublicKey::from_secret_key(&secp_ctx, &bs_chan.get_local_keys().funding_key);
3145 let as_network_key = nodes[0].node.get_our_node_id();
3146 let bs_network_key = nodes[1].node.get_our_node_id();
3148 let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
3150 let mut chan_announcement;
3152 macro_rules! dummy_unsigned_msg {
3154 msgs::UnsignedChannelAnnouncement {
3155 features: msgs::GlobalFeatures::new(),
3156 chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
3157 short_channel_id: as_chan.get_short_channel_id().unwrap(),
3158 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
3159 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
3160 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
3161 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
3162 excess_data: Vec::new(),
3167 macro_rules! sign_msg {
3168 ($unsigned_msg: expr) => {
3169 let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
3170 let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_local_keys().funding_key);
3171 let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_local_keys().funding_key);
3172 let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
3173 let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
3174 chan_announcement = msgs::ChannelAnnouncement {
3175 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
3176 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
3177 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
3178 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
3179 contents: $unsigned_msg
3184 let unsigned_msg = dummy_unsigned_msg!();
3185 sign_msg!(unsigned_msg);
3186 assert_eq!(nodes[0].router.handle_channel_announcement(&chan_announcement).unwrap(), true);
3187 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 } );
3189 // Configured with Network::Testnet
3190 let mut unsigned_msg = dummy_unsigned_msg!();
3191 unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.bitcoin_hash();
3192 sign_msg!(unsigned_msg);
3193 assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
3195 let mut unsigned_msg = dummy_unsigned_msg!();
3196 unsigned_msg.chain_hash = Sha256dHash::hash(&[1,2,3,4,5,6,7,8,9]);
3197 sign_msg!(unsigned_msg);
3198 assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
3202 fn test_no_txn_manager_serialize_deserialize() {
3203 let mut nodes = create_network(2);
3205 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001);
3207 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3209 let nodes_0_serialized = nodes[0].node.encode();
3210 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3211 nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
3213 nodes[0].chan_monitor = Arc::new(test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), Arc::new(test_utils::TestLogger::new()), Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 })));
3214 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3215 let (_, chan_0_monitor) = <(Sha256dHash, ChannelMonitor)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
3216 assert!(chan_0_monitor_read.is_empty());
3218 let mut nodes_0_read = &nodes_0_serialized[..];
3219 let config = UserConfig::new();
3220 let keys_manager = Arc::new(keysinterface::KeysManager::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
3221 let (_, nodes_0_deserialized) = {
3222 let mut channel_monitors = HashMap::new();
3223 channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &chan_0_monitor);
3224 <(Sha256dHash, ChannelManager)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3225 default_config: config,
3227 fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
3228 monitor: nodes[0].chan_monitor.clone(),
3229 chain_monitor: nodes[0].chain_monitor.clone(),
3230 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3231 logger: Arc::new(test_utils::TestLogger::new()),
3232 channel_monitors: &channel_monitors,
3235 assert!(nodes_0_read.is_empty());
3237 assert!(nodes[0].chan_monitor.add_update_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
3238 nodes[0].node = Arc::new(nodes_0_deserialized);
3239 let nodes_0_as_listener: Arc<ChainListener> = nodes[0].node.clone();
3240 nodes[0].chain_monitor.register_listener(Arc::downgrade(&nodes_0_as_listener));
3241 assert_eq!(nodes[0].node.list_channels().len(), 1);
3242 check_added_monitors!(nodes[0], 1);
3244 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
3245 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3246 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
3247 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3249 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]).unwrap();
3250 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3251 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]).unwrap();
3252 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3254 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
3255 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
3256 for node in nodes.iter() {
3257 assert!(node.router.handle_channel_announcement(&announcement).unwrap());
3258 node.router.handle_channel_update(&as_update).unwrap();
3259 node.router.handle_channel_update(&bs_update).unwrap();
3262 send_payment(&nodes[0], &[&nodes[1]], 1000000);
3266 fn test_simple_manager_serialize_deserialize() {
3267 let mut nodes = create_network(2);
3268 create_announced_chan_between_nodes(&nodes, 0, 1);
3270 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3271 let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3273 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3275 let nodes_0_serialized = nodes[0].node.encode();
3276 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3277 nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
3279 nodes[0].chan_monitor = Arc::new(test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), Arc::new(test_utils::TestLogger::new()), Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 })));
3280 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3281 let (_, chan_0_monitor) = <(Sha256dHash, ChannelMonitor)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
3282 assert!(chan_0_monitor_read.is_empty());
3284 let mut nodes_0_read = &nodes_0_serialized[..];
3285 let keys_manager = Arc::new(keysinterface::KeysManager::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
3286 let (_, nodes_0_deserialized) = {
3287 let mut channel_monitors = HashMap::new();
3288 channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &chan_0_monitor);
3289 <(Sha256dHash, ChannelManager)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3290 default_config: UserConfig::new(),
3292 fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
3293 monitor: nodes[0].chan_monitor.clone(),
3294 chain_monitor: nodes[0].chain_monitor.clone(),
3295 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3296 logger: Arc::new(test_utils::TestLogger::new()),
3297 channel_monitors: &channel_monitors,
3300 assert!(nodes_0_read.is_empty());
3302 assert!(nodes[0].chan_monitor.add_update_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
3303 nodes[0].node = Arc::new(nodes_0_deserialized);
3304 check_added_monitors!(nodes[0], 1);
3306 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3308 fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
3309 claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage);
3313 fn test_manager_serialize_deserialize_inconsistent_monitor() {
3314 // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
3315 let mut nodes = create_network(4);
3316 create_announced_chan_between_nodes(&nodes, 0, 1);
3317 create_announced_chan_between_nodes(&nodes, 2, 0);
3318 let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3);
3320 let (our_payment_preimage, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
3322 // Serialize the ChannelManager here, but the monitor we keep up-to-date
3323 let nodes_0_serialized = nodes[0].node.encode();
3325 route_payment(&nodes[0], &[&nodes[3]], 1000000);
3326 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3327 nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3328 nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3330 // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
3332 let mut node_0_monitors_serialized = Vec::new();
3333 for monitor in nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter() {
3334 let mut writer = test_utils::TestVecWriter(Vec::new());
3335 monitor.1.write_for_disk(&mut writer).unwrap();
3336 node_0_monitors_serialized.push(writer.0);
3339 nodes[0].chan_monitor = Arc::new(test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), Arc::new(test_utils::TestLogger::new()), Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 })));
3340 let mut node_0_monitors = Vec::new();
3341 for serialized in node_0_monitors_serialized.iter() {
3342 let mut read = &serialized[..];
3343 let (_, monitor) = <(Sha256dHash, ChannelMonitor)>::read(&mut read, Arc::new(test_utils::TestLogger::new())).unwrap();
3344 assert!(read.is_empty());
3345 node_0_monitors.push(monitor);
3348 let mut nodes_0_read = &nodes_0_serialized[..];
3349 let keys_manager = Arc::new(keysinterface::KeysManager::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
3350 let (_, nodes_0_deserialized) = <(Sha256dHash, ChannelManager)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3351 default_config: UserConfig::new(),
3353 fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
3354 monitor: nodes[0].chan_monitor.clone(),
3355 chain_monitor: nodes[0].chain_monitor.clone(),
3356 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3357 logger: Arc::new(test_utils::TestLogger::new()),
3358 channel_monitors: &node_0_monitors.iter().map(|monitor| { (monitor.get_funding_txo().unwrap(), monitor) }).collect(),
3360 assert!(nodes_0_read.is_empty());
3362 { // Channel close should result in a commitment tx and an HTLC tx
3363 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3364 assert_eq!(txn.len(), 2);
3365 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
3366 assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
3369 for monitor in node_0_monitors.drain(..) {
3370 assert!(nodes[0].chan_monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor).is_ok());
3371 check_added_monitors!(nodes[0], 1);
3373 nodes[0].node = Arc::new(nodes_0_deserialized);
3375 // nodes[1] and nodes[2] have no lost state with nodes[0]...
3376 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3377 reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3378 //... and we can even still claim the payment!
3379 claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage);
3381 nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id());
3382 let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
3383 nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id());
3384 if let Err(msgs::HandleError { action: Some(msgs::ErrorAction::SendErrorMessage { msg }), .. }) = nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish) {
3385 assert_eq!(msg.channel_id, channel_id);
3386 } else { panic!("Unexpected result"); }
3389 macro_rules! check_spendable_outputs {
3390 ($node: expr, $der_idx: expr) => {
3392 let events = $node.chan_monitor.simple_monitor.get_and_clear_pending_events();
3393 let mut txn = Vec::new();
3394 for event in events {
3396 Event::SpendableOutputs { ref outputs } => {
3397 for outp in outputs {
3399 SpendableOutputDescriptor::DynamicOutputP2WPKH { ref outpoint, ref key, ref output } => {
3401 previous_output: outpoint.clone(),
3402 script_sig: Script::new(),
3404 witness: Vec::new(),
3407 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
3408 value: output.value,
3410 let mut spend_tx = Transaction {
3416 let secp_ctx = Secp256k1::new();
3417 let remotepubkey = PublicKey::from_secret_key(&secp_ctx, &key);
3418 let witness_script = Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: remotepubkey}, Network::Testnet).script_pubkey();
3419 let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
3420 let remotesig = secp_ctx.sign(&sighash, key);
3421 spend_tx.input[0].witness.push(remotesig.serialize_der().to_vec());
3422 spend_tx.input[0].witness[0].push(SigHashType::All as u8);
3423 spend_tx.input[0].witness.push(remotepubkey.serialize().to_vec());
3426 SpendableOutputDescriptor::DynamicOutputP2WSH { ref outpoint, ref key, ref witness_script, ref to_self_delay, ref output } => {
3428 previous_output: outpoint.clone(),
3429 script_sig: Script::new(),
3430 sequence: *to_self_delay as u32,
3431 witness: Vec::new(),
3434 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
3435 value: output.value,
3437 let mut spend_tx = Transaction {
3443 let secp_ctx = Secp256k1::new();
3444 let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], witness_script, output.value)[..]).unwrap();
3445 let local_delaysig = secp_ctx.sign(&sighash, key);
3446 spend_tx.input[0].witness.push(local_delaysig.serialize_der().to_vec());
3447 spend_tx.input[0].witness[0].push(SigHashType::All as u8);
3448 spend_tx.input[0].witness.push(vec!(0));
3449 spend_tx.input[0].witness.push(witness_script.clone().into_bytes());
3452 SpendableOutputDescriptor::StaticOutput { ref outpoint, ref output } => {
3453 let secp_ctx = Secp256k1::new();
3455 previous_output: outpoint.clone(),
3456 script_sig: Script::new(),
3458 witness: Vec::new(),
3461 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
3462 value: output.value,
3464 let mut spend_tx = Transaction {
3468 output: vec![outp.clone()],
3471 match ExtendedPrivKey::new_master(Network::Testnet, &$node.node_seed) {
3473 match master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx($der_idx).expect("key space exhausted")) {
3475 Err(_) => panic!("Your RNG is busted"),
3478 Err(_) => panic!("Your rng is busted"),
3481 let pubkey = ExtendedPubKey::from_private(&secp_ctx, &secret).public_key;
3482 let witness_script = Address::p2pkh(&pubkey, Network::Testnet).script_pubkey();
3483 let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
3484 let sig = secp_ctx.sign(&sighash, &secret.private_key.key);
3485 spend_tx.input[0].witness.push(sig.serialize_der().to_vec());
3486 spend_tx.input[0].witness[0].push(SigHashType::All as u8);
3487 spend_tx.input[0].witness.push(pubkey.key.serialize().to_vec());
3493 _ => panic!("Unexpected event"),
3502 fn test_claim_sizeable_push_msat() {
3503 // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
3504 let nodes = create_network(2);
3506 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000);
3507 nodes[1].node.force_close_channel(&chan.2);
3508 check_closed_broadcast!(nodes[1]);
3509 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3510 assert_eq!(node_txn.len(), 1);
3511 check_spends!(node_txn[0], chan.3.clone());
3512 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
3514 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3515 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
3516 let spend_txn = check_spendable_outputs!(nodes[1], 1);
3517 assert_eq!(spend_txn.len(), 1);
3518 check_spends!(spend_txn[0], node_txn[0].clone());
3522 fn test_claim_on_remote_sizeable_push_msat() {
3523 // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
3524 // to_remote output is encumbered by a P2WPKH
3526 let nodes = create_network(2);
3528 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000);
3529 nodes[0].node.force_close_channel(&chan.2);
3530 check_closed_broadcast!(nodes[0]);
3532 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3533 assert_eq!(node_txn.len(), 1);
3534 check_spends!(node_txn[0], chan.3.clone());
3535 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
3537 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3538 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
3539 check_closed_broadcast!(nodes[1]);
3540 let spend_txn = check_spendable_outputs!(nodes[1], 1);
3541 assert_eq!(spend_txn.len(), 2);
3542 assert_eq!(spend_txn[0], spend_txn[1]);
3543 check_spends!(spend_txn[0], node_txn[0].clone());
3547 fn test_claim_on_remote_revoked_sizeable_push_msat() {
3548 // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
3549 // to_remote output is encumbered by a P2WPKH
3551 let nodes = create_network(2);
3553 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000);
3554 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
3555 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().last_local_commitment_txn.clone();
3556 assert_eq!(revoked_local_txn[0].input.len(), 1);
3557 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
3559 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
3560 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3561 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3562 check_closed_broadcast!(nodes[1]);
3564 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3565 let spend_txn = check_spendable_outputs!(nodes[1], 1);
3566 assert_eq!(spend_txn.len(), 4);
3567 assert_eq!(spend_txn[0], spend_txn[2]); // to_remote output on revoked remote commitment_tx
3568 check_spends!(spend_txn[0], revoked_local_txn[0].clone());
3569 assert_eq!(spend_txn[1], spend_txn[3]); // to_local output on local commitment tx
3570 check_spends!(spend_txn[1], node_txn[0].clone());
3574 fn test_static_spendable_outputs_preimage_tx() {
3575 let nodes = create_network(2);
3577 // Create some initial channels
3578 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
3580 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
3582 let commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
3583 assert_eq!(commitment_tx[0].input.len(), 1);
3584 assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
3586 // Settle A's commitment tx on B's chain
3587 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3588 assert!(nodes[1].node.claim_funds(payment_preimage));
3589 check_added_monitors!(nodes[1], 1);
3590 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()] }, 1);
3591 let events = nodes[1].node.get_and_clear_pending_msg_events();
3593 MessageSendEvent::UpdateHTLCs { .. } => {},
3594 _ => panic!("Unexpected event"),
3597 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
3598 _ => panic!("Unexepected event"),
3601 // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
3602 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 1 (local commitment tx), ChannelMonitor: 2 (1 preimage tx) * 2 (block-rescan)
3603 check_spends!(node_txn[0], commitment_tx[0].clone());
3604 assert_eq!(node_txn[0], node_txn[2]);
3605 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3606 check_spends!(node_txn[1], chan_1.3.clone());
3608 let spend_txn = check_spendable_outputs!(nodes[1], 1); // , 0, 0, 1, 1);
3609 assert_eq!(spend_txn.len(), 2);
3610 assert_eq!(spend_txn[0], spend_txn[1]);
3611 check_spends!(spend_txn[0], node_txn[0].clone());
3615 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
3616 let nodes = create_network(2);
3618 // Create some initial channels
3619 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
3621 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
3622 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.iter().next().unwrap().1.last_local_commitment_txn.clone();
3623 assert_eq!(revoked_local_txn[0].input.len(), 1);
3624 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
3626 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
3628 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3629 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3630 check_closed_broadcast!(nodes[1]);
3632 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3633 assert_eq!(node_txn.len(), 3);
3634 assert_eq!(node_txn.pop().unwrap(), node_txn[0]);
3635 assert_eq!(node_txn[0].input.len(), 2);
3636 check_spends!(node_txn[0], revoked_local_txn[0].clone());
3638 let spend_txn = check_spendable_outputs!(nodes[1], 1);
3639 assert_eq!(spend_txn.len(), 2);
3640 assert_eq!(spend_txn[0], spend_txn[1]);
3641 check_spends!(spend_txn[0], node_txn[0].clone());
3645 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
3646 let nodes = create_network(2);
3648 // Create some initial channels
3649 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
3651 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
3652 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
3653 assert_eq!(revoked_local_txn[0].input.len(), 1);
3654 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
3656 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
3658 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3659 // A will generate HTLC-Timeout from revoked commitment tx
3660 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3661 check_closed_broadcast!(nodes[0]);
3663 let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3664 assert_eq!(revoked_htlc_txn.len(), 3);
3665 assert_eq!(revoked_htlc_txn[0], revoked_htlc_txn[2]);
3666 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
3667 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3668 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
3669 check_spends!(revoked_htlc_txn[1], chan_1.3.clone());
3671 // B will generate justice tx from A's revoked commitment/HTLC tx
3672 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
3673 check_closed_broadcast!(nodes[1]);
3675 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3676 assert_eq!(node_txn.len(), 4);
3677 assert_eq!(node_txn[3].input.len(), 1);
3678 check_spends!(node_txn[3], revoked_htlc_txn[0].clone());
3680 // Check B's ChannelMonitor was able to generate the right spendable output descriptor
3681 let spend_txn = check_spendable_outputs!(nodes[1], 1);
3682 assert_eq!(spend_txn.len(), 3);
3683 assert_eq!(spend_txn[0], spend_txn[1]);
3684 check_spends!(spend_txn[0], node_txn[0].clone());
3685 check_spends!(spend_txn[2], node_txn[3].clone());
3689 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
3690 let nodes = create_network(2);
3692 // Create some initial channels
3693 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
3695 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
3696 let revoked_local_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
3697 assert_eq!(revoked_local_txn[0].input.len(), 1);
3698 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
3700 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
3702 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3703 // B will generate HTLC-Success from revoked commitment tx
3704 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3705 check_closed_broadcast!(nodes[1]);
3706 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3708 assert_eq!(revoked_htlc_txn.len(), 3);
3709 assert_eq!(revoked_htlc_txn[0], revoked_htlc_txn[2]);
3710 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
3711 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3712 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
3714 // A will generate justice tx from B's revoked commitment/HTLC tx
3715 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
3716 check_closed_broadcast!(nodes[0]);
3718 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3719 assert_eq!(node_txn.len(), 4);
3720 assert_eq!(node_txn[3].input.len(), 1);
3721 check_spends!(node_txn[3], revoked_htlc_txn[0].clone());
3723 // Check A's ChannelMonitor was able to generate the right spendable output descriptor
3724 let spend_txn = check_spendable_outputs!(nodes[0], 1);
3725 assert_eq!(spend_txn.len(), 5);
3726 assert_eq!(spend_txn[0], spend_txn[2]);
3727 assert_eq!(spend_txn[1], spend_txn[3]);
3728 check_spends!(spend_txn[0], revoked_local_txn[0].clone()); // spending to_remote output from revoked local tx
3729 check_spends!(spend_txn[1], node_txn[2].clone()); // spending justice tx output from revoked local tx htlc received output
3730 check_spends!(spend_txn[4], node_txn[3].clone()); // spending justice tx output on htlc success tx
3734 fn test_onchain_to_onchain_claim() {
3735 // Test that in case of channel closure, we detect the state of output thanks to
3736 // ChainWatchInterface and claim HTLC on downstream peer's remote commitment tx.
3737 // First, have C claim an HTLC against its own latest commitment transaction.
3738 // Then, broadcast these to B, which should update the monitor downstream on the A<->B
3740 // Finally, check that B will claim the HTLC output if A's latest commitment transaction
3743 let nodes = create_network(3);
3745 // Create some initial channels
3746 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
3747 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
3749 // Rebalance the network a bit by relaying one payment through all the channels ...
3750 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
3751 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
3753 let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
3754 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
3755 let commitment_tx = nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().last_local_commitment_txn.clone();
3756 check_spends!(commitment_tx[0], chan_2.3.clone());
3757 nodes[2].node.claim_funds(payment_preimage);
3758 check_added_monitors!(nodes[2], 1);
3759 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3760 assert!(updates.update_add_htlcs.is_empty());
3761 assert!(updates.update_fail_htlcs.is_empty());
3762 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3763 assert!(updates.update_fail_malformed_htlcs.is_empty());
3765 nodes[2].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
3766 check_closed_broadcast!(nodes[2]);
3768 let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
3769 assert_eq!(c_txn.len(), 3);
3770 assert_eq!(c_txn[0], c_txn[2]);
3771 assert_eq!(commitment_tx[0], c_txn[1]);
3772 check_spends!(c_txn[1], chan_2.3.clone());
3773 check_spends!(c_txn[2], c_txn[1].clone());
3774 assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
3775 assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3776 assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
3777 assert_eq!(c_txn[0].lock_time, 0); // Success tx
3779 // 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
3780 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]}, 1);
3782 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3783 assert_eq!(b_txn.len(), 4);
3784 assert_eq!(b_txn[0], b_txn[3]);
3785 check_spends!(b_txn[1], chan_2.3); // B local commitment tx, issued by ChannelManager
3786 check_spends!(b_txn[2], b_txn[1].clone()); // HTLC-Timeout on B local commitment tx, issued by ChannelManager
3787 assert_eq!(b_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3788 assert!(b_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
3789 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
3790 check_spends!(b_txn[0], c_txn[1].clone()); // timeout tx on C remote commitment tx, issued by ChannelMonitor, * 2 due to block rescan
3791 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3792 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
3793 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
3796 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
3797 check_added_monitors!(nodes[1], 1);
3798 match msg_events[0] {
3799 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
3800 _ => panic!("Unexpected event"),
3802 match msg_events[1] {
3803 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, .. } } => {
3804 assert!(update_add_htlcs.is_empty());
3805 assert!(update_fail_htlcs.is_empty());
3806 assert_eq!(update_fulfill_htlcs.len(), 1);
3807 assert!(update_fail_malformed_htlcs.is_empty());
3808 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3810 _ => panic!("Unexpected event"),
3812 // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
3813 let commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
3814 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
3815 let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3816 assert_eq!(b_txn.len(), 3);
3817 check_spends!(b_txn[1], chan_1.3); // Local commitment tx, issued by ChannelManager
3818 assert_eq!(b_txn[0], b_txn[2]); // HTLC-Success tx, issued by ChannelMonitor, * 2 due to block rescan
3819 check_spends!(b_txn[0], commitment_tx[0].clone());
3820 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3821 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
3822 assert_eq!(b_txn[2].lock_time, 0); // Success tx
3824 check_closed_broadcast!(nodes[1]);
3828 fn test_duplicate_payment_hash_one_failure_one_success() {
3829 // Topology : A --> B --> C
3830 // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
3831 let mut nodes = create_network(3);
3833 create_announced_chan_between_nodes(&nodes, 0, 1);
3834 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
3836 let (our_payment_preimage, duplicate_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
3837 *nodes[0].network_payment_count.borrow_mut() -= 1;
3838 assert_eq!(route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000).1, duplicate_payment_hash);
3840 let commitment_txn = nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().last_local_commitment_txn.clone();
3841 assert_eq!(commitment_txn[0].input.len(), 1);
3842 check_spends!(commitment_txn[0], chan_2.3.clone());
3844 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3845 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
3846 check_closed_broadcast!(nodes[1]);
3848 let htlc_timeout_tx;
3849 { // Extract one of the two HTLC-Timeout transaction
3850 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3851 assert_eq!(node_txn.len(), 7);
3852 assert_eq!(node_txn[0], node_txn[5]);
3853 assert_eq!(node_txn[1], node_txn[6]);
3854 check_spends!(node_txn[0], commitment_txn[0].clone());
3855 assert_eq!(node_txn[0].input.len(), 1);
3856 check_spends!(node_txn[1], commitment_txn[0].clone());
3857 assert_eq!(node_txn[1].input.len(), 1);
3858 assert_ne!(node_txn[0].input[0], node_txn[1].input[0]);
3859 check_spends!(node_txn[2], chan_2.3.clone());
3860 check_spends!(node_txn[3], node_txn[2].clone());
3861 check_spends!(node_txn[4], node_txn[2].clone());
3862 htlc_timeout_tx = node_txn[1].clone();
3865 nodes[2].node.claim_funds(our_payment_preimage);
3866 nodes[2].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
3867 check_added_monitors!(nodes[2], 2);
3868 let events = nodes[2].node.get_and_clear_pending_msg_events();
3870 MessageSendEvent::UpdateHTLCs { .. } => {},
3871 _ => panic!("Unexpected event"),
3874 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
3875 _ => panic!("Unexepected event"),
3877 let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
3878 assert_eq!(htlc_success_txn.len(), 5);
3879 check_spends!(htlc_success_txn[2], chan_2.3.clone());
3880 assert_eq!(htlc_success_txn[0], htlc_success_txn[3]);
3881 assert_eq!(htlc_success_txn[0].input.len(), 1);
3882 assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3883 assert_eq!(htlc_success_txn[1], htlc_success_txn[4]);
3884 assert_eq!(htlc_success_txn[1].input.len(), 1);
3885 assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3886 assert_ne!(htlc_success_txn[0].input[0], htlc_success_txn[1].input[0]);
3887 check_spends!(htlc_success_txn[0], commitment_txn[0].clone());
3888 check_spends!(htlc_success_txn[1], commitment_txn[0].clone());
3890 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![htlc_timeout_tx] }, 200);
3891 expect_pending_htlcs_forwardable!(nodes[1]);
3892 let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3893 assert!(htlc_updates.update_add_htlcs.is_empty());
3894 assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
3895 assert_eq!(htlc_updates.update_fail_htlcs[0].htlc_id, 1);
3896 assert!(htlc_updates.update_fulfill_htlcs.is_empty());
3897 assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
3898 check_added_monitors!(nodes[1], 1);
3900 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]).unwrap();
3901 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3903 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
3904 let events = nodes[0].node.get_and_clear_pending_msg_events();
3905 assert_eq!(events.len(), 1);
3907 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. } } => {
3909 _ => { panic!("Unexpected event"); }
3912 let events = nodes[0].node.get_and_clear_pending_events();
3914 Event::PaymentFailed { ref payment_hash, .. } => {
3915 assert_eq!(*payment_hash, duplicate_payment_hash);
3917 _ => panic!("Unexpected event"),
3920 // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
3921 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![htlc_success_txn[0].clone()] }, 200);
3922 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3923 assert!(updates.update_add_htlcs.is_empty());
3924 assert!(updates.update_fail_htlcs.is_empty());
3925 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3926 assert_eq!(updates.update_fulfill_htlcs[0].htlc_id, 0);
3927 assert!(updates.update_fail_malformed_htlcs.is_empty());
3928 check_added_monitors!(nodes[1], 1);
3930 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]).unwrap();
3931 commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
3933 let events = nodes[0].node.get_and_clear_pending_events();
3935 Event::PaymentSent { ref payment_preimage } => {
3936 assert_eq!(*payment_preimage, our_payment_preimage);
3938 _ => panic!("Unexpected event"),
3943 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
3944 let nodes = create_network(2);
3946 // Create some initial channels
3947 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
3949 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
3950 let local_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
3951 assert_eq!(local_txn[0].input.len(), 1);
3952 check_spends!(local_txn[0], chan_1.3.clone());
3954 // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
3955 nodes[1].node.claim_funds(payment_preimage);
3956 check_added_monitors!(nodes[1], 1);
3957 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3958 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![local_txn[0].clone()] }, 1);
3959 let events = nodes[1].node.get_and_clear_pending_msg_events();
3961 MessageSendEvent::UpdateHTLCs { .. } => {},
3962 _ => panic!("Unexpected event"),
3965 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
3966 _ => panic!("Unexepected event"),
3968 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3969 assert_eq!(node_txn[0].input.len(), 1);
3970 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3971 check_spends!(node_txn[0], local_txn[0].clone());
3973 // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
3974 let spend_txn = check_spendable_outputs!(nodes[1], 1);
3975 assert_eq!(spend_txn.len(), 2);
3976 check_spends!(spend_txn[0], node_txn[0].clone());
3977 check_spends!(spend_txn[1], node_txn[2].clone());
3980 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
3981 // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
3982 // unrevoked commitment transaction.
3983 // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
3984 // a remote RAA before they could be failed backwards (and combinations thereof).
3985 // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
3986 // use the same payment hashes.
3987 // Thus, we use a six-node network:
3992 // And test where C fails back to A/B when D announces its latest commitment transaction
3993 let nodes = create_network(6);
3995 create_announced_chan_between_nodes(&nodes, 0, 2);
3996 create_announced_chan_between_nodes(&nodes, 1, 2);
3997 let chan = create_announced_chan_between_nodes(&nodes, 2, 3);
3998 create_announced_chan_between_nodes(&nodes, 3, 4);
3999 create_announced_chan_between_nodes(&nodes, 3, 5);
4001 // Rebalance and check output sanity...
4002 send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000);
4003 send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000);
4004 assert_eq!(nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().last_local_commitment_txn[0].output.len(), 2);
4006 let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
4008 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
4010 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
4011 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();
4013 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
4015 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
4017 let (_, payment_hash_3) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4019 let (_, payment_hash_4) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4020 let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4022 send_along_route_with_hash(&nodes[1], route.clone(), &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_3);
4024 send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_4);
4027 let (_, payment_hash_5) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4029 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();
4030 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
4033 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
4035 let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4036 send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_6);
4038 // Double-check that six of the new HTLC were added
4039 // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
4040 // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
4041 assert_eq!(nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().last_local_commitment_txn.len(), 1);
4042 assert_eq!(nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().last_local_commitment_txn[0].output.len(), 8);
4044 // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
4045 // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
4046 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1));
4047 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3));
4048 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5));
4049 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6));
4050 check_added_monitors!(nodes[4], 0);
4051 expect_pending_htlcs_forwardable!(nodes[4]);
4052 check_added_monitors!(nodes[4], 1);
4054 let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
4055 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]).unwrap();
4056 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]).unwrap();
4057 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]).unwrap();
4058 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]).unwrap();
4059 commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
4061 // Fail 3rd below-dust and 7th above-dust HTLCs
4062 assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2));
4063 assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4));
4064 check_added_monitors!(nodes[5], 0);
4065 expect_pending_htlcs_forwardable!(nodes[5]);
4066 check_added_monitors!(nodes[5], 1);
4068 let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
4069 nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]).unwrap();
4070 nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]).unwrap();
4071 commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
4073 let ds_prev_commitment_tx = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().last_local_commitment_txn.clone();
4075 expect_pending_htlcs_forwardable!(nodes[3]);
4076 check_added_monitors!(nodes[3], 1);
4077 let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
4078 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]).unwrap();
4079 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]).unwrap();
4080 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]).unwrap();
4081 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]).unwrap();
4082 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]).unwrap();
4083 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]).unwrap();
4084 if deliver_last_raa {
4085 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
4087 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
4090 // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
4091 // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
4092 // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
4093 // propagated back to A/B yet (and D has two unrevoked commitment transactions).
4095 // We now broadcast the latest commitment transaction, which *should* result in failures for
4096 // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
4097 // the non-broadcast above-dust HTLCs.
4099 // Alternatively, we may broadcast the previous commitment transaction, which should only
4100 // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
4101 let ds_last_commitment_tx = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().last_local_commitment_txn.clone();
4103 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4104 if announce_latest {
4105 nodes[2].chain_monitor.block_connected_checked(&header, 1, &[&ds_last_commitment_tx[0]], &[1; 1]);
4107 nodes[2].chain_monitor.block_connected_checked(&header, 1, &[&ds_prev_commitment_tx[0]], &[1; 1]);
4109 check_closed_broadcast!(nodes[2]);
4110 expect_pending_htlcs_forwardable!(nodes[2]);
4111 check_added_monitors!(nodes[2], 2);
4113 let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
4114 assert_eq!(cs_msgs.len(), 2);
4115 let mut a_done = false;
4116 for msg in cs_msgs {
4118 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
4119 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
4120 // should be failed-backwards here.
4121 let target = if *node_id == nodes[0].node.get_our_node_id() {
4122 // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
4123 for htlc in &updates.update_fail_htlcs {
4124 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 });
4126 assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
4131 // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
4132 for htlc in &updates.update_fail_htlcs {
4133 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
4135 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
4136 assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
4139 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]).unwrap();
4140 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]).unwrap();
4141 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]).unwrap();
4142 if announce_latest {
4143 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]).unwrap();
4144 if *node_id == nodes[0].node.get_our_node_id() {
4145 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]).unwrap();
4148 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
4150 _ => panic!("Unexpected event"),
4154 let as_events = nodes[0].node.get_and_clear_pending_events();
4155 assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
4156 let mut as_failds = HashSet::new();
4157 for event in as_events.iter() {
4158 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
4159 assert!(as_failds.insert(*payment_hash));
4160 if *payment_hash != payment_hash_2 {
4161 assert_eq!(*rejected_by_dest, deliver_last_raa);
4163 assert!(!rejected_by_dest);
4165 } else { panic!("Unexpected event"); }
4167 assert!(as_failds.contains(&payment_hash_1));
4168 assert!(as_failds.contains(&payment_hash_2));
4169 if announce_latest {
4170 assert!(as_failds.contains(&payment_hash_3));
4171 assert!(as_failds.contains(&payment_hash_5));
4173 assert!(as_failds.contains(&payment_hash_6));
4175 let bs_events = nodes[1].node.get_and_clear_pending_events();
4176 assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
4177 let mut bs_failds = HashSet::new();
4178 for event in bs_events.iter() {
4179 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
4180 assert!(bs_failds.insert(*payment_hash));
4181 if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
4182 assert_eq!(*rejected_by_dest, deliver_last_raa);
4184 assert!(!rejected_by_dest);
4186 } else { panic!("Unexpected event"); }
4188 assert!(bs_failds.contains(&payment_hash_1));
4189 assert!(bs_failds.contains(&payment_hash_2));
4190 if announce_latest {
4191 assert!(bs_failds.contains(&payment_hash_4));
4193 assert!(bs_failds.contains(&payment_hash_5));
4195 // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
4196 // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
4197 // to unknown-preimage-etc, B should have gotten 2. Thus, in the
4198 // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
4199 // PaymentFailureNetworkUpdates.
4200 let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4201 assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
4202 let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
4203 assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
4204 for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
4206 &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
4207 _ => panic!("Unexpected event"),
4213 fn test_fail_backwards_latest_remote_announce_a() {
4214 do_test_fail_backwards_unrevoked_remote_announce(false, true);
4218 fn test_fail_backwards_latest_remote_announce_b() {
4219 do_test_fail_backwards_unrevoked_remote_announce(true, true);
4223 fn test_fail_backwards_previous_remote_announce() {
4224 do_test_fail_backwards_unrevoked_remote_announce(false, false);
4225 // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
4226 // tested for in test_commitment_revoked_fail_backward_exhaustive()
4230 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
4231 let nodes = create_network(2);
4233 // Create some initial channels
4234 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
4236 route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
4237 let local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
4238 assert_eq!(local_txn[0].input.len(), 1);
4239 check_spends!(local_txn[0], chan_1.3.clone());
4241 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
4242 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4243 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![local_txn[0].clone()] }, 200);
4244 check_closed_broadcast!(nodes[0]);
4246 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4247 assert_eq!(node_txn[0].input.len(), 1);
4248 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4249 check_spends!(node_txn[0], local_txn[0].clone());
4251 // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
4252 let spend_txn = check_spendable_outputs!(nodes[0], 1);
4253 assert_eq!(spend_txn.len(), 8);
4254 assert_eq!(spend_txn[0], spend_txn[2]);
4255 assert_eq!(spend_txn[0], spend_txn[4]);
4256 assert_eq!(spend_txn[0], spend_txn[6]);
4257 assert_eq!(spend_txn[1], spend_txn[3]);
4258 assert_eq!(spend_txn[1], spend_txn[5]);
4259 assert_eq!(spend_txn[1], spend_txn[7]);
4260 check_spends!(spend_txn[0], local_txn[0].clone());
4261 check_spends!(spend_txn[1], node_txn[0].clone());
4265 fn test_static_output_closing_tx() {
4266 let nodes = create_network(2);
4268 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
4270 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
4271 let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
4273 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4274 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![closing_tx.clone()] }, 1);
4275 let spend_txn = check_spendable_outputs!(nodes[0], 2);
4276 assert_eq!(spend_txn.len(), 1);
4277 check_spends!(spend_txn[0], closing_tx.clone());
4279 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![closing_tx.clone()] }, 1);
4280 let spend_txn = check_spendable_outputs!(nodes[1], 2);
4281 assert_eq!(spend_txn.len(), 1);
4282 check_spends!(spend_txn[0], closing_tx);
4285 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
4286 let nodes = create_network(2);
4287 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
4289 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
4291 // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
4292 // present in B's local commitment transaction, but none of A's commitment transactions.
4293 assert!(nodes[1].node.claim_funds(our_payment_preimage));
4294 check_added_monitors!(nodes[1], 1);
4296 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4297 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]).unwrap();
4298 let events = nodes[0].node.get_and_clear_pending_events();
4299 assert_eq!(events.len(), 1);
4301 Event::PaymentSent { payment_preimage } => {
4302 assert_eq!(payment_preimage, our_payment_preimage);
4304 _ => panic!("Unexpected event"),
4307 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed).unwrap();
4308 check_added_monitors!(nodes[0], 1);
4309 let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4310 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0).unwrap();
4311 check_added_monitors!(nodes[1], 1);
4313 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4314 for i in 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + CHAN_CONFIRM_DEPTH + 1 {
4315 nodes[1].chain_monitor.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
4316 header.prev_blockhash = header.bitcoin_hash();
4318 test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
4319 check_closed_broadcast!(nodes[1]);
4322 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
4323 let mut nodes = create_network(2);
4324 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
4326 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();
4327 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
4328 nodes[0].node.send_payment(route, payment_hash).unwrap();
4329 check_added_monitors!(nodes[0], 1);
4331 let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4333 // As far as A is concerned, the HTLC is now present only in the latest remote commitment
4334 // transaction, however it is not in A's latest local commitment, so we can just broadcast that
4335 // to "time out" the HTLC.
4337 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4338 for i in 1..TEST_FINAL_CLTV + HTLC_FAIL_TIMEOUT_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
4339 nodes[0].chain_monitor.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
4340 header.prev_blockhash = header.bitcoin_hash();
4342 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
4343 check_closed_broadcast!(nodes[0]);
4346 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
4347 let nodes = create_network(3);
4348 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
4350 // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
4351 // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
4352 // Also optionally test that we *don't* fail the channel in case the commitment transaction was
4353 // actually revoked.
4354 let htlc_value = if use_dust { 50000 } else { 3000000 };
4355 let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
4356 assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash));
4357 expect_pending_htlcs_forwardable!(nodes[1]);
4358 check_added_monitors!(nodes[1], 1);
4360 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4361 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]).unwrap();
4362 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed).unwrap();
4363 check_added_monitors!(nodes[0], 1);
4364 let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4365 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0).unwrap();
4366 check_added_monitors!(nodes[1], 1);
4367 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1).unwrap();
4368 check_added_monitors!(nodes[1], 1);
4369 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4371 if check_revoke_no_close {
4372 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
4373 check_added_monitors!(nodes[0], 1);
4376 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4377 for i in 1..TEST_FINAL_CLTV + HTLC_FAIL_TIMEOUT_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
4378 nodes[0].chain_monitor.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
4379 header.prev_blockhash = header.bitcoin_hash();
4381 if !check_revoke_no_close {
4382 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
4383 check_closed_broadcast!(nodes[0]);
4385 let events = nodes[0].node.get_and_clear_pending_events();
4386 assert_eq!(events.len(), 1);
4388 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
4389 assert_eq!(payment_hash, our_payment_hash);
4390 assert!(rejected_by_dest);
4392 _ => panic!("Unexpected event"),
4397 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
4398 // There are only a few cases to test here:
4399 // * its not really normative behavior, but we test that below-dust HTLCs "included" in
4400 // broadcastable commitment transactions result in channel closure,
4401 // * its included in an unrevoked-but-previous remote commitment transaction,
4402 // * its included in the latest remote or local commitment transactions.
4403 // We test each of the three possible commitment transactions individually and use both dust and
4405 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
4406 // assume they are handled the same across all six cases, as both outbound and inbound failures are
4407 // tested for at least one of the cases in other tests.
4409 fn htlc_claim_single_commitment_only_a() {
4410 do_htlc_claim_local_commitment_only(true);
4411 do_htlc_claim_local_commitment_only(false);
4413 do_htlc_claim_current_remote_commitment_only(true);
4414 do_htlc_claim_current_remote_commitment_only(false);
4418 fn htlc_claim_single_commitment_only_b() {
4419 do_htlc_claim_previous_remote_commitment_only(true, false);
4420 do_htlc_claim_previous_remote_commitment_only(false, false);
4421 do_htlc_claim_previous_remote_commitment_only(true, true);
4422 do_htlc_claim_previous_remote_commitment_only(false, true);
4425 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>)
4426 where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
4429 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);
4433 // 0: node1 fails backward
4434 // 1: final node fails backward
4435 // 2: payment completed but the user rejects the payment
4436 // 3: final node fails backward (but tamper onion payloads from node0)
4437 // 100: trigger error in the intermediate node and tamper returning fail_htlc
4438 // 200: trigger error in the final node and tamper returning fail_htlc
4439 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>)
4440 where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
4441 F2: for <'a> FnMut(&'a mut msgs::UpdateFailHTLC),
4444 use ln::msgs::HTLCFailChannelUpdate;
4446 // reset block height
4447 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4448 for ix in 0..nodes.len() {
4449 nodes[ix].chain_monitor.block_connected_checked(&header, 1, &Vec::new()[..], &[0; 0]);
4452 macro_rules! expect_event {
4453 ($node: expr, $event_type: path) => {{
4454 let events = $node.node.get_and_clear_pending_events();
4455 assert_eq!(events.len(), 1);
4457 $event_type { .. } => {},
4458 _ => panic!("Unexpected event"),
4463 macro_rules! expect_htlc_forward {
4465 expect_event!($node, Event::PendingHTLCsForwardable);
4466 $node.node.channel_state.lock().unwrap().next_forward = Instant::now();
4467 $node.node.process_pending_htlc_forwards();
4471 // 0 ~~> 2 send payment
4472 nodes[0].node.send_payment(route.clone(), payment_hash.clone()).unwrap();
4473 check_added_monitors!(nodes[0], 1);
4474 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4475 // temper update_add (0 => 1)
4476 let mut update_add_0 = update_0.update_add_htlcs[0].clone();
4477 if test_case == 0 || test_case == 3 || test_case == 100 {
4478 callback_msg(&mut update_add_0);
4481 // 0 => 1 update_add & CS
4482 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0).unwrap();
4483 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
4485 let update_1_0 = match test_case {
4486 0|100 => { // intermediate node failure; fail backward to 0
4487 let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4488 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));
4491 1|2|3|200 => { // final node failure; forwarding to 2
4492 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4494 if test_case != 200 {
4497 expect_htlc_forward!(&nodes[1]);
4499 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
4500 check_added_monitors!(&nodes[1], 1);
4501 assert_eq!(update_1.update_add_htlcs.len(), 1);
4502 // tamper update_add (1 => 2)
4503 let mut update_add_1 = update_1.update_add_htlcs[0].clone();
4504 if test_case != 3 && test_case != 200 {
4505 callback_msg(&mut update_add_1);
4509 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1).unwrap();
4510 commitment_signed_dance!(nodes[2], nodes[1], update_1.commitment_signed, false, true);
4512 if test_case == 2 || test_case == 200 {
4513 expect_htlc_forward!(&nodes[2]);
4514 expect_event!(&nodes[2], Event::PaymentReceived);
4516 expect_pending_htlcs_forwardable!(nodes[2]);
4519 let update_2_1 = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
4520 if test_case == 2 || test_case == 200 {
4521 check_added_monitors!(&nodes[2], 1);
4523 assert!(update_2_1.update_fail_htlcs.len() == 1);
4525 let mut fail_msg = update_2_1.update_fail_htlcs[0].clone();
4526 if test_case == 200 {
4527 callback_fail(&mut fail_msg);
4531 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &fail_msg).unwrap();
4532 commitment_signed_dance!(nodes[1], nodes[2], update_2_1.commitment_signed, true);
4534 // backward fail on 1
4535 let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4536 assert!(update_1_0.update_fail_htlcs.len() == 1);
4539 _ => unreachable!(),
4542 // 1 => 0 commitment_signed_dance
4543 if update_1_0.update_fail_htlcs.len() > 0 {
4544 let mut fail_msg = update_1_0.update_fail_htlcs[0].clone();
4545 if test_case == 100 {
4546 callback_fail(&mut fail_msg);
4548 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg).unwrap();
4550 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_1_0.update_fail_malformed_htlcs[0]).unwrap();
4553 commitment_signed_dance!(nodes[0], nodes[1], update_1_0.commitment_signed, false, true);
4555 let events = nodes[0].node.get_and_clear_pending_events();
4556 assert_eq!(events.len(), 1);
4557 if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code } = &events[0] {
4558 assert_eq!(*rejected_by_dest, !expected_retryable);
4559 assert_eq!(*error_code, expected_error_code);
4561 panic!("Uexpected event");
4564 let events = nodes[0].node.get_and_clear_pending_msg_events();
4565 if expected_channel_update.is_some() {
4566 assert_eq!(events.len(), 1);
4568 MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
4570 &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {
4571 if let HTLCFailChannelUpdate::ChannelUpdateMessage { .. } = expected_channel_update.unwrap() {} else {
4572 panic!("channel_update not found!");
4575 &HTLCFailChannelUpdate::ChannelClosed { ref short_channel_id, ref is_permanent } => {
4576 if let HTLCFailChannelUpdate::ChannelClosed { short_channel_id: ref expected_short_channel_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
4577 assert!(*short_channel_id == *expected_short_channel_id);
4578 assert!(*is_permanent == *expected_is_permanent);
4580 panic!("Unexpected message event");
4583 &HTLCFailChannelUpdate::NodeFailure { ref node_id, ref is_permanent } => {
4584 if let HTLCFailChannelUpdate::NodeFailure { node_id: ref expected_node_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
4585 assert!(*node_id == *expected_node_id);
4586 assert!(*is_permanent == *expected_is_permanent);
4588 panic!("Unexpected message event");
4593 _ => panic!("Unexpected message event"),
4596 assert_eq!(events.len(), 0);
4600 impl msgs::ChannelUpdate {
4601 fn dummy() -> msgs::ChannelUpdate {
4602 use secp256k1::ffi::Signature as FFISignature;
4603 use secp256k1::Signature;
4604 msgs::ChannelUpdate {
4605 signature: Signature::from(FFISignature::new()),
4606 contents: msgs::UnsignedChannelUpdate {
4607 chain_hash: Sha256dHash::hash(&vec![0u8][..]),
4608 short_channel_id: 0,
4611 cltv_expiry_delta: 0,
4612 htlc_minimum_msat: 0,
4614 fee_proportional_millionths: 0,
4615 excess_data: vec![],
4622 fn test_onion_failure() {
4623 use ln::msgs::ChannelUpdate;
4624 use ln::channelmanager::CLTV_FAR_FAR_AWAY;
4627 const BADONION: u16 = 0x8000;
4628 const PERM: u16 = 0x4000;
4629 const NODE: u16 = 0x2000;
4630 const UPDATE: u16 = 0x1000;
4632 let mut nodes = create_network(3);
4633 for node in nodes.iter() {
4634 *node.keys_manager.override_session_priv.lock().unwrap() = Some(SecretKey::from_slice(&[3; 32]).unwrap());
4636 let channels = [create_announced_chan_between_nodes(&nodes, 0, 1), create_announced_chan_between_nodes(&nodes, 1, 2)];
4637 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
4638 let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV).unwrap();
4640 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 40000);
4642 // intermediate node failure
4643 run_onion_failure_test("invalid_realm", 0, &nodes, &route, &payment_hash, |msg| {
4644 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4645 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
4646 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4647 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
4648 onion_payloads[0].realm = 3;
4649 msg.onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, &payment_hash);
4650 }, ||{}, 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
4652 // final node failure
4653 run_onion_failure_test("invalid_realm", 3, &nodes, &route, &payment_hash, |msg| {
4654 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4655 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
4656 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4657 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
4658 onion_payloads[1].realm = 3;
4659 msg.onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, &payment_hash);
4660 }, ||{}, false, Some(PERM|1), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
4662 // the following three with run_onion_failure_test_with_fail_intercept() test only the origin node
4663 // receiving simulated fail messages
4664 // intermediate node failure
4665 run_onion_failure_test_with_fail_intercept("temporary_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
4667 msg.amount_msat -= 1;
4669 // and tamper returning error message
4670 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4671 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4672 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], NODE|2, &[0;0]);
4673 }, ||{}, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: false}));
4675 // final node failure
4676 run_onion_failure_test_with_fail_intercept("temporary_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
4677 // and tamper returning error message
4678 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4679 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4680 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], NODE|2, &[0;0]);
4682 nodes[2].node.fail_htlc_backwards(&payment_hash);
4683 }, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: false}));
4685 // intermediate node failure
4686 run_onion_failure_test_with_fail_intercept("permanent_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
4687 msg.amount_msat -= 1;
4689 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4690 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4691 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|2, &[0;0]);
4692 }, ||{}, true, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: true}));
4694 // final node failure
4695 run_onion_failure_test_with_fail_intercept("permanent_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
4696 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4697 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4698 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|2, &[0;0]);
4700 nodes[2].node.fail_htlc_backwards(&payment_hash);
4701 }, false, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: true}));
4703 // intermediate node failure
4704 run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
4705 msg.amount_msat -= 1;
4707 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4708 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4709 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|3, &[0;0]);
4711 nodes[2].node.fail_htlc_backwards(&payment_hash);
4712 }, true, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: true}));
4714 // final node failure
4715 run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
4716 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4717 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4718 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|3, &[0;0]);
4720 nodes[2].node.fail_htlc_backwards(&payment_hash);
4721 }, false, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: true}));
4723 run_onion_failure_test("invalid_onion_version", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.version = 1; }, ||{}, true,
4724 Some(BADONION|PERM|4), None);
4726 run_onion_failure_test("invalid_onion_hmac", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.hmac = [3; 32]; }, ||{}, true,
4727 Some(BADONION|PERM|5), None);
4729 run_onion_failure_test("invalid_onion_key", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.public_key = Err(secp256k1::Error::InvalidPublicKey);}, ||{}, true,
4730 Some(BADONION|PERM|6), None);
4732 run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
4733 msg.amount_msat -= 1;
4735 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4736 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4737 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], UPDATE|7, &ChannelUpdate::dummy().encode_with_len()[..]);
4738 }, ||{}, true, Some(UPDATE|7), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
4740 run_onion_failure_test_with_fail_intercept("permanent_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
4741 msg.amount_msat -= 1;
4743 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4744 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4745 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|8, &[0;0]);
4746 // short_channel_id from the processing node
4747 }, ||{}, true, Some(PERM|8), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
4749 run_onion_failure_test_with_fail_intercept("required_channel_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
4750 msg.amount_msat -= 1;
4752 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4753 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4754 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|9, &[0;0]);
4755 // short_channel_id from the processing node
4756 }, ||{}, true, Some(PERM|9), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
4758 let mut bogus_route = route.clone();
4759 bogus_route.hops[1].short_channel_id -= 1;
4760 run_onion_failure_test("unknown_next_peer", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(PERM|10),
4761 Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: bogus_route.hops[1].short_channel_id, is_permanent:true}));
4763 let amt_to_forward = nodes[1].node.channel_state.lock().unwrap().by_id.get(&channels[1].2).unwrap().get_their_htlc_minimum_msat() - 1;
4764 let mut bogus_route = route.clone();
4765 let route_len = bogus_route.hops.len();
4766 bogus_route.hops[route_len-1].fee_msat = amt_to_forward;
4767 run_onion_failure_test("amount_below_minimum", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(UPDATE|11), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
4769 //TODO: with new config API, we will be able to generate both valid and
4770 //invalid channel_update cases.
4771 run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, |msg| {
4772 msg.amount_msat -= 1;
4773 }, || {}, true, Some(UPDATE|12), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
4775 run_onion_failure_test("incorrect_cltv_expiry", 0, &nodes, &route, &payment_hash, |msg| {
4776 // need to violate: cltv_expiry - cltv_expiry_delta >= outgoing_cltv_value
4777 msg.cltv_expiry -= 1;
4778 }, || {}, true, Some(UPDATE|13), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
4780 run_onion_failure_test("expiry_too_soon", 0, &nodes, &route, &payment_hash, |msg| {
4781 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - HTLC_FAIL_TIMEOUT_BLOCKS + 1;
4782 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4783 nodes[1].chain_monitor.block_connected_checked(&header, height, &Vec::new()[..], &[0; 0]);
4784 }, ||{}, true, Some(UPDATE|14), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
4786 run_onion_failure_test("unknown_payment_hash", 2, &nodes, &route, &payment_hash, |_| {}, || {
4787 nodes[2].node.fail_htlc_backwards(&payment_hash);
4788 }, false, Some(PERM|15), None);
4790 run_onion_failure_test("final_expiry_too_soon", 1, &nodes, &route, &payment_hash, |msg| {
4791 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - HTLC_FAIL_TIMEOUT_BLOCKS + 1;
4792 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4793 nodes[2].chain_monitor.block_connected_checked(&header, height, &Vec::new()[..], &[0; 0]);
4794 }, || {}, true, Some(17), None);
4796 run_onion_failure_test("final_incorrect_cltv_expiry", 1, &nodes, &route, &payment_hash, |_| {}, || {
4797 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().borrow_parts().forward_htlcs.iter_mut() {
4798 for f in pending_forwards.iter_mut() {
4800 &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
4801 forward_info.outgoing_cltv_value += 1,
4806 }, true, Some(18), None);
4808 run_onion_failure_test("final_incorrect_htlc_amount", 1, &nodes, &route, &payment_hash, |_| {}, || {
4809 // violate amt_to_forward > msg.amount_msat
4810 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().borrow_parts().forward_htlcs.iter_mut() {
4811 for f in pending_forwards.iter_mut() {
4813 &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
4814 forward_info.amt_to_forward -= 1,
4819 }, true, Some(19), None);
4821 run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, |_| {}, || {
4822 // disconnect event to the channel between nodes[1] ~ nodes[2]
4823 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
4824 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4825 }, true, Some(UPDATE|20), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
4826 reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4828 run_onion_failure_test("expiry_too_far", 0, &nodes, &route, &payment_hash, |msg| {
4829 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4830 let mut route = route.clone();
4832 route.hops[1].cltv_expiry_delta += CLTV_FAR_FAR_AWAY + route.hops[0].cltv_expiry_delta + 1;
4833 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4834 let (onion_payloads, _, htlc_cltv) = onion_utils::build_onion_payloads(&route, height).unwrap();
4835 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, &payment_hash);
4836 msg.cltv_expiry = htlc_cltv;
4837 msg.onion_routing_packet = onion_packet;
4838 }, ||{}, true, Some(21), None);
4843 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
4844 let nodes = create_network(2);
4845 //Force duplicate channel ids
4846 for node in nodes.iter() {
4847 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
4850 // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
4851 let channel_value_satoshis=10000;
4852 let push_msat=10001;
4853 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).unwrap();
4854 let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
4855 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &node0_to_1_send_open_channel).unwrap();
4857 //Create a second channel with a channel_id collision
4858 assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).is_err());
4862 fn bolt2_open_channel_sending_node_checks_part2() {
4863 let nodes = create_network(2);
4865 // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
4866 let channel_value_satoshis=2^24;
4867 let push_msat=10001;
4868 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).is_err());
4870 // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
4871 let channel_value_satoshis=10000;
4872 // Test when push_msat is equal to 1000 * funding_satoshis.
4873 let push_msat=1000*channel_value_satoshis+1;
4874 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).is_err());
4876 // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
4877 let channel_value_satoshis=10000;
4878 let push_msat=10001;
4879 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
4880 let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
4881 assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
4883 // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
4884 // 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
4885 assert!(node0_to_1_send_open_channel.channel_flags<=1);
4887 // 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.
4888 assert!(BREAKDOWN_TIMEOUT>0);
4889 assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
4891 // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
4892 let chain_hash=genesis_block(Network::Testnet).header.bitcoin_hash();
4893 assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
4895 // 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.
4896 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
4897 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
4898 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
4899 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_basepoint.serialize()).is_ok());
4900 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
4903 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
4904 // 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.
4905 //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.
4908 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
4909 //BOLT2 Requirement: MUST offer amount_msat greater than 0.
4910 //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
4911 let mut nodes = create_network(2);
4912 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
4913 let mut route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
4914 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4916 route.hops[0].fee_msat = 0;
4918 let err = nodes[0].node.send_payment(route, our_payment_hash);
4920 if let Err(APIError::ChannelUnavailable{err}) = err {
4921 assert_eq!(err, "Cannot send less than their minimum HTLC value");
4928 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
4929 //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
4930 //It is enforced when constructing a route.
4931 let mut nodes = create_network(2);
4932 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 0);
4933 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000000, 500000001).unwrap();
4934 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4936 let err = nodes[0].node.send_payment(route, our_payment_hash);
4938 if let Err(APIError::RouteError{err}) = err {
4939 assert_eq!(err, "Channel CLTV overflowed?!");
4946 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
4947 //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.
4948 //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
4949 //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
4950 let mut nodes = create_network(2);
4951 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0);
4952 let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().their_max_accepted_htlcs as u64;
4954 for i in 0..max_accepted_htlcs {
4955 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
4956 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4957 let payment_event = {
4958 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
4959 check_added_monitors!(nodes[0], 1);
4961 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4962 assert_eq!(events.len(), 1);
4963 if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
4964 assert_eq!(htlcs[0].htlc_id, i);
4968 SendEvent::from_event(events.remove(0))
4970 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
4971 check_added_monitors!(nodes[1], 0);
4972 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4974 expect_pending_htlcs_forwardable!(nodes[1]);
4975 expect_payment_received!(nodes[1], our_payment_hash, 100000);
4977 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
4978 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4979 let err = nodes[0].node.send_payment(route, our_payment_hash);
4981 if let Err(APIError::ChannelUnavailable{err}) = err {
4982 assert_eq!(err, "Cannot push more than their max accepted HTLCs");
4989 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
4990 //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.
4991 let mut nodes = create_network(2);
4992 let channel_value = 100000;
4993 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0);
4994 let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).their_max_htlc_value_in_flight_msat;
4996 send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight);
4998 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], max_in_flight+1, TEST_FINAL_CLTV).unwrap();
4999 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5000 let err = nodes[0].node.send_payment(route, our_payment_hash);
5002 if let Err(APIError::ChannelUnavailable{err}) = err {
5003 assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight");
5008 send_payment(&nodes[0], &[&nodes[1]], max_in_flight);
5011 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
5013 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
5014 //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
5015 let mut nodes = create_network(2);
5016 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
5017 let htlc_minimum_msat: u64;
5019 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
5020 let channel = chan_lock.by_id.get(&chan.2).unwrap();
5021 htlc_minimum_msat = channel.get_our_htlc_minimum_msat();
5023 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], htlc_minimum_msat, TEST_FINAL_CLTV).unwrap();
5024 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5025 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5026 check_added_monitors!(nodes[0], 1);
5027 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5028 updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
5029 let err = nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5030 if let Err(msgs::HandleError{err, action: Some(msgs::ErrorAction::SendErrorMessage {..})}) = err {
5031 assert_eq!(err, "Remote side tried to send less than our minimum HTLC value");
5035 assert!(nodes[1].node.list_channels().is_empty());
5036 check_closed_broadcast!(nodes[1]);
5040 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
5041 //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
5042 let mut nodes = create_network(2);
5043 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
5045 let their_channel_reserve = get_channel_value_stat!(nodes[0], chan.2).channel_reserve_msat;
5047 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 5000000-their_channel_reserve, TEST_FINAL_CLTV).unwrap();
5048 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5049 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5050 check_added_monitors!(nodes[0], 1);
5051 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5053 updates.update_add_htlcs[0].amount_msat = 5000000-their_channel_reserve+1;
5054 let err = nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5056 if let Err(msgs::HandleError{err, action: Some(msgs::ErrorAction::SendErrorMessage {..})}) = err {
5057 assert_eq!(err, "Remote HTLC add would put them over their reserve value");
5062 assert!(nodes[1].node.list_channels().is_empty());
5063 check_closed_broadcast!(nodes[1]);
5067 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
5068 //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
5069 //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
5070 let mut nodes = create_network(2);
5071 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
5072 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 3999999, TEST_FINAL_CLTV).unwrap();
5073 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5075 let session_priv = SecretKey::from_slice(&{
5076 let mut session_key = [0; 32];
5077 rng::fill_bytes(&mut session_key);
5079 }).expect("RNG is bad!");
5081 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5082 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route, &session_priv).unwrap();
5083 let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
5084 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, &our_payment_hash);
5086 let mut msg = msgs::UpdateAddHTLC {
5090 payment_hash: our_payment_hash,
5091 cltv_expiry: htlc_cltv,
5092 onion_routing_packet: onion_packet.clone(),
5095 for i in 0..super::channel::OUR_MAX_HTLCS {
5096 msg.htlc_id = i as u64;
5097 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg).unwrap();
5099 msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
5100 let err = nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
5102 if let Err(msgs::HandleError{err, action: Some(msgs::ErrorAction::SendErrorMessage {..})}) = err {
5103 assert_eq!(err, "Remote tried to push more than our max accepted HTLCs");
5108 assert!(nodes[1].node.list_channels().is_empty());
5109 check_closed_broadcast!(nodes[1]);
5113 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
5114 //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
5115 let mut nodes = create_network(2);
5116 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000);
5117 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5118 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5119 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5120 check_added_monitors!(nodes[0], 1);
5121 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5122 updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).their_max_htlc_value_in_flight_msat + 1;
5123 let err = nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5125 if let Err(msgs::HandleError{err, action: Some(msgs::ErrorAction::SendErrorMessage {..})}) = err {
5126 assert_eq!(err,"Remote HTLC add would put them over their max HTLC value in flight");
5131 assert!(nodes[1].node.list_channels().is_empty());
5132 check_closed_broadcast!(nodes[1]);
5136 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
5137 //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
5138 let mut nodes = create_network(2);
5139 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
5140 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 3999999, TEST_FINAL_CLTV).unwrap();
5141 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5142 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5143 check_added_monitors!(nodes[0], 1);
5144 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5145 updates.update_add_htlcs[0].cltv_expiry = 500000000;
5146 let err = nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5148 if let Err(msgs::HandleError{err, action: Some(msgs::ErrorAction::SendErrorMessage {..})}) = err {
5149 assert_eq!(err,"Remote provided CLTV expiry in seconds instead of block height");
5154 assert!(nodes[1].node.list_channels().is_empty());
5155 check_closed_broadcast!(nodes[1]);
5159 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
5160 //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
5161 // We test this by first testing that that repeated HTLCs pass commitment signature checks
5162 // after disconnect and that non-sequential htlc_ids result in a channel failure.
5163 let mut nodes = create_network(2);
5164 create_announced_chan_between_nodes(&nodes, 0, 1);
5165 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5166 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5167 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5168 check_added_monitors!(nodes[0], 1);
5169 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5170 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]).unwrap();
5172 //Disconnect and Reconnect
5173 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5174 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5175 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
5176 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
5177 assert_eq!(reestablish_1.len(), 1);
5178 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
5179 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
5180 assert_eq!(reestablish_2.len(), 1);
5181 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]).unwrap();
5182 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
5183 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]).unwrap();
5184 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
5187 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]).unwrap();
5188 assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
5189 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed).unwrap();
5190 check_added_monitors!(nodes[1], 1);
5191 let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5193 let err = nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5194 if let Err(msgs::HandleError{err, action: Some(msgs::ErrorAction::SendErrorMessage {..})}) = err {
5195 assert_eq!(err, "Remote skipped HTLC ID");
5200 assert!(nodes[1].node.list_channels().is_empty());
5201 check_closed_broadcast!(nodes[1]);
5205 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
5206 //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.
5208 let mut nodes = create_network(2);
5209 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
5211 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5212 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5213 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5214 check_added_monitors!(nodes[0], 1);
5215 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5216 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]).unwrap();
5218 let update_msg = msgs::UpdateFulfillHTLC{
5221 payment_preimage: our_payment_preimage,
5224 let err = nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5226 if let Err(msgs::HandleError{err, action: Some(msgs::ErrorAction::SendErrorMessage {..})}) = err {
5227 assert_eq!(err, "Remote tried to fulfill/fail HTLC before it had been committed");
5232 assert!(nodes[0].node.list_channels().is_empty());
5233 check_closed_broadcast!(nodes[0]);
5237 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
5238 //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.
5240 let mut nodes = create_network(2);
5241 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
5243 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5244 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5245 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5246 check_added_monitors!(nodes[0], 1);
5247 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5248 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]).unwrap();
5250 let update_msg = msgs::UpdateFailHTLC{
5253 reason: msgs::OnionErrorPacket { data: Vec::new()},
5256 let err = nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5258 if let Err(msgs::HandleError{err, action: Some(msgs::ErrorAction::SendErrorMessage {..})}) = err {
5259 assert_eq!(err, "Remote tried to fulfill/fail HTLC before it had been committed");
5264 assert!(nodes[0].node.list_channels().is_empty());
5265 check_closed_broadcast!(nodes[0]);
5269 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
5270 //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.
5272 let mut nodes = create_network(2);
5273 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
5275 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5276 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5277 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5278 check_added_monitors!(nodes[0], 1);
5279 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5280 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]).unwrap();
5282 let update_msg = msgs::UpdateFailMalformedHTLC{
5285 sha256_of_onion: [1; 32],
5286 failure_code: 0x8000,
5289 let err = nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5291 if let Err(msgs::HandleError{err, action: Some(msgs::ErrorAction::SendErrorMessage {..})}) = err {
5292 assert_eq!(err, "Remote tried to fulfill/fail HTLC before it had been committed");
5297 assert!(nodes[0].node.list_channels().is_empty());
5298 check_closed_broadcast!(nodes[0]);
5302 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
5303 //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
5305 let nodes = create_network(2);
5306 create_announced_chan_between_nodes(&nodes, 0, 1);
5308 let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
5310 nodes[1].node.claim_funds(our_payment_preimage);
5311 check_added_monitors!(nodes[1], 1);
5313 let events = nodes[1].node.get_and_clear_pending_msg_events();
5314 assert_eq!(events.len(), 1);
5315 let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
5317 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, .. } } => {
5318 assert!(update_add_htlcs.is_empty());
5319 assert_eq!(update_fulfill_htlcs.len(), 1);
5320 assert!(update_fail_htlcs.is_empty());
5321 assert!(update_fail_malformed_htlcs.is_empty());
5322 assert!(update_fee.is_none());
5323 update_fulfill_htlcs[0].clone()
5325 _ => panic!("Unexpected event"),
5329 update_fulfill_msg.htlc_id = 1;
5331 let err = nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
5332 if let Err(msgs::HandleError{err, action: Some(msgs::ErrorAction::SendErrorMessage {..})}) = err {
5333 assert_eq!(err, "Remote tried to fulfill/fail an HTLC we couldn't find");
5338 assert!(nodes[0].node.list_channels().is_empty());
5339 check_closed_broadcast!(nodes[0]);
5343 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
5344 //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.
5346 let nodes = create_network(2);
5347 create_announced_chan_between_nodes(&nodes, 0, 1);
5349 let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
5351 nodes[1].node.claim_funds(our_payment_preimage);
5352 check_added_monitors!(nodes[1], 1);
5354 let events = nodes[1].node.get_and_clear_pending_msg_events();
5355 assert_eq!(events.len(), 1);
5356 let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
5358 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, .. } } => {
5359 assert!(update_add_htlcs.is_empty());
5360 assert_eq!(update_fulfill_htlcs.len(), 1);
5361 assert!(update_fail_htlcs.is_empty());
5362 assert!(update_fail_malformed_htlcs.is_empty());
5363 assert!(update_fee.is_none());
5364 update_fulfill_htlcs[0].clone()
5366 _ => panic!("Unexpected event"),
5370 update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
5372 let err = nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
5373 if let Err(msgs::HandleError{err, action: Some(msgs::ErrorAction::SendErrorMessage {..})}) = err {
5374 assert_eq!(err, "Remote tried to fulfill HTLC with an incorrect preimage");
5379 assert!(nodes[0].node.list_channels().is_empty());
5380 check_closed_broadcast!(nodes[0]);
5385 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
5386 //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.
5388 let mut nodes = create_network(2);
5389 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000);
5390 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5391 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5392 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5393 check_added_monitors!(nodes[0], 1);
5395 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5396 updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
5398 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]).unwrap();
5399 check_added_monitors!(nodes[1], 0);
5400 commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
5402 let events = nodes[1].node.get_and_clear_pending_msg_events();
5404 let mut update_msg: msgs::UpdateFailMalformedHTLC = {
5406 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, .. } } => {
5407 assert!(update_add_htlcs.is_empty());
5408 assert!(update_fulfill_htlcs.is_empty());
5409 assert!(update_fail_htlcs.is_empty());
5410 assert_eq!(update_fail_malformed_htlcs.len(), 1);
5411 assert!(update_fee.is_none());
5412 update_fail_malformed_htlcs[0].clone()
5414 _ => panic!("Unexpected event"),
5417 update_msg.failure_code &= !0x8000;
5418 let err = nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5419 if let Err(msgs::HandleError{err, action: Some(msgs::ErrorAction::SendErrorMessage {..})}) = err {
5420 assert_eq!(err, "Got update_fail_malformed_htlc with BADONION not set");
5425 assert!(nodes[0].node.list_channels().is_empty());
5426 check_closed_broadcast!(nodes[0]);
5430 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
5431 //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
5432 // * 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.
5434 let mut nodes = create_network(3);
5435 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000);
5436 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000);
5438 let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
5439 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5442 let mut payment_event = {
5443 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5444 check_added_monitors!(nodes[0], 1);
5445 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5446 assert_eq!(events.len(), 1);
5447 SendEvent::from_event(events.remove(0))
5449 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
5450 check_added_monitors!(nodes[1], 0);
5451 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
5452 expect_pending_htlcs_forwardable!(nodes[1]);
5453 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
5454 assert_eq!(events_2.len(), 1);
5455 check_added_monitors!(nodes[1], 1);
5456 payment_event = SendEvent::from_event(events_2.remove(0));
5457 assert_eq!(payment_event.msgs.len(), 1);
5460 payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
5461 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
5462 check_added_monitors!(nodes[2], 0);
5463 commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
5465 let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
5466 assert_eq!(events_3.len(), 1);
5467 let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
5469 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 } } => {
5470 assert!(update_add_htlcs.is_empty());
5471 assert!(update_fulfill_htlcs.is_empty());
5472 assert!(update_fail_htlcs.is_empty());
5473 assert_eq!(update_fail_malformed_htlcs.len(), 1);
5474 assert!(update_fee.is_none());
5475 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
5477 _ => panic!("Unexpected event"),
5481 nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0).unwrap();
5483 check_added_monitors!(nodes[1], 0);
5484 commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
5485 expect_pending_htlcs_forwardable!(nodes[1]);
5486 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
5487 assert_eq!(events_4.len(), 1);
5489 //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
5491 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, .. } } => {
5492 assert!(update_add_htlcs.is_empty());
5493 assert!(update_fulfill_htlcs.is_empty());
5494 assert_eq!(update_fail_htlcs.len(), 1);
5495 assert!(update_fail_malformed_htlcs.is_empty());
5496 assert!(update_fee.is_none());
5498 _ => panic!("Unexpected event"),
5501 check_added_monitors!(nodes[1], 1);