1 //! Tests that test standing up a network of ChannelManagers, creating channels, sending
2 //! payments/messages between them, and often checking the resulting ChannelMonitors are able to
3 //! claim outputs on-chain.
5 use chain::transaction::OutPoint;
6 use chain::keysinterface::{ChannelKeys, KeysInterface, SpendableOutputDescriptor};
7 use chain::chaininterface::{ChainListener, ChainWatchInterfaceUtil, BlockNotifier};
8 use ln::channel::{COMMITMENT_TX_BASE_WEIGHT, COMMITMENT_TX_WEIGHT_PER_HTLC};
9 use ln::channelmanager::{ChannelManager,ChannelManagerReadArgs,HTLCForwardInfo,RAACommitmentOrder, PaymentPreimage, PaymentHash, BREAKDOWN_TIMEOUT};
10 use ln::channelmonitor::{ChannelMonitor, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ManyChannelMonitor, ANTI_REORG_DELAY};
11 use ln::channel::{Channel, ChannelError};
12 use ln::{chan_utils, onion_utils};
13 use ln::router::{Route, RouteHop};
14 use ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
16 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler,HTLCFailChannelUpdate, ErrorAction};
17 use util::enforcing_trait_impls::EnforcingChannelKeys;
19 use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
20 use util::errors::APIError;
21 use util::ser::{Writeable, Writer, ReadableArgs};
22 use util::config::UserConfig;
23 use util::logger::Logger;
25 use bitcoin::util::hash::BitcoinHash;
26 use bitcoin_hashes::sha256d::Hash as Sha256dHash;
27 use bitcoin::util::bip143;
28 use bitcoin::util::address::Address;
29 use bitcoin::util::bip32::{ChildNumber, ExtendedPubKey, ExtendedPrivKey};
30 use bitcoin::blockdata::block::{Block, BlockHeader};
31 use bitcoin::blockdata::transaction::{Transaction, TxOut, TxIn, SigHashType, OutPoint as BitcoinOutPoint};
32 use bitcoin::blockdata::script::{Builder, Script};
33 use bitcoin::blockdata::opcodes;
34 use bitcoin::blockdata::constants::genesis_block;
35 use bitcoin::network::constants::Network;
37 use bitcoin_hashes::sha256::Hash as Sha256;
38 use bitcoin_hashes::Hash;
40 use secp256k1::{Secp256k1, Message};
41 use secp256k1::key::{PublicKey,SecretKey};
43 use std::collections::{BTreeSet, HashMap, HashSet};
44 use std::default::Default;
45 use std::sync::{Arc, Mutex};
46 use std::sync::atomic::Ordering;
49 use rand::{thread_rng, Rng};
51 use ln::functional_test_utils::*;
54 fn test_insane_channel_opens() {
55 // Stand up a network of 2 nodes
56 let chanmon_cfgs = create_chanmon_cfgs(2);
57 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
58 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
59 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
61 // Instantiate channel parameters where we push the maximum msats given our
63 let channel_value_sat = 31337; // same as funding satoshis
64 let channel_reserve_satoshis = Channel::<EnforcingChannelKeys>::get_our_channel_reserve_satoshis(channel_value_sat);
65 let push_msat = (channel_value_sat - channel_reserve_satoshis) * 1000;
67 // Have node0 initiate a channel to node1 with aforementioned parameters
68 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_sat, push_msat, 42).unwrap();
70 // Extract the channel open message from node0 to node1
71 let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
73 // Test helper that asserts we get the correct error string given a mutator
74 // that supposedly makes the channel open message insane
75 let insane_open_helper = |expected_error_str: &str, message_mutator: fn(msgs::OpenChannel) -> msgs::OpenChannel| {
76 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::supported(), &message_mutator(open_channel_message.clone()));
77 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
78 assert_eq!(msg_events.len(), 1);
79 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
81 &ErrorAction::SendErrorMessage { .. } => {
82 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), expected_error_str.to_string(), 1);
84 _ => panic!("unexpected event!"),
86 } else { assert!(false); }
89 use ln::channel::MAX_FUNDING_SATOSHIS;
90 use ln::channelmanager::MAX_LOCAL_BREAKDOWN_TIMEOUT;
92 // Test all mutations that would make the channel open message insane
93 insane_open_helper("funding value > 2^24", |mut msg| { msg.funding_satoshis = MAX_FUNDING_SATOSHIS; msg });
95 insane_open_helper("Bogus channel_reserve_satoshis", |mut msg| { msg.channel_reserve_satoshis = msg.funding_satoshis + 1; msg });
97 insane_open_helper("push_msat larger than funding value", |mut msg| { msg.push_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 + 1; msg });
99 insane_open_helper("Peer never wants payout outputs?", |mut msg| { msg.dust_limit_satoshis = msg.funding_satoshis + 1 ; msg });
101 insane_open_helper("Bogus; channel reserve is less than dust limit", |mut msg| { msg.dust_limit_satoshis = msg.channel_reserve_satoshis + 1; msg });
103 insane_open_helper("Minimum htlc value is full channel value", |mut msg| { msg.htlc_minimum_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000; msg });
105 insane_open_helper("They wanted our payments to be delayed by a needlessly long period", |mut msg| { msg.to_self_delay = MAX_LOCAL_BREAKDOWN_TIMEOUT + 1; msg });
107 insane_open_helper("0 max_accpted_htlcs makes for a useless channel", |mut msg| { msg.max_accepted_htlcs = 0; msg });
109 insane_open_helper("max_accpted_htlcs > 483", |mut msg| { msg.max_accepted_htlcs = 484; msg });
113 fn test_async_inbound_update_fee() {
114 let chanmon_cfgs = create_chanmon_cfgs(2);
115 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
116 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
117 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
118 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
119 let channel_id = chan.2;
122 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
126 // send (1) commitment_signed -.
127 // <- update_add_htlc/commitment_signed
128 // send (2) RAA (awaiting remote revoke) -.
129 // (1) commitment_signed is delivered ->
130 // .- send (3) RAA (awaiting remote revoke)
131 // (2) RAA is delivered ->
132 // .- send (4) commitment_signed
133 // <- (3) RAA is delivered
134 // send (5) commitment_signed -.
135 // <- (4) commitment_signed is delivered
137 // (5) commitment_signed is delivered ->
139 // (6) RAA is delivered ->
141 // First nodes[0] generates an update_fee
142 nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
143 check_added_monitors!(nodes[0], 1);
145 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
146 assert_eq!(events_0.len(), 1);
147 let (update_msg, commitment_signed) = match events_0[0] { // (1)
148 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
149 (update_fee.as_ref(), commitment_signed)
151 _ => panic!("Unexpected event"),
154 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
156 // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
157 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
158 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();
159 check_added_monitors!(nodes[1], 1);
161 let payment_event = {
162 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
163 assert_eq!(events_1.len(), 1);
164 SendEvent::from_event(events_1.remove(0))
166 assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
167 assert_eq!(payment_event.msgs.len(), 1);
169 // ...now when the messages get delivered everyone should be happy
170 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
171 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
172 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
173 // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
174 check_added_monitors!(nodes[0], 1);
176 // deliver(1), generate (3):
177 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
178 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
179 // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
180 check_added_monitors!(nodes[1], 1);
182 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack); // deliver (2)
183 let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
184 assert!(bs_update.update_add_htlcs.is_empty()); // (4)
185 assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
186 assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
187 assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
188 assert!(bs_update.update_fee.is_none()); // (4)
189 check_added_monitors!(nodes[1], 1);
191 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack); // deliver (3)
192 let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
193 assert!(as_update.update_add_htlcs.is_empty()); // (5)
194 assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
195 assert!(as_update.update_fail_htlcs.is_empty()); // (5)
196 assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
197 assert!(as_update.update_fee.is_none()); // (5)
198 check_added_monitors!(nodes[0], 1);
200 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed); // deliver (4)
201 let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
202 // only (6) so get_event_msg's assert(len == 1) passes
203 check_added_monitors!(nodes[0], 1);
205 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed); // deliver (5)
206 let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
207 check_added_monitors!(nodes[1], 1);
209 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
210 check_added_monitors!(nodes[0], 1);
212 let events_2 = nodes[0].node.get_and_clear_pending_events();
213 assert_eq!(events_2.len(), 1);
215 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
216 _ => panic!("Unexpected event"),
219 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke); // deliver (6)
220 check_added_monitors!(nodes[1], 1);
224 fn test_update_fee_unordered_raa() {
225 // Just the intro to the previous test followed by an out-of-order RAA (which caused a
226 // crash in an earlier version of the update_fee patch)
227 let chanmon_cfgs = create_chanmon_cfgs(2);
228 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
229 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
230 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
231 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
232 let channel_id = chan.2;
235 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
237 // First nodes[0] generates an update_fee
238 nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 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 = match events_0[0] { // (1)
244 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
247 _ => panic!("Unexpected event"),
250 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
252 // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
253 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
254 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();
255 check_added_monitors!(nodes[1], 1);
257 let payment_event = {
258 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
259 assert_eq!(events_1.len(), 1);
260 SendEvent::from_event(events_1.remove(0))
262 assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
263 assert_eq!(payment_event.msgs.len(), 1);
265 // ...now when the messages get delivered everyone should be happy
266 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
267 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
268 let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
269 // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
270 check_added_monitors!(nodes[0], 1);
272 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg); // deliver (2)
273 check_added_monitors!(nodes[1], 1);
275 // We can't continue, sadly, because our (1) now has a bogus signature
279 fn test_multi_flight_update_fee() {
280 let chanmon_cfgs = create_chanmon_cfgs(2);
281 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
282 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
283 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
284 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
285 let channel_id = chan.2;
288 // update_fee/commitment_signed ->
289 // .- send (1) RAA and (2) commitment_signed
290 // update_fee (never committed) ->
292 // We have to manually generate the above update_fee, it is allowed by the protocol but we
293 // don't track which updates correspond to which revoke_and_ack responses so we're in
294 // AwaitingRAA mode and will not generate the update_fee yet.
295 // <- (1) RAA delivered
296 // (3) is generated and send (4) CS -.
297 // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
298 // know the per_commitment_point to use for it.
299 // <- (2) commitment_signed delivered
301 // B should send no response here
302 // (4) commitment_signed delivered ->
303 // <- RAA/commitment_signed delivered
306 // First nodes[0] generates an update_fee
307 let initial_feerate = get_feerate!(nodes[0], channel_id);
308 nodes[0].node.update_fee(channel_id, initial_feerate + 20).unwrap();
309 check_added_monitors!(nodes[0], 1);
311 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
312 assert_eq!(events_0.len(), 1);
313 let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
314 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
315 (update_fee.as_ref().unwrap(), commitment_signed)
317 _ => panic!("Unexpected event"),
320 // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
321 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1);
322 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1);
323 let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
324 check_added_monitors!(nodes[1], 1);
326 // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
328 nodes[0].node.update_fee(channel_id, initial_feerate + 40).unwrap();
329 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
330 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
332 // Create the (3) update_fee message that nodes[0] will generate before it does...
333 let mut update_msg_2 = msgs::UpdateFee {
334 channel_id: update_msg_1.channel_id.clone(),
335 feerate_per_kw: (initial_feerate + 30) as u32,
338 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
340 update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
342 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
344 // Deliver (1), generating (3) and (4)
345 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg);
346 let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
347 check_added_monitors!(nodes[0], 1);
348 assert!(as_second_update.update_add_htlcs.is_empty());
349 assert!(as_second_update.update_fulfill_htlcs.is_empty());
350 assert!(as_second_update.update_fail_htlcs.is_empty());
351 assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
352 // Check that the update_fee newly generated matches what we delivered:
353 assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
354 assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
356 // Deliver (2) commitment_signed
357 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
358 let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
359 check_added_monitors!(nodes[0], 1);
360 // No commitment_signed so get_event_msg's assert(len == 1) passes
362 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg);
363 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
364 check_added_monitors!(nodes[1], 1);
367 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
368 let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
369 check_added_monitors!(nodes[1], 1);
371 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
372 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
373 check_added_monitors!(nodes[0], 1);
375 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment);
376 let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
377 // No commitment_signed so get_event_msg's assert(len == 1) passes
378 check_added_monitors!(nodes[0], 1);
380 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke);
381 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
382 check_added_monitors!(nodes[1], 1);
386 fn test_1_conf_open() {
387 // Previously, if the minium_depth config was set to 1, we'd never send a funding_locked. This
388 // tests that we properly send one in that case.
389 let mut alice_config = UserConfig::default();
390 alice_config.own_channel_config.minimum_depth = 1;
391 alice_config.channel_options.announced_channel = true;
392 alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
393 let mut bob_config = UserConfig::default();
394 bob_config.own_channel_config.minimum_depth = 1;
395 bob_config.channel_options.announced_channel = true;
396 bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
397 let chanmon_cfgs = create_chanmon_cfgs(2);
398 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
399 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(alice_config), Some(bob_config)]);
400 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
402 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
403 assert!(nodes[0].chain_monitor.does_match_tx(&tx));
404 assert!(nodes[1].chain_monitor.does_match_tx(&tx));
406 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
407 nodes[1].block_notifier.block_connected_checked(&header, 1, &[&tx; 1], &[tx.version; 1]);
408 nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendFundingLocked, nodes[0].node.get_our_node_id()));
410 nodes[0].block_notifier.block_connected_checked(&header, 1, &[&tx; 1], &[tx.version; 1]);
411 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
412 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
415 assert!(node.router.handle_channel_announcement(&announcement).unwrap());
416 node.router.handle_channel_update(&as_update).unwrap();
417 node.router.handle_channel_update(&bs_update).unwrap();
421 fn do_test_sanity_on_in_flight_opens(steps: u8) {
422 // Previously, we had issues deserializing channels when we hadn't connected the first block
423 // after creation. To catch that and similar issues, we lean on the Node::drop impl to test
424 // serialization round-trips and simply do steps towards opening a channel and then drop the
427 let chanmon_cfgs = create_chanmon_cfgs(2);
428 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
429 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
430 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
432 if steps & 0b1000_0000 != 0{
433 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
434 nodes[0].block_notifier.block_connected_checked(&header, 1, &Vec::new(), &[0; 0]);
435 nodes[1].block_notifier.block_connected_checked(&header, 1, &Vec::new(), &[0; 0]);
438 if steps & 0x0f == 0 { return; }
439 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42).unwrap();
440 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
442 if steps & 0x0f == 1 { return; }
443 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::supported(), &open_channel);
444 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
446 if steps & 0x0f == 2 { return; }
447 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::supported(), &accept_channel);
449 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
451 if steps & 0x0f == 3 { return; }
453 nodes[0].node.funding_transaction_generated(&temporary_channel_id, funding_output);
454 let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
455 assert_eq!(added_monitors.len(), 1);
456 assert_eq!(added_monitors[0].0, funding_output);
457 added_monitors.clear();
459 let funding_created = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
461 if steps & 0x0f == 4 { return; }
462 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
464 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
465 assert_eq!(added_monitors.len(), 1);
466 assert_eq!(added_monitors[0].0, funding_output);
467 added_monitors.clear();
469 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
471 if steps & 0x0f == 5 { return; }
472 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
474 let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
475 assert_eq!(added_monitors.len(), 1);
476 assert_eq!(added_monitors[0].0, funding_output);
477 added_monitors.clear();
480 let events_4 = nodes[0].node.get_and_clear_pending_events();
481 assert_eq!(events_4.len(), 1);
483 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
484 assert_eq!(user_channel_id, 42);
485 assert_eq!(*funding_txo, funding_output);
487 _ => panic!("Unexpected event"),
490 if steps & 0x0f == 6 { return; }
491 create_chan_between_nodes_with_value_confirm_first(&nodes[0], &nodes[1], &tx);
493 if steps & 0x0f == 7 { return; }
494 confirm_transaction(&nodes[0].block_notifier, &nodes[0].chain_monitor, &tx, tx.version);
495 create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
499 fn test_sanity_on_in_flight_opens() {
500 do_test_sanity_on_in_flight_opens(0);
501 do_test_sanity_on_in_flight_opens(0 | 0b1000_0000);
502 do_test_sanity_on_in_flight_opens(1);
503 do_test_sanity_on_in_flight_opens(1 | 0b1000_0000);
504 do_test_sanity_on_in_flight_opens(2);
505 do_test_sanity_on_in_flight_opens(2 | 0b1000_0000);
506 do_test_sanity_on_in_flight_opens(3);
507 do_test_sanity_on_in_flight_opens(3 | 0b1000_0000);
508 do_test_sanity_on_in_flight_opens(4);
509 do_test_sanity_on_in_flight_opens(4 | 0b1000_0000);
510 do_test_sanity_on_in_flight_opens(5);
511 do_test_sanity_on_in_flight_opens(5 | 0b1000_0000);
512 do_test_sanity_on_in_flight_opens(6);
513 do_test_sanity_on_in_flight_opens(6 | 0b1000_0000);
514 do_test_sanity_on_in_flight_opens(7);
515 do_test_sanity_on_in_flight_opens(7 | 0b1000_0000);
516 do_test_sanity_on_in_flight_opens(8);
517 do_test_sanity_on_in_flight_opens(8 | 0b1000_0000);
521 fn test_update_fee_vanilla() {
522 let chanmon_cfgs = create_chanmon_cfgs(2);
523 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
524 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
525 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
526 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
527 let channel_id = chan.2;
529 let feerate = get_feerate!(nodes[0], channel_id);
530 nodes[0].node.update_fee(channel_id, feerate+25).unwrap();
531 check_added_monitors!(nodes[0], 1);
533 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
534 assert_eq!(events_0.len(), 1);
535 let (update_msg, commitment_signed) = match events_0[0] {
536 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 } } => {
537 (update_fee.as_ref(), commitment_signed)
539 _ => panic!("Unexpected event"),
541 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
543 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
544 let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
545 check_added_monitors!(nodes[1], 1);
547 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
548 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
549 check_added_monitors!(nodes[0], 1);
551 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
552 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
553 // No commitment_signed so get_event_msg's assert(len == 1) passes
554 check_added_monitors!(nodes[0], 1);
556 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
557 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
558 check_added_monitors!(nodes[1], 1);
562 fn test_update_fee_that_funder_cannot_afford() {
563 let chanmon_cfgs = create_chanmon_cfgs(2);
564 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
565 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
566 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
567 let channel_value = 1888;
568 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000, InitFeatures::supported(), InitFeatures::supported());
569 let channel_id = chan.2;
572 nodes[0].node.update_fee(channel_id, feerate).unwrap();
573 check_added_monitors!(nodes[0], 1);
574 let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
576 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap());
578 commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
580 //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
581 //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
583 let mut chan_lock = nodes[1].node.channel_state.lock().unwrap();
584 let chan = chan_lock.by_id.get_mut(&channel_id).unwrap();
586 //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
587 let num_htlcs = chan.channel_monitor().get_latest_local_commitment_txn()[0].output.len() - 2;
588 let total_fee: u64 = feerate * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
589 let mut actual_fee = chan.channel_monitor().get_latest_local_commitment_txn()[0].output.iter().fold(0, |acc, output| acc + output.value);
590 actual_fee = channel_value - actual_fee;
591 assert_eq!(total_fee, actual_fee);
594 //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
595 //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
596 nodes[0].node.update_fee(channel_id, feerate+2).unwrap();
597 check_added_monitors!(nodes[0], 1);
599 let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
601 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap());
603 //While producing the commitment_signed response after handling a received update_fee request the
604 //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
605 //Should produce and error.
606 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed);
607 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Funding remote cannot afford proposed new fee".to_string(), 1);
609 //clear the message we could not handle
610 nodes[1].node.get_and_clear_pending_msg_events();
614 fn test_update_fee_with_fundee_update_add_htlc() {
615 let chanmon_cfgs = create_chanmon_cfgs(2);
616 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
617 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
618 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
619 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
620 let channel_id = chan.2;
623 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
625 let feerate = get_feerate!(nodes[0], channel_id);
626 nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
627 check_added_monitors!(nodes[0], 1);
629 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
630 assert_eq!(events_0.len(), 1);
631 let (update_msg, commitment_signed) = match events_0[0] {
632 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 } } => {
633 (update_fee.as_ref(), commitment_signed)
635 _ => panic!("Unexpected event"),
637 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
638 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
639 let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
640 check_added_monitors!(nodes[1], 1);
642 let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 800000, TEST_FINAL_CLTV).unwrap();
644 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[1]);
646 // nothing happens since node[1] is in AwaitingRemoteRevoke
647 nodes[1].node.send_payment(route, our_payment_hash).unwrap();
649 let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
650 assert_eq!(added_monitors.len(), 0);
651 added_monitors.clear();
653 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
654 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
655 // node[1] has nothing to do
657 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
658 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
659 check_added_monitors!(nodes[0], 1);
661 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
662 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
663 // No commitment_signed so get_event_msg's assert(len == 1) passes
664 check_added_monitors!(nodes[0], 1);
665 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
666 check_added_monitors!(nodes[1], 1);
667 // AwaitingRemoteRevoke ends here
669 let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
670 assert_eq!(commitment_update.update_add_htlcs.len(), 1);
671 assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
672 assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
673 assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
674 assert_eq!(commitment_update.update_fee.is_none(), true);
676 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]);
677 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
678 check_added_monitors!(nodes[0], 1);
679 let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
681 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke);
682 check_added_monitors!(nodes[1], 1);
683 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
685 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
686 check_added_monitors!(nodes[1], 1);
687 let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
688 // No commitment_signed so get_event_msg's assert(len == 1) passes
690 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke);
691 check_added_monitors!(nodes[0], 1);
692 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
694 expect_pending_htlcs_forwardable!(nodes[0]);
696 let events = nodes[0].node.get_and_clear_pending_events();
697 assert_eq!(events.len(), 1);
699 Event::PaymentReceived { .. } => { },
700 _ => panic!("Unexpected event"),
703 claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage, 800_000);
705 send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000, 800_000);
706 send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000, 800_000);
707 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
711 fn test_update_fee() {
712 let chanmon_cfgs = create_chanmon_cfgs(2);
713 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
714 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
715 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
716 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
717 let channel_id = chan.2;
720 // (1) update_fee/commitment_signed ->
721 // <- (2) revoke_and_ack
722 // .- send (3) commitment_signed
723 // (4) update_fee/commitment_signed ->
724 // .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
725 // <- (3) commitment_signed delivered
726 // send (6) revoke_and_ack -.
727 // <- (5) deliver revoke_and_ack
728 // (6) deliver revoke_and_ack ->
729 // .- send (7) commitment_signed in response to (4)
730 // <- (7) deliver commitment_signed
733 // Create and deliver (1)...
734 let feerate = get_feerate!(nodes[0], channel_id);
735 nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
736 check_added_monitors!(nodes[0], 1);
738 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
739 assert_eq!(events_0.len(), 1);
740 let (update_msg, commitment_signed) = match events_0[0] {
741 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 } } => {
742 (update_fee.as_ref(), commitment_signed)
744 _ => panic!("Unexpected event"),
746 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
748 // Generate (2) and (3):
749 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
750 let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
751 check_added_monitors!(nodes[1], 1);
754 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
755 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
756 check_added_monitors!(nodes[0], 1);
758 // Create and deliver (4)...
759 nodes[0].node.update_fee(channel_id, feerate+30).unwrap();
760 check_added_monitors!(nodes[0], 1);
761 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
762 assert_eq!(events_0.len(), 1);
763 let (update_msg, commitment_signed) = match events_0[0] {
764 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 } } => {
765 (update_fee.as_ref(), commitment_signed)
767 _ => panic!("Unexpected event"),
770 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
771 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
772 check_added_monitors!(nodes[1], 1);
774 let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
775 // No commitment_signed so get_event_msg's assert(len == 1) passes
777 // Handle (3), creating (6):
778 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0);
779 check_added_monitors!(nodes[0], 1);
780 let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
781 // No commitment_signed so get_event_msg's assert(len == 1) passes
784 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
785 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
786 check_added_monitors!(nodes[0], 1);
788 // Deliver (6), creating (7):
789 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0);
790 let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
791 assert!(commitment_update.update_add_htlcs.is_empty());
792 assert!(commitment_update.update_fulfill_htlcs.is_empty());
793 assert!(commitment_update.update_fail_htlcs.is_empty());
794 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
795 assert!(commitment_update.update_fee.is_none());
796 check_added_monitors!(nodes[1], 1);
799 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
800 check_added_monitors!(nodes[0], 1);
801 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
802 // No commitment_signed so get_event_msg's assert(len == 1) passes
804 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
805 check_added_monitors!(nodes[1], 1);
806 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
808 assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
809 assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
810 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
814 fn pre_funding_lock_shutdown_test() {
815 // Test sending a shutdown prior to funding_locked after funding generation
816 let chanmon_cfgs = create_chanmon_cfgs(2);
817 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
818 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
819 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
820 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0, InitFeatures::supported(), InitFeatures::supported());
821 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
822 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![tx.clone()]}, 1);
823 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![tx.clone()]}, 1);
825 nodes[0].node.close_channel(&OutPoint::new(tx.txid(), 0).to_channel_id()).unwrap();
826 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
827 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
828 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
829 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
831 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
832 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
833 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
834 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
835 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
836 assert!(node_0_none.is_none());
838 assert!(nodes[0].node.list_channels().is_empty());
839 assert!(nodes[1].node.list_channels().is_empty());
843 fn updates_shutdown_wait() {
844 // Test sending a shutdown with outstanding updates pending
845 let chanmon_cfgs = create_chanmon_cfgs(3);
846 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
847 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
848 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
849 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
850 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
851 let route_1 = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
852 let route_2 = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
854 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
856 nodes[0].node.close_channel(&chan_1.2).unwrap();
857 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
858 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
859 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
860 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
862 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
863 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
865 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
866 if let Err(APIError::ChannelUnavailable {..}) = nodes[0].node.send_payment(route_1, payment_hash) {}
867 else { panic!("New sends should fail!") };
868 if let Err(APIError::ChannelUnavailable {..}) = nodes[1].node.send_payment(route_2, payment_hash) {}
869 else { panic!("New sends should fail!") };
871 assert!(nodes[2].node.claim_funds(our_payment_preimage, 100_000));
872 check_added_monitors!(nodes[2], 1);
873 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
874 assert!(updates.update_add_htlcs.is_empty());
875 assert!(updates.update_fail_htlcs.is_empty());
876 assert!(updates.update_fail_malformed_htlcs.is_empty());
877 assert!(updates.update_fee.is_none());
878 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
879 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
880 check_added_monitors!(nodes[1], 1);
881 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
882 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
884 assert!(updates_2.update_add_htlcs.is_empty());
885 assert!(updates_2.update_fail_htlcs.is_empty());
886 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
887 assert!(updates_2.update_fee.is_none());
888 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
889 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
890 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
892 let events = nodes[0].node.get_and_clear_pending_events();
893 assert_eq!(events.len(), 1);
895 Event::PaymentSent { ref payment_preimage } => {
896 assert_eq!(our_payment_preimage, *payment_preimage);
898 _ => panic!("Unexpected event"),
901 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
902 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
903 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
904 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
905 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
906 assert!(node_0_none.is_none());
908 assert!(nodes[0].node.list_channels().is_empty());
910 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
911 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
912 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
913 assert!(nodes[1].node.list_channels().is_empty());
914 assert!(nodes[2].node.list_channels().is_empty());
918 fn htlc_fail_async_shutdown() {
919 // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
920 let chanmon_cfgs = create_chanmon_cfgs(3);
921 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
922 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
923 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
924 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
925 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
927 let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
928 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
929 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
930 check_added_monitors!(nodes[0], 1);
931 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
932 assert_eq!(updates.update_add_htlcs.len(), 1);
933 assert!(updates.update_fulfill_htlcs.is_empty());
934 assert!(updates.update_fail_htlcs.is_empty());
935 assert!(updates.update_fail_malformed_htlcs.is_empty());
936 assert!(updates.update_fee.is_none());
938 nodes[1].node.close_channel(&chan_1.2).unwrap();
939 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
940 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
941 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
943 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
944 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
945 check_added_monitors!(nodes[1], 1);
946 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
947 commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
949 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
950 assert!(updates_2.update_add_htlcs.is_empty());
951 assert!(updates_2.update_fulfill_htlcs.is_empty());
952 assert_eq!(updates_2.update_fail_htlcs.len(), 1);
953 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
954 assert!(updates_2.update_fee.is_none());
956 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
957 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
959 let events = nodes[0].node.get_and_clear_pending_events();
960 assert_eq!(events.len(), 1);
962 Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } => {
963 assert_eq!(our_payment_hash, *payment_hash);
964 assert!(!rejected_by_dest);
966 _ => panic!("Unexpected event"),
969 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
970 assert_eq!(msg_events.len(), 2);
971 let node_0_closing_signed = match msg_events[0] {
972 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
973 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
976 _ => panic!("Unexpected event"),
978 match msg_events[1] {
979 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
980 assert_eq!(msg.contents.short_channel_id, chan_1.0.contents.short_channel_id);
982 _ => panic!("Unexpected event"),
985 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
986 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
987 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
988 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
989 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
990 assert!(node_0_none.is_none());
992 assert!(nodes[0].node.list_channels().is_empty());
994 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
995 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
996 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
997 assert!(nodes[1].node.list_channels().is_empty());
998 assert!(nodes[2].node.list_channels().is_empty());
1001 fn do_test_shutdown_rebroadcast(recv_count: u8) {
1002 // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
1003 // messages delivered prior to disconnect
1004 let chanmon_cfgs = create_chanmon_cfgs(3);
1005 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1006 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1007 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1008 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1009 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
1011 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
1013 nodes[1].node.close_channel(&chan_1.2).unwrap();
1014 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1016 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
1017 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1019 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
1023 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1024 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1026 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1027 let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1028 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1029 let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1031 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
1032 let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1033 assert!(node_1_shutdown == node_1_2nd_shutdown);
1035 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
1036 let node_0_2nd_shutdown = if recv_count > 0 {
1037 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1038 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
1041 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1042 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
1043 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
1045 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_2nd_shutdown);
1047 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1048 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1050 assert!(nodes[2].node.claim_funds(our_payment_preimage, 100_000));
1051 check_added_monitors!(nodes[2], 1);
1052 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1053 assert!(updates.update_add_htlcs.is_empty());
1054 assert!(updates.update_fail_htlcs.is_empty());
1055 assert!(updates.update_fail_malformed_htlcs.is_empty());
1056 assert!(updates.update_fee.is_none());
1057 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1058 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1059 check_added_monitors!(nodes[1], 1);
1060 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1061 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1063 assert!(updates_2.update_add_htlcs.is_empty());
1064 assert!(updates_2.update_fail_htlcs.is_empty());
1065 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
1066 assert!(updates_2.update_fee.is_none());
1067 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
1068 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
1069 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
1071 let events = nodes[0].node.get_and_clear_pending_events();
1072 assert_eq!(events.len(), 1);
1074 Event::PaymentSent { ref payment_preimage } => {
1075 assert_eq!(our_payment_preimage, *payment_preimage);
1077 _ => panic!("Unexpected event"),
1080 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1082 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1083 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1084 assert!(node_1_closing_signed.is_some());
1087 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1088 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1090 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1091 let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1092 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1093 if recv_count == 0 {
1094 // If all closing_signeds weren't delivered we can just resume where we left off...
1095 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1097 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
1098 let node_0_3rd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1099 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
1101 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1102 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1103 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
1105 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_3rd_shutdown);
1106 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1108 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_3rd_shutdown);
1109 let node_0_2nd_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1110 assert!(node_0_closing_signed == node_0_2nd_closing_signed);
1112 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
1113 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1114 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
1115 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1116 assert!(node_0_none.is_none());
1118 // If one node, however, received + responded with an identical closing_signed we end
1119 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
1120 // There isn't really anything better we can do simply, but in the future we might
1121 // explore storing a set of recently-closed channels that got disconnected during
1122 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
1123 // give our counterparty enough time to (potentially) broadcast a cooperative closing
1125 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1127 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1128 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
1129 assert_eq!(msg_events.len(), 1);
1130 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
1132 &ErrorAction::SendErrorMessage { ref msg } => {
1133 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msg);
1134 assert_eq!(msg.channel_id, chan_1.2);
1136 _ => panic!("Unexpected event!"),
1138 } else { panic!("Needed SendErrorMessage close"); }
1140 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
1141 // checks it, but in this case nodes[0] didn't ever get a chance to receive a
1142 // closing_signed so we do it ourselves
1143 check_closed_broadcast!(nodes[0], false);
1146 assert!(nodes[0].node.list_channels().is_empty());
1148 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1149 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1150 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1151 assert!(nodes[1].node.list_channels().is_empty());
1152 assert!(nodes[2].node.list_channels().is_empty());
1156 fn test_shutdown_rebroadcast() {
1157 do_test_shutdown_rebroadcast(0);
1158 do_test_shutdown_rebroadcast(1);
1159 do_test_shutdown_rebroadcast(2);
1163 fn fake_network_test() {
1164 // Simple test which builds a network of ChannelManagers, connects them to each other, and
1165 // tests that payments get routed and transactions broadcast in semi-reasonable ways.
1166 let chanmon_cfgs = create_chanmon_cfgs(4);
1167 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1168 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1169 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1171 // Create some initial channels
1172 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1173 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
1174 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
1176 // Rebalance the network a bit by relaying one payment through all the channels...
1177 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1178 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1179 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1180 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1182 // Send some more payments
1183 send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000, 1_000_000);
1184 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000, 1_000_000);
1185 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000, 1_000_000);
1187 // Test failure packets
1188 let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
1189 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
1191 // Add a new channel that skips 3
1192 let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::supported(), InitFeatures::supported());
1194 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000, 1_000_000);
1195 send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000, 1_000_000);
1196 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1197 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1198 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1199 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1200 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1202 // Do some rebalance loop payments, simultaneously
1203 let mut hops = Vec::with_capacity(3);
1204 hops.push(RouteHop {
1205 pubkey: nodes[2].node.get_our_node_id(),
1206 node_features: NodeFeatures::empty(),
1207 short_channel_id: chan_2.0.contents.short_channel_id,
1208 channel_features: ChannelFeatures::empty(),
1210 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
1212 hops.push(RouteHop {
1213 pubkey: nodes[3].node.get_our_node_id(),
1214 node_features: NodeFeatures::empty(),
1215 short_channel_id: chan_3.0.contents.short_channel_id,
1216 channel_features: ChannelFeatures::empty(),
1218 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
1220 hops.push(RouteHop {
1221 pubkey: nodes[1].node.get_our_node_id(),
1222 node_features: NodeFeatures::empty(),
1223 short_channel_id: chan_4.0.contents.short_channel_id,
1224 channel_features: ChannelFeatures::empty(),
1226 cltv_expiry_delta: TEST_FINAL_CLTV,
1228 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;
1229 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;
1230 let payment_preimage_1 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
1232 let mut hops = Vec::with_capacity(3);
1233 hops.push(RouteHop {
1234 pubkey: nodes[3].node.get_our_node_id(),
1235 node_features: NodeFeatures::empty(),
1236 short_channel_id: chan_4.0.contents.short_channel_id,
1237 channel_features: ChannelFeatures::empty(),
1239 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
1241 hops.push(RouteHop {
1242 pubkey: nodes[2].node.get_our_node_id(),
1243 node_features: NodeFeatures::empty(),
1244 short_channel_id: chan_3.0.contents.short_channel_id,
1245 channel_features: ChannelFeatures::empty(),
1247 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
1249 hops.push(RouteHop {
1250 pubkey: nodes[1].node.get_our_node_id(),
1251 node_features: NodeFeatures::empty(),
1252 short_channel_id: chan_2.0.contents.short_channel_id,
1253 channel_features: ChannelFeatures::empty(),
1255 cltv_expiry_delta: TEST_FINAL_CLTV,
1257 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;
1258 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;
1259 let payment_hash_2 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1261 // Claim the rebalances...
1262 fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1263 claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1, 1_000_000);
1265 // Add a duplicate new channel from 2 to 4
1266 let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::supported(), InitFeatures::supported());
1268 // Send some payments across both channels
1269 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1270 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1271 let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1274 route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
1275 let events = nodes[0].node.get_and_clear_pending_msg_events();
1276 assert_eq!(events.len(), 0);
1277 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over the max HTLC value in flight our peer will accept".to_string(), 1);
1279 //TODO: Test that routes work again here as we've been notified that the channel is full
1281 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3, 3_000_000);
1282 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4, 3_000_000);
1283 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5, 3_000_000);
1285 // Close down the channels...
1286 close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1287 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1288 close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1289 close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1290 close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
1294 fn holding_cell_htlc_counting() {
1295 // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1296 // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1297 // commitment dance rounds.
1298 let chanmon_cfgs = create_chanmon_cfgs(3);
1299 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1300 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1301 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1302 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1303 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
1305 let mut payments = Vec::new();
1306 for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1307 let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
1308 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1309 nodes[1].node.send_payment(route, payment_hash).unwrap();
1310 payments.push((payment_preimage, payment_hash));
1312 check_added_monitors!(nodes[1], 1);
1314 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1315 assert_eq!(events.len(), 1);
1316 let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1317 assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1319 // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1320 // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1322 let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
1323 let (_, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
1324 if let APIError::ChannelUnavailable { err } = nodes[1].node.send_payment(route, payment_hash_1).unwrap_err() {
1325 assert_eq!(err, "Cannot push more than their max accepted HTLCs");
1326 } else { panic!("Unexpected event"); }
1327 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1328 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1330 // This should also be true if we try to forward a payment.
1331 let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
1332 let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
1333 nodes[0].node.send_payment(route, payment_hash_2).unwrap();
1334 check_added_monitors!(nodes[0], 1);
1336 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1337 assert_eq!(events.len(), 1);
1338 let payment_event = SendEvent::from_event(events.pop().unwrap());
1339 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1341 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1342 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1343 // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1344 // fails), the second will process the resulting failure and fail the HTLC backward.
1345 expect_pending_htlcs_forwardable!(nodes[1]);
1346 expect_pending_htlcs_forwardable!(nodes[1]);
1347 check_added_monitors!(nodes[1], 1);
1349 let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1350 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1351 commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1353 let events = nodes[0].node.get_and_clear_pending_msg_events();
1354 assert_eq!(events.len(), 1);
1356 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
1357 assert_eq!(msg.contents.short_channel_id, chan_2.0.contents.short_channel_id);
1359 _ => panic!("Unexpected event"),
1362 let events = nodes[0].node.get_and_clear_pending_events();
1363 assert_eq!(events.len(), 1);
1365 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
1366 assert_eq!(payment_hash, payment_hash_2);
1367 assert!(!rejected_by_dest);
1369 _ => panic!("Unexpected event"),
1372 // Now forward all the pending HTLCs and claim them back
1373 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1374 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1375 check_added_monitors!(nodes[2], 1);
1377 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1378 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1379 check_added_monitors!(nodes[1], 1);
1380 let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1382 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1383 check_added_monitors!(nodes[1], 1);
1384 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1386 for ref update in as_updates.update_add_htlcs.iter() {
1387 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1389 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1390 check_added_monitors!(nodes[2], 1);
1391 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1392 check_added_monitors!(nodes[2], 1);
1393 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1395 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1396 check_added_monitors!(nodes[1], 1);
1397 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1398 check_added_monitors!(nodes[1], 1);
1399 let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1401 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1402 check_added_monitors!(nodes[2], 1);
1404 expect_pending_htlcs_forwardable!(nodes[2]);
1406 let events = nodes[2].node.get_and_clear_pending_events();
1407 assert_eq!(events.len(), payments.len());
1408 for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1410 &Event::PaymentReceived { ref payment_hash, .. } => {
1411 assert_eq!(*payment_hash, *hash);
1413 _ => panic!("Unexpected event"),
1417 for (preimage, _) in payments.drain(..) {
1418 claim_payment(&nodes[1], &[&nodes[2]], preimage, 100_000);
1421 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000, 1_000_000);
1425 fn duplicate_htlc_test() {
1426 // Test that we accept duplicate payment_hash HTLCs across the network and that
1427 // claiming/failing them are all separate and don't affect each other
1428 let chanmon_cfgs = create_chanmon_cfgs(6);
1429 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1430 let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1431 let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1433 // Create some initial channels to route via 3 to 4/5 from 0/1/2
1434 create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::supported(), InitFeatures::supported());
1435 create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::supported(), InitFeatures::supported());
1436 create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
1437 create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::supported(), InitFeatures::supported());
1438 create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::supported(), InitFeatures::supported());
1440 let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1442 *nodes[0].network_payment_count.borrow_mut() -= 1;
1443 assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1445 *nodes[0].network_payment_count.borrow_mut() -= 1;
1446 assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1448 claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage, 1_000_000);
1449 fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1450 claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage, 1_000_000);
1454 fn test_duplicate_htlc_different_direction_onchain() {
1455 // Test that ChannelMonitor doesn't generate 2 preimage txn
1456 // when we have 2 HTLCs with same preimage that go across a node
1457 // in opposite directions.
1458 let chanmon_cfgs = create_chanmon_cfgs(2);
1459 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1460 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1461 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1463 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1466 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
1468 let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1470 let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 800_000, TEST_FINAL_CLTV).unwrap();
1471 send_along_route_with_hash(&nodes[1], route, &vec!(&nodes[0])[..], 800_000, payment_hash);
1473 // Provide preimage to node 0 by claiming payment
1474 nodes[0].node.claim_funds(payment_preimage, 800_000);
1475 check_added_monitors!(nodes[0], 1);
1477 // Broadcast node 1 commitment txn
1478 let remote_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
1480 assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1481 let mut has_both_htlcs = 0; // check htlcs match ones committed
1482 for outp in remote_txn[0].output.iter() {
1483 if outp.value == 800_000 / 1000 {
1484 has_both_htlcs += 1;
1485 } else if outp.value == 900_000 / 1000 {
1486 has_both_htlcs += 1;
1489 assert_eq!(has_both_htlcs, 2);
1491 let header = BlockHeader { version: 0x2000_0000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1492 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
1494 // Check we only broadcast 1 timeout tx
1495 let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1496 let htlc_pair = if claim_txn[0].output[0].value == 800_000 / 1000 { (claim_txn[0].clone(), claim_txn[1].clone()) } else { (claim_txn[1].clone(), claim_txn[0].clone()) };
1497 assert_eq!(claim_txn.len(), 5);
1498 check_spends!(claim_txn[2], chan_1.3);
1499 check_spends!(claim_txn[3], claim_txn[2]);
1500 assert_eq!(htlc_pair.0.input.len(), 1);
1501 assert_eq!(htlc_pair.0.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1502 check_spends!(htlc_pair.0, remote_txn[0].clone());
1503 assert_eq!(htlc_pair.1.input.len(), 1);
1504 assert_eq!(htlc_pair.1.input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1505 check_spends!(htlc_pair.1, remote_txn[0].clone());
1507 let events = nodes[0].node.get_and_clear_pending_msg_events();
1508 assert_eq!(events.len(), 2);
1511 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1512 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, .. } } => {
1513 assert!(update_add_htlcs.is_empty());
1514 assert!(update_fail_htlcs.is_empty());
1515 assert_eq!(update_fulfill_htlcs.len(), 1);
1516 assert!(update_fail_malformed_htlcs.is_empty());
1517 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1519 _ => panic!("Unexpected event"),
1524 fn do_channel_reserve_test(test_recv: bool) {
1526 let chanmon_cfgs = create_chanmon_cfgs(3);
1527 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1528 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1529 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1530 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1900, 1001, InitFeatures::supported(), InitFeatures::supported());
1531 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1900, 1001, InitFeatures::supported(), InitFeatures::supported());
1533 let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1534 let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1536 let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1537 let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1539 macro_rules! get_route_and_payment_hash {
1540 ($recv_value: expr) => {{
1541 let route = nodes[0].router.get_route(&nodes.last().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV).unwrap();
1542 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1543 (route, payment_hash, payment_preimage)
1547 macro_rules! expect_forward {
1549 let mut events = $node.node.get_and_clear_pending_msg_events();
1550 assert_eq!(events.len(), 1);
1551 check_added_monitors!($node, 1);
1552 let payment_event = SendEvent::from_event(events.remove(0));
1557 let feemsat = 239; // somehow we know?
1558 let total_fee_msat = (nodes.len() - 2) as u64 * 239;
1560 let recv_value_0 = stat01.their_max_htlc_value_in_flight_msat - total_fee_msat;
1562 // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1564 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_0 + 1);
1565 assert!(route.hops.iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1566 let err = nodes[0].node.send_payment(route, our_payment_hash).err().unwrap();
1568 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight our peer will accept"),
1569 _ => panic!("Unknown error variants"),
1571 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1572 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over the max HTLC value in flight our peer will accept".to_string(), 1);
1575 let mut htlc_id = 0;
1576 // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1577 // nodes[0]'s wealth
1579 let amt_msat = recv_value_0 + total_fee_msat;
1580 if stat01.value_to_self_msat - amt_msat < stat01.channel_reserve_msat {
1583 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0, recv_value_0);
1586 let (stat01_, stat11_, stat12_, stat22_) = (
1587 get_channel_value_stat!(nodes[0], chan_1.2),
1588 get_channel_value_stat!(nodes[1], chan_1.2),
1589 get_channel_value_stat!(nodes[1], chan_2.2),
1590 get_channel_value_stat!(nodes[2], chan_2.2),
1593 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1594 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1595 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1596 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1597 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1601 let recv_value = stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat;
1602 // attempt to get channel_reserve violation
1603 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value + 1);
1604 let err = nodes[0].node.send_payment(route.clone(), our_payment_hash).err().unwrap();
1606 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over their reserve value"),
1607 _ => panic!("Unknown error variants"),
1609 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1610 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over their reserve value".to_string(), 1);
1613 // adding pending output
1614 let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat)/2;
1615 let amt_msat_1 = recv_value_1 + total_fee_msat;
1617 let (route_1, our_payment_hash_1, our_payment_preimage_1) = get_route_and_payment_hash!(recv_value_1);
1618 let payment_event_1 = {
1619 nodes[0].node.send_payment(route_1, our_payment_hash_1).unwrap();
1620 check_added_monitors!(nodes[0], 1);
1622 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1623 assert_eq!(events.len(), 1);
1624 SendEvent::from_event(events.remove(0))
1626 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1628 // channel reserve test with htlc pending output > 0
1629 let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat;
1631 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
1632 match nodes[0].node.send_payment(route, our_payment_hash).err().unwrap() {
1633 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over their reserve value"),
1634 _ => panic!("Unknown error variants"),
1636 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1637 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over their reserve value".to_string(), 2);
1641 // test channel_reserve test on nodes[1] side
1642 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
1644 // Need to manually create update_add_htlc message to go around the channel reserve check in send_htlc()
1645 let secp_ctx = Secp256k1::new();
1646 let session_priv = SecretKey::from_slice(&{
1647 let mut session_key = [0; 32];
1648 let mut rng = thread_rng();
1649 rng.fill_bytes(&mut session_key);
1651 }).expect("RNG is bad!");
1653 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1654 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route, &session_priv).unwrap();
1655 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
1656 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
1657 let msg = msgs::UpdateAddHTLC {
1658 channel_id: chan_1.2,
1660 amount_msat: htlc_msat,
1661 payment_hash: our_payment_hash,
1662 cltv_expiry: htlc_cltv,
1663 onion_routing_packet: onion_packet,
1667 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1668 // If we send a garbage message, the channel should get closed, making the rest of this test case fail.
1669 assert_eq!(nodes[1].node.list_channels().len(), 1);
1670 assert_eq!(nodes[1].node.list_channels().len(), 1);
1671 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1672 assert_eq!(err_msg.data, "Remote HTLC add would put them over their reserve value");
1677 // split the rest to test holding cell
1678 let recv_value_21 = recv_value_2/2;
1679 let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat;
1681 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
1682 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);
1685 // now see if they go through on both sides
1686 let (route_21, our_payment_hash_21, our_payment_preimage_21) = get_route_and_payment_hash!(recv_value_21);
1687 // but this will stuck in the holding cell
1688 nodes[0].node.send_payment(route_21, our_payment_hash_21).unwrap();
1689 check_added_monitors!(nodes[0], 0);
1690 let events = nodes[0].node.get_and_clear_pending_events();
1691 assert_eq!(events.len(), 0);
1693 // test with outbound holding cell amount > 0
1695 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_22+1);
1696 match nodes[0].node.send_payment(route, our_payment_hash).err().unwrap() {
1697 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over their reserve value"),
1698 _ => panic!("Unknown error variants"),
1700 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1701 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over their reserve value".to_string(), 3);
1704 let (route_22, our_payment_hash_22, our_payment_preimage_22) = get_route_and_payment_hash!(recv_value_22);
1705 // this will also stuck in the holding cell
1706 nodes[0].node.send_payment(route_22, our_payment_hash_22).unwrap();
1707 check_added_monitors!(nodes[0], 0);
1708 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1709 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1711 // flush the pending htlc
1712 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
1713 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1714 check_added_monitors!(nodes[1], 1);
1716 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
1717 check_added_monitors!(nodes[0], 1);
1718 let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1720 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
1721 let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1722 // No commitment_signed so get_event_msg's assert(len == 1) passes
1723 check_added_monitors!(nodes[0], 1);
1725 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
1726 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1727 check_added_monitors!(nodes[1], 1);
1729 expect_pending_htlcs_forwardable!(nodes[1]);
1731 let ref payment_event_11 = expect_forward!(nodes[1]);
1732 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
1733 commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
1735 expect_pending_htlcs_forwardable!(nodes[2]);
1736 expect_payment_received!(nodes[2], our_payment_hash_1, recv_value_1);
1738 // flush the htlcs in the holding cell
1739 assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
1740 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
1741 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
1742 commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
1743 expect_pending_htlcs_forwardable!(nodes[1]);
1745 let ref payment_event_3 = expect_forward!(nodes[1]);
1746 assert_eq!(payment_event_3.msgs.len(), 2);
1747 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
1748 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
1750 commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
1751 expect_pending_htlcs_forwardable!(nodes[2]);
1753 let events = nodes[2].node.get_and_clear_pending_events();
1754 assert_eq!(events.len(), 2);
1756 Event::PaymentReceived { ref payment_hash, amt } => {
1757 assert_eq!(our_payment_hash_21, *payment_hash);
1758 assert_eq!(recv_value_21, amt);
1760 _ => panic!("Unexpected event"),
1763 Event::PaymentReceived { ref payment_hash, amt } => {
1764 assert_eq!(our_payment_hash_22, *payment_hash);
1765 assert_eq!(recv_value_22, amt);
1767 _ => panic!("Unexpected event"),
1770 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1, recv_value_1);
1771 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21, recv_value_21);
1772 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22, recv_value_22);
1774 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);
1775 let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
1776 assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
1777 assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat);
1779 let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
1780 assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22);
1784 fn channel_reserve_test() {
1785 do_channel_reserve_test(false);
1786 do_channel_reserve_test(true);
1790 fn channel_reserve_in_flight_removes() {
1791 // In cases where one side claims an HTLC, it thinks it has additional available funds that it
1792 // can send to its counterparty, but due to update ordering, the other side may not yet have
1793 // considered those HTLCs fully removed.
1794 // This tests that we don't count HTLCs which will not be included in the next remote
1795 // commitment transaction towards the reserve value (as it implies no commitment transaction
1796 // will be generated which violates the remote reserve value).
1797 // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
1799 // * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
1800 // you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
1801 // you only consider the value of the first HTLC, it may not),
1802 // * start routing a third HTLC from A to B,
1803 // * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
1804 // the other claim in its holding cell, as it immediately goes into AwaitingRAA),
1805 // * deliver the first fulfill from B
1806 // * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
1808 // * deliver A's response CS and RAA.
1809 // This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
1810 // removed it fully. B now has the push_msat plus the first two HTLCs in value.
1811 // * Now B happily sends another HTLC, potentially violating its reserve value from A's point
1812 // of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
1813 let chanmon_cfgs = create_chanmon_cfgs(2);
1814 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1815 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1816 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1817 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1819 let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
1820 // Route the first two HTLCs.
1821 let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
1822 let (payment_preimage_2, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
1824 // Start routing the third HTLC (this is just used to get everyone in the right state).
1825 let (payment_preimage_3, payment_hash_3) = get_payment_preimage_hash!(nodes[0]);
1827 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
1828 nodes[0].node.send_payment(route, payment_hash_3).unwrap();
1829 check_added_monitors!(nodes[0], 1);
1830 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1831 assert_eq!(events.len(), 1);
1832 SendEvent::from_event(events.remove(0))
1835 // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
1836 // initial fulfill/CS.
1837 assert!(nodes[1].node.claim_funds(payment_preimage_1, b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000));
1838 check_added_monitors!(nodes[1], 1);
1839 let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1841 // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
1842 // remove the second HTLC when we send the HTLC back from B to A.
1843 assert!(nodes[1].node.claim_funds(payment_preimage_2, 20000));
1844 check_added_monitors!(nodes[1], 1);
1845 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1847 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
1848 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
1849 check_added_monitors!(nodes[0], 1);
1850 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1851 expect_payment_sent!(nodes[0], payment_preimage_1);
1853 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
1854 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
1855 check_added_monitors!(nodes[1], 1);
1856 // B is already AwaitingRAA, so cant generate a CS here
1857 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1859 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1860 check_added_monitors!(nodes[1], 1);
1861 let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1863 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1864 check_added_monitors!(nodes[0], 1);
1865 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1867 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1868 check_added_monitors!(nodes[1], 1);
1869 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1871 // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
1872 // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
1873 // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
1874 // can no longer broadcast a commitment transaction with it and B has the preimage so can go
1875 // on-chain as necessary).
1876 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
1877 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
1878 check_added_monitors!(nodes[0], 1);
1879 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1880 expect_payment_sent!(nodes[0], payment_preimage_2);
1882 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1883 check_added_monitors!(nodes[1], 1);
1884 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1886 expect_pending_htlcs_forwardable!(nodes[1]);
1887 expect_payment_received!(nodes[1], payment_hash_3, 100000);
1889 // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
1890 // resolve the second HTLC from A's point of view.
1891 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1892 check_added_monitors!(nodes[0], 1);
1893 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1895 // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
1896 // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
1897 let (payment_preimage_4, payment_hash_4) = get_payment_preimage_hash!(nodes[1]);
1899 let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &[], 10000, TEST_FINAL_CLTV).unwrap();
1900 nodes[1].node.send_payment(route, payment_hash_4).unwrap();
1901 check_added_monitors!(nodes[1], 1);
1902 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1903 assert_eq!(events.len(), 1);
1904 SendEvent::from_event(events.remove(0))
1907 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
1908 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
1909 check_added_monitors!(nodes[0], 1);
1910 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1912 // Now just resolve all the outstanding messages/HTLCs for completeness...
1914 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1915 check_added_monitors!(nodes[1], 1);
1916 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1918 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1919 check_added_monitors!(nodes[1], 1);
1921 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1922 check_added_monitors!(nodes[0], 1);
1923 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1925 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1926 check_added_monitors!(nodes[1], 1);
1927 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1929 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1930 check_added_monitors!(nodes[0], 1);
1932 expect_pending_htlcs_forwardable!(nodes[0]);
1933 expect_payment_received!(nodes[0], payment_hash_4, 10000);
1935 claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4, 10_000);
1936 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3, 100_000);
1940 fn channel_monitor_network_test() {
1941 // Simple test which builds a network of ChannelManagers, connects them to each other, and
1942 // tests that ChannelMonitor is able to recover from various states.
1943 let chanmon_cfgs = create_chanmon_cfgs(5);
1944 let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
1945 let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
1946 let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
1948 // Create some initial channels
1949 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1950 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
1951 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
1952 let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::supported(), InitFeatures::supported());
1954 // Rebalance the network a bit by relaying one payment through all the channels...
1955 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1956 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1957 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1958 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1960 // Simple case with no pending HTLCs:
1961 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
1963 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
1964 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1965 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
1966 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
1968 get_announce_close_broadcast_events(&nodes, 0, 1);
1969 assert_eq!(nodes[0].node.list_channels().len(), 0);
1970 assert_eq!(nodes[1].node.list_channels().len(), 1);
1972 // One pending HTLC is discarded by the force-close:
1973 let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
1975 // Simple case of one pending HTLC to HTLC-Timeout
1976 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
1978 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
1979 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1980 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
1981 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
1983 get_announce_close_broadcast_events(&nodes, 1, 2);
1984 assert_eq!(nodes[1].node.list_channels().len(), 0);
1985 assert_eq!(nodes[2].node.list_channels().len(), 1);
1987 macro_rules! claim_funds {
1988 ($node: expr, $prev_node: expr, $preimage: expr, $amount: expr) => {
1990 assert!($node.node.claim_funds($preimage, $amount));
1991 check_added_monitors!($node, 1);
1993 let events = $node.node.get_and_clear_pending_msg_events();
1994 assert_eq!(events.len(), 1);
1996 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
1997 assert!(update_add_htlcs.is_empty());
1998 assert!(update_fail_htlcs.is_empty());
1999 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2001 _ => panic!("Unexpected event"),
2007 // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2008 // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2009 nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2010 let node2_commitment_txid;
2012 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2013 node2_commitment_txid = node_txn[0].txid();
2015 // Claim the payment on nodes[3], giving it knowledge of the preimage
2016 claim_funds!(nodes[3], nodes[2], payment_preimage_1, 3_000_000);
2018 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2019 nodes[3].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 1);
2021 check_preimage_claim(&nodes[3], &node_txn);
2023 get_announce_close_broadcast_events(&nodes, 2, 3);
2024 assert_eq!(nodes[2].node.list_channels().len(), 0);
2025 assert_eq!(nodes[3].node.list_channels().len(), 1);
2027 { // Cheat and reset nodes[4]'s height to 1
2028 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2029 nodes[4].block_notifier.block_connected(&Block { header, txdata: vec![] }, 1);
2032 assert_eq!(nodes[3].node.latest_block_height.load(Ordering::Acquire), 1);
2033 assert_eq!(nodes[4].node.latest_block_height.load(Ordering::Acquire), 1);
2034 // One pending HTLC to time out:
2035 let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2036 // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2040 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2041 nodes[3].block_notifier.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
2042 for i in 3..TEST_FINAL_CLTV + 2 + LATENCY_GRACE_PERIOD_BLOCKS + 1 {
2043 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2044 nodes[3].block_notifier.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
2047 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2049 let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2050 node_txn.retain(|tx| {
2051 if tx.input[0].previous_output.txid == node2_commitment_txid {
2057 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2059 // Claim the payment on nodes[4], giving it knowledge of the preimage
2060 claim_funds!(nodes[4], nodes[3], payment_preimage_2, 3_000_000);
2062 header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2064 nodes[4].block_notifier.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
2065 for i in 3..TEST_FINAL_CLTV + 2 - CLTV_CLAIM_BUFFER + 1 {
2066 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2067 nodes[4].block_notifier.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
2070 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2072 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2073 nodes[4].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, TEST_FINAL_CLTV - 5);
2075 check_preimage_claim(&nodes[4], &node_txn);
2077 get_announce_close_broadcast_events(&nodes, 3, 4);
2078 assert_eq!(nodes[3].node.list_channels().len(), 0);
2079 assert_eq!(nodes[4].node.list_channels().len(), 0);
2083 fn test_justice_tx() {
2084 // Test justice txn built on revoked HTLC-Success tx, against both sides
2085 let mut alice_config = UserConfig::default();
2086 alice_config.channel_options.announced_channel = true;
2087 alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2088 alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2089 let mut bob_config = UserConfig::default();
2090 bob_config.channel_options.announced_channel = true;
2091 bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2092 bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2093 let user_cfgs = [Some(alice_config), Some(bob_config)];
2094 let chanmon_cfgs = create_chanmon_cfgs(2);
2095 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2096 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2097 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2098 // Create some new channels:
2099 let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2101 // A pending HTLC which will be revoked:
2102 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2103 // Get the will-be-revoked local txn from nodes[0]
2104 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.iter_mut().next().unwrap().1.channel_monitor().get_latest_local_commitment_txn();
2105 assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2106 assert_eq!(revoked_local_txn[0].input.len(), 1);
2107 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2108 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2109 assert_eq!(revoked_local_txn[1].input.len(), 1);
2110 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2111 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2112 // Revoke the old state
2113 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 3_000_000);
2116 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2117 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2119 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2120 assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2121 assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2123 check_spends!(node_txn[0], revoked_local_txn[0].clone());
2124 node_txn.swap_remove(0);
2125 node_txn.truncate(1);
2127 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2129 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2130 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2131 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2132 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2133 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2135 get_announce_close_broadcast_events(&nodes, 0, 1);
2137 assert_eq!(nodes[0].node.list_channels().len(), 0);
2138 assert_eq!(nodes[1].node.list_channels().len(), 0);
2140 // We test justice_tx build by A on B's revoked HTLC-Success tx
2141 // Create some new channels:
2142 let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2144 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2148 // A pending HTLC which will be revoked:
2149 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2150 // Get the will-be-revoked local txn from B
2151 let revoked_local_txn = nodes[1].node.channel_state.lock().unwrap().by_id.iter_mut().next().unwrap().1.channel_monitor().get_latest_local_commitment_txn();
2152 assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2153 assert_eq!(revoked_local_txn[0].input.len(), 1);
2154 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2155 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2156 // Revoke the old state
2157 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4, 3_000_000);
2159 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2160 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2162 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2163 assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2164 assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2166 check_spends!(node_txn[0], revoked_local_txn[0].clone());
2167 node_txn.swap_remove(0);
2169 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2171 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2172 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2173 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2174 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2175 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2177 get_announce_close_broadcast_events(&nodes, 0, 1);
2178 assert_eq!(nodes[0].node.list_channels().len(), 0);
2179 assert_eq!(nodes[1].node.list_channels().len(), 0);
2183 fn revoked_output_claim() {
2184 // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2185 // transaction is broadcast by its counterparty
2186 let chanmon_cfgs = create_chanmon_cfgs(2);
2187 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2188 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2189 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2190 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2191 // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2192 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
2193 assert_eq!(revoked_local_txn.len(), 1);
2194 // Only output is the full channel value back to nodes[0]:
2195 assert_eq!(revoked_local_txn[0].output.len(), 1);
2196 // Send a payment through, updating everyone's latest commitment txn
2197 send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000, 5_000_000);
2199 // Inform nodes[1] that nodes[0] broadcast a stale tx
2200 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2201 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2202 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2203 assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2205 check_spends!(node_txn[0], revoked_local_txn[0].clone());
2206 check_spends!(node_txn[1], chan_1.3.clone());
2208 // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2209 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2210 get_announce_close_broadcast_events(&nodes, 0, 1);
2214 fn claim_htlc_outputs_shared_tx() {
2215 // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2216 let chanmon_cfgs = create_chanmon_cfgs(2);
2217 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2218 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2219 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2221 // Create some new channel:
2222 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2224 // Rebalance the network to generate htlc in the two directions
2225 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2226 // 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
2227 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2228 let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2230 // Get the will-be-revoked local txn from node[0]
2231 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
2232 assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2233 assert_eq!(revoked_local_txn[0].input.len(), 1);
2234 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2235 assert_eq!(revoked_local_txn[1].input.len(), 1);
2236 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2237 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2238 check_spends!(revoked_local_txn[1], revoked_local_txn[0].clone());
2240 //Revoke the old state
2241 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2244 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2245 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2246 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2247 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2249 let events = nodes[1].node.get_and_clear_pending_events();
2250 assert_eq!(events.len(), 1);
2252 Event::PaymentFailed { payment_hash, .. } => {
2253 assert_eq!(payment_hash, payment_hash_2);
2255 _ => panic!("Unexpected event"),
2258 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2259 assert_eq!(node_txn.len(), 3); // ChannelMonitor: penalty tx, ChannelManager: local commitment + HTLC-timeout
2261 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2262 check_spends!(node_txn[0], revoked_local_txn[0].clone());
2264 let mut witness_lens = BTreeSet::new();
2265 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2266 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2267 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2268 assert_eq!(witness_lens.len(), 3);
2269 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2270 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2271 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2273 // Next nodes[1] broadcasts its current local tx state:
2274 assert_eq!(node_txn[1].input.len(), 1);
2275 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2277 assert_eq!(node_txn[2].input.len(), 1);
2278 let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
2279 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2280 assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
2281 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2282 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
2284 get_announce_close_broadcast_events(&nodes, 0, 1);
2285 assert_eq!(nodes[0].node.list_channels().len(), 0);
2286 assert_eq!(nodes[1].node.list_channels().len(), 0);
2290 fn claim_htlc_outputs_single_tx() {
2291 // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2292 let chanmon_cfgs = create_chanmon_cfgs(2);
2293 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2294 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2295 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2297 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2299 // Rebalance the network to generate htlc in the two directions
2300 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2301 // 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
2302 // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2303 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2304 let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2306 // Get the will-be-revoked local txn from node[0]
2307 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
2309 //Revoke the old state
2310 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2313 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2314 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2315 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2316 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
2318 let events = nodes[1].node.get_and_clear_pending_events();
2319 assert_eq!(events.len(), 1);
2321 Event::PaymentFailed { payment_hash, .. } => {
2322 assert_eq!(payment_hash, payment_hash_2);
2324 _ => panic!("Unexpected event"),
2327 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2328 assert_eq!(node_txn.len(), 26);
2329 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2330 // ChannelManager: local commmitment + local HTLC-timeout (2)
2331 // ChannelMonitor: bumped justice tx * 7 (7), after one increase, bumps on HTLC aren't generated not being substantial anymore
2332 // ChannelMonitor: local commitment + local HTLC-timeout (14)
2335 assert_eq!(node_txn[3], node_txn[5]);
2336 assert_eq!(node_txn[3], node_txn[7]);
2337 assert_eq!(node_txn[3], node_txn[9]);
2338 assert_eq!(node_txn[3], node_txn[14]);
2339 assert_eq!(node_txn[3], node_txn[17]);
2340 assert_eq!(node_txn[3], node_txn[20]);
2341 assert_eq!(node_txn[3], node_txn[23]);
2343 assert_eq!(node_txn[4], node_txn[6]);
2344 assert_eq!(node_txn[4], node_txn[8]);
2345 assert_eq!(node_txn[4], node_txn[10]);
2346 assert_eq!(node_txn[4], node_txn[15]);
2347 assert_eq!(node_txn[4], node_txn[18]);
2348 assert_eq!(node_txn[4], node_txn[21]);
2349 assert_eq!(node_txn[4], node_txn[24]);
2351 assert_eq!(node_txn[0].input.len(), 1);
2352 assert_eq!(node_txn[1].input.len(), 1);
2353 assert_eq!(node_txn[2].input.len(), 1);
2355 fn get_txout(out_point: &BitcoinOutPoint, tx: &Transaction) -> Option<TxOut> {
2356 if out_point.txid == tx.txid() {
2357 tx.output.get(out_point.vout as usize).cloned()
2362 node_txn[0].verify(|out|get_txout(out, &revoked_local_txn[0])).unwrap();
2363 node_txn[1].verify(|out|get_txout(out, &revoked_local_txn[0])).unwrap();
2364 node_txn[2].verify(|out|get_txout(out, &revoked_local_txn[0])).unwrap();
2366 let mut witness_lens = BTreeSet::new();
2367 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2368 witness_lens.insert(node_txn[1].input[0].witness.last().unwrap().len());
2369 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2370 assert_eq!(witness_lens.len(), 3);
2371 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2372 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2373 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2375 assert_eq!(node_txn[3].input.len(), 1);
2376 check_spends!(node_txn[3], chan_1.3.clone());
2378 assert_eq!(node_txn[4].input.len(), 1);
2379 let witness_script = node_txn[4].input[0].witness.last().unwrap();
2380 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2381 assert_eq!(node_txn[4].input[0].previous_output.txid, node_txn[3].txid());
2382 assert_ne!(node_txn[4].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2383 assert_ne!(node_txn[4].input[0].previous_output.txid, node_txn[1].input[0].previous_output.txid);
2385 get_announce_close_broadcast_events(&nodes, 0, 1);
2386 assert_eq!(nodes[0].node.list_channels().len(), 0);
2387 assert_eq!(nodes[1].node.list_channels().len(), 0);
2391 fn test_htlc_on_chain_success() {
2392 // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2393 // ChainWatchInterface and pass the preimage backward accordingly. So here we test that ChannelManager is
2394 // broadcasting the right event to other nodes in payment path.
2395 // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2396 // A --------------------> B ----------------------> C (preimage)
2397 // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2398 // commitment transaction was broadcast.
2399 // Then, B should learn the preimage from said transactions, attempting to claim backwards
2401 // B should be able to claim via preimage if A then broadcasts its local tx.
2402 // Finally, when A sees B's latest local commitment transaction it should be able to claim
2403 // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2404 // PaymentSent event).
2406 let chanmon_cfgs = create_chanmon_cfgs(3);
2407 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2408 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2409 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2411 // Create some initial channels
2412 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2413 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2415 // Rebalance the network a bit by relaying one payment through all the channels...
2416 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2417 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2419 let (our_payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2420 let (our_payment_preimage_2, _payment_hash_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2421 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2423 // Broadcast legit commitment tx from C on B's chain
2424 // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2425 let commitment_tx = nodes[2].node.channel_state.lock().unwrap().by_id.get_mut(&chan_2.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
2426 assert_eq!(commitment_tx.len(), 1);
2427 check_spends!(commitment_tx[0], chan_2.3.clone());
2428 nodes[2].node.claim_funds(our_payment_preimage, 3_000_000);
2429 nodes[2].node.claim_funds(our_payment_preimage_2, 3_000_000);
2430 check_added_monitors!(nodes[2], 2);
2431 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2432 assert!(updates.update_add_htlcs.is_empty());
2433 assert!(updates.update_fail_htlcs.is_empty());
2434 assert!(updates.update_fail_malformed_htlcs.is_empty());
2435 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2437 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2438 check_closed_broadcast!(nodes[2], false);
2439 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx, 2*htlc-success tx), ChannelMonitor : 4 (2*2 * HTLC-Success tx)
2440 assert_eq!(node_txn.len(), 7);
2441 assert_eq!(node_txn[0], node_txn[3]);
2442 assert_eq!(node_txn[1], node_txn[4]);
2443 assert_eq!(node_txn[0], node_txn[5]);
2444 assert_eq!(node_txn[1], node_txn[6]);
2445 assert_eq!(node_txn[2], commitment_tx[0]);
2446 check_spends!(node_txn[0], commitment_tx[0].clone());
2447 check_spends!(node_txn[1], commitment_tx[0].clone());
2448 assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2449 assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2450 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2451 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2452 assert_eq!(node_txn[0].lock_time, 0);
2453 assert_eq!(node_txn[1].lock_time, 0);
2455 // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2456 nodes[1].block_notifier.block_connected(&Block { header, txdata: node_txn}, 1);
2457 let events = nodes[1].node.get_and_clear_pending_msg_events();
2459 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
2460 assert_eq!(added_monitors.len(), 2);
2461 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2462 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2463 added_monitors.clear();
2465 assert_eq!(events.len(), 2);
2467 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2468 _ => panic!("Unexpected event"),
2471 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, .. } } => {
2472 assert!(update_add_htlcs.is_empty());
2473 assert!(update_fail_htlcs.is_empty());
2474 assert_eq!(update_fulfill_htlcs.len(), 1);
2475 assert!(update_fail_malformed_htlcs.is_empty());
2476 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2478 _ => panic!("Unexpected event"),
2480 macro_rules! check_tx_local_broadcast {
2481 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2482 let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2483 assert_eq!(node_txn.len(), if $htlc_offered { 7 } else { 5 });
2484 // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2485 // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout * 2 (block-rescan)
2486 check_spends!(node_txn[0], $commitment_tx.clone());
2487 check_spends!(node_txn[1], $commitment_tx.clone());
2489 assert_eq!(node_txn[0], node_txn[5]);
2490 assert_eq!(node_txn[1], node_txn[6]);
2492 assert_ne!(node_txn[0].lock_time, 0);
2493 assert_ne!(node_txn[1].lock_time, 0);
2495 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2496 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2497 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2498 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2500 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2501 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2502 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2503 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2505 check_spends!(node_txn[2], $chan_tx.clone());
2506 check_spends!(node_txn[3], node_txn[2].clone());
2507 check_spends!(node_txn[4], node_txn[2].clone());
2508 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), 71);
2509 assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2510 assert_eq!(node_txn[4].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2511 assert!(node_txn[3].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2512 assert!(node_txn[4].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2513 assert_ne!(node_txn[3].lock_time, 0);
2514 assert_ne!(node_txn[4].lock_time, 0);
2518 // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2519 // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2520 // timeout-claim of the output that nodes[2] just claimed via success.
2521 check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2523 // Broadcast legit commitment tx from A on B's chain
2524 // Broadcast preimage tx by B on offered output from A commitment tx on A's chain
2525 let commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
2526 check_spends!(commitment_tx[0], chan_1.3.clone());
2527 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2528 check_closed_broadcast!(nodes[1], false);
2529 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 1 (HTLC-Success)
2530 assert_eq!(node_txn.len(), 4);
2531 check_spends!(node_txn[0], commitment_tx[0].clone());
2532 assert_eq!(node_txn[0].input.len(), 2);
2533 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2534 assert_eq!(node_txn[0].input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2535 assert_eq!(node_txn[0].lock_time, 0);
2536 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2537 check_spends!(node_txn[1], chan_1.3.clone());
2538 assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2539 check_spends!(node_txn[2], node_txn[1]);
2540 check_spends!(node_txn[3], node_txn[1]);
2541 // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2542 // we already checked the same situation with A.
2544 // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2545 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone(), node_txn[0].clone()] }, 1);
2546 check_closed_broadcast!(nodes[0], false);
2547 let events = nodes[0].node.get_and_clear_pending_events();
2548 assert_eq!(events.len(), 2);
2549 let mut first_claimed = false;
2550 for event in events {
2552 Event::PaymentSent { payment_preimage } => {
2553 if payment_preimage == our_payment_preimage {
2554 assert!(!first_claimed);
2555 first_claimed = true;
2557 assert_eq!(payment_preimage, our_payment_preimage_2);
2560 _ => panic!("Unexpected event"),
2563 check_tx_local_broadcast!(nodes[0], true, commitment_tx[0], chan_1.3);
2567 fn test_htlc_on_chain_timeout() {
2568 // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2569 // ChainWatchInterface and timeout the HTLC backward accordingly. So here we test that ChannelManager is
2570 // broadcasting the right event to other nodes in payment path.
2571 // A ------------------> B ----------------------> C (timeout)
2572 // B's commitment tx C's commitment tx
2574 // B's HTLC timeout tx B's timeout tx
2576 let chanmon_cfgs = create_chanmon_cfgs(3);
2577 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2578 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2579 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2581 // Create some intial channels
2582 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2583 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2585 // Rebalance the network a bit by relaying one payment thorugh all the channels...
2586 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2587 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2589 let (_payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2590 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2592 // Broadcast legit commitment tx from C on B's chain
2593 let commitment_tx = nodes[2].node.channel_state.lock().unwrap().by_id.get_mut(&chan_2.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
2594 check_spends!(commitment_tx[0], chan_2.3.clone());
2595 nodes[2].node.fail_htlc_backwards(&payment_hash);
2596 check_added_monitors!(nodes[2], 0);
2597 expect_pending_htlcs_forwardable!(nodes[2]);
2598 check_added_monitors!(nodes[2], 1);
2600 let events = nodes[2].node.get_and_clear_pending_msg_events();
2601 assert_eq!(events.len(), 1);
2603 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, .. } } => {
2604 assert!(update_add_htlcs.is_empty());
2605 assert!(!update_fail_htlcs.is_empty());
2606 assert!(update_fulfill_htlcs.is_empty());
2607 assert!(update_fail_malformed_htlcs.is_empty());
2608 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2610 _ => panic!("Unexpected event"),
2612 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2613 check_closed_broadcast!(nodes[2], false);
2614 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2615 assert_eq!(node_txn.len(), 1);
2616 check_spends!(node_txn[0], chan_2.3.clone());
2617 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2619 // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2620 // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2621 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2624 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2625 assert_eq!(node_txn.len(), 7); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : (local commitment tx + HTLC-timeout) * 2 (block-rescan), timeout tx
2626 assert_eq!(node_txn[1], node_txn[3]);
2627 assert_eq!(node_txn[1], node_txn[5]);
2628 assert_eq!(node_txn[2], node_txn[4]);
2629 assert_eq!(node_txn[2], node_txn[6]);
2630 check_spends!(node_txn[0], commitment_tx[0].clone());
2631 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2632 check_spends!(node_txn[1], chan_2.3.clone());
2633 check_spends!(node_txn[2], node_txn[1].clone());
2634 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2635 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2636 check_spends!(node_txn[3], chan_2.3.clone());
2637 check_spends!(node_txn[4], node_txn[3].clone());
2638 assert_eq!(node_txn[3].input[0].witness.clone().last().unwrap().len(), 71);
2639 assert_eq!(node_txn[4].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2640 timeout_tx = node_txn[0].clone();
2644 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![timeout_tx]}, 1);
2645 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2646 check_added_monitors!(nodes[1], 0);
2647 check_closed_broadcast!(nodes[1], false);
2649 expect_pending_htlcs_forwardable!(nodes[1]);
2650 check_added_monitors!(nodes[1], 1);
2651 let events = nodes[1].node.get_and_clear_pending_msg_events();
2652 assert_eq!(events.len(), 1);
2654 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, ref update_fulfill_htlcs, ref update_fail_malformed_htlcs, .. } } => {
2655 assert!(update_add_htlcs.is_empty());
2656 assert!(!update_fail_htlcs.is_empty());
2657 assert!(update_fulfill_htlcs.is_empty());
2658 assert!(update_fail_malformed_htlcs.is_empty());
2659 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2661 _ => panic!("Unexpected event"),
2663 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
2664 assert_eq!(node_txn.len(), 0);
2666 // Broadcast legit commitment tx from B on A's chain
2667 let commitment_tx = nodes[1].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
2668 check_spends!(commitment_tx[0], chan_1.3.clone());
2670 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2671 check_closed_broadcast!(nodes[0], false);
2672 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 1 timeout tx
2673 assert_eq!(node_txn.len(), 3);
2674 check_spends!(node_txn[0], commitment_tx[0].clone());
2675 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2676 check_spends!(node_txn[1], chan_1.3.clone());
2677 check_spends!(node_txn[2], node_txn[1].clone());
2678 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2679 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2683 fn test_simple_commitment_revoked_fail_backward() {
2684 // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
2685 // and fail backward accordingly.
2687 let chanmon_cfgs = create_chanmon_cfgs(3);
2688 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2689 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2690 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2692 // Create some initial channels
2693 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2694 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2696 let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2697 // Get the will-be-revoked local txn from nodes[2]
2698 let revoked_local_txn = nodes[2].node.channel_state.lock().unwrap().by_id.get_mut(&chan_2.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
2699 // Revoke the old state
2700 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, 3_000_000);
2702 route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2704 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2705 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2706 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2707 check_added_monitors!(nodes[1], 0);
2708 check_closed_broadcast!(nodes[1], false);
2710 expect_pending_htlcs_forwardable!(nodes[1]);
2711 check_added_monitors!(nodes[1], 1);
2712 let events = nodes[1].node.get_and_clear_pending_msg_events();
2713 assert_eq!(events.len(), 1);
2715 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, .. } } => {
2716 assert!(update_add_htlcs.is_empty());
2717 assert_eq!(update_fail_htlcs.len(), 1);
2718 assert!(update_fulfill_htlcs.is_empty());
2719 assert!(update_fail_malformed_htlcs.is_empty());
2720 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2722 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
2723 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2725 let events = nodes[0].node.get_and_clear_pending_msg_events();
2726 assert_eq!(events.len(), 1);
2728 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
2729 _ => panic!("Unexpected event"),
2731 let events = nodes[0].node.get_and_clear_pending_events();
2732 assert_eq!(events.len(), 1);
2734 Event::PaymentFailed { .. } => {},
2735 _ => panic!("Unexpected event"),
2738 _ => panic!("Unexpected event"),
2742 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
2743 // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
2744 // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
2745 // commitment transaction anymore.
2746 // To do this, we have the peer which will broadcast a revoked commitment transaction send
2747 // a number of update_fail/commitment_signed updates without ever sending the RAA in
2748 // response to our commitment_signed. This is somewhat misbehavior-y, though not
2749 // technically disallowed and we should probably handle it reasonably.
2750 // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
2751 // failed/fulfilled backwards must be in at least one of the latest two remote commitment
2753 // * Once we move it out of our holding cell/add it, we will immediately include it in a
2754 // commitment_signed (implying it will be in the latest remote commitment transaction).
2755 // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
2756 // and once they revoke the previous commitment transaction (allowing us to send a new
2757 // commitment_signed) we will be free to fail/fulfill the HTLC backwards.
2758 let chanmon_cfgs = create_chanmon_cfgs(3);
2759 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2760 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2761 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2763 // Create some initial channels
2764 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2765 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2767 let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], if no_to_remote { 10_000 } else { 3_000_000 });
2768 // Get the will-be-revoked local txn from nodes[2]
2769 let revoked_local_txn = nodes[2].node.channel_state.lock().unwrap().by_id.get_mut(&chan_2.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
2770 assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
2771 // Revoke the old state
2772 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, if no_to_remote { 10_000 } else { 3_000_000});
2774 let value = if use_dust {
2775 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
2776 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
2777 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().our_dust_limit_satoshis * 1000
2780 let (_, first_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2781 let (_, second_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2782 let (_, third_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2784 assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash));
2785 expect_pending_htlcs_forwardable!(nodes[2]);
2786 check_added_monitors!(nodes[2], 1);
2787 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2788 assert!(updates.update_add_htlcs.is_empty());
2789 assert!(updates.update_fulfill_htlcs.is_empty());
2790 assert!(updates.update_fail_malformed_htlcs.is_empty());
2791 assert_eq!(updates.update_fail_htlcs.len(), 1);
2792 assert!(updates.update_fee.is_none());
2793 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2794 let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
2795 // Drop the last RAA from 3 -> 2
2797 assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash));
2798 expect_pending_htlcs_forwardable!(nodes[2]);
2799 check_added_monitors!(nodes[2], 1);
2800 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2801 assert!(updates.update_add_htlcs.is_empty());
2802 assert!(updates.update_fulfill_htlcs.is_empty());
2803 assert!(updates.update_fail_malformed_htlcs.is_empty());
2804 assert_eq!(updates.update_fail_htlcs.len(), 1);
2805 assert!(updates.update_fee.is_none());
2806 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2807 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2808 check_added_monitors!(nodes[1], 1);
2809 // Note that nodes[1] is in AwaitingRAA, so won't send a CS
2810 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2811 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2812 check_added_monitors!(nodes[2], 1);
2814 assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash));
2815 expect_pending_htlcs_forwardable!(nodes[2]);
2816 check_added_monitors!(nodes[2], 1);
2817 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2818 assert!(updates.update_add_htlcs.is_empty());
2819 assert!(updates.update_fulfill_htlcs.is_empty());
2820 assert!(updates.update_fail_malformed_htlcs.is_empty());
2821 assert_eq!(updates.update_fail_htlcs.len(), 1);
2822 assert!(updates.update_fee.is_none());
2823 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2824 // At this point first_payment_hash has dropped out of the latest two commitment
2825 // transactions that nodes[1] is tracking...
2826 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2827 check_added_monitors!(nodes[1], 1);
2828 // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
2829 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2830 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2831 check_added_monitors!(nodes[2], 1);
2833 // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
2834 // on nodes[2]'s RAA.
2835 let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
2836 let (_, fourth_payment_hash) = get_payment_preimage_hash!(nodes[0]);
2837 nodes[1].node.send_payment(route, fourth_payment_hash).unwrap();
2838 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2839 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2840 check_added_monitors!(nodes[1], 0);
2843 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
2844 // One monitor for the new revocation preimage, no second on as we won't generate a new
2845 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
2846 check_added_monitors!(nodes[1], 1);
2847 let events = nodes[1].node.get_and_clear_pending_events();
2848 assert_eq!(events.len(), 1);
2850 Event::PendingHTLCsForwardable { .. } => { },
2851 _ => panic!("Unexpected event"),
2853 // Deliberately don't process the pending fail-back so they all fail back at once after
2854 // block connection just like the !deliver_bs_raa case
2857 let mut failed_htlcs = HashSet::new();
2858 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2860 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2861 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2862 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2864 let events = nodes[1].node.get_and_clear_pending_events();
2865 assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
2867 Event::PaymentFailed { ref payment_hash, .. } => {
2868 assert_eq!(*payment_hash, fourth_payment_hash);
2870 _ => panic!("Unexpected event"),
2872 if !deliver_bs_raa {
2874 Event::PendingHTLCsForwardable { .. } => { },
2875 _ => panic!("Unexpected event"),
2878 nodes[1].node.process_pending_htlc_forwards();
2879 check_added_monitors!(nodes[1], 1);
2881 let events = nodes[1].node.get_and_clear_pending_msg_events();
2882 assert_eq!(events.len(), if deliver_bs_raa { 3 } else { 2 });
2883 match events[if deliver_bs_raa { 1 } else { 0 }] {
2884 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
2885 _ => panic!("Unexpected event"),
2889 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, .. } } => {
2890 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
2891 assert_eq!(update_add_htlcs.len(), 1);
2892 assert!(update_fulfill_htlcs.is_empty());
2893 assert!(update_fail_htlcs.is_empty());
2894 assert!(update_fail_malformed_htlcs.is_empty());
2896 _ => panic!("Unexpected event"),
2899 match events[if deliver_bs_raa { 2 } else { 1 }] {
2900 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, .. } } => {
2901 assert!(update_add_htlcs.is_empty());
2902 assert_eq!(update_fail_htlcs.len(), 3);
2903 assert!(update_fulfill_htlcs.is_empty());
2904 assert!(update_fail_malformed_htlcs.is_empty());
2905 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2907 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
2908 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
2909 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
2911 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2913 let events = nodes[0].node.get_and_clear_pending_msg_events();
2914 // If we delivered B's RAA we got an unknown preimage error, not something
2915 // that we should update our routing table for.
2916 assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
2917 for event in events {
2919 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
2920 _ => panic!("Unexpected event"),
2923 let events = nodes[0].node.get_and_clear_pending_events();
2924 assert_eq!(events.len(), 3);
2926 Event::PaymentFailed { ref payment_hash, .. } => {
2927 assert!(failed_htlcs.insert(payment_hash.0));
2929 _ => panic!("Unexpected event"),
2932 Event::PaymentFailed { ref payment_hash, .. } => {
2933 assert!(failed_htlcs.insert(payment_hash.0));
2935 _ => panic!("Unexpected event"),
2938 Event::PaymentFailed { ref payment_hash, .. } => {
2939 assert!(failed_htlcs.insert(payment_hash.0));
2941 _ => panic!("Unexpected event"),
2944 _ => panic!("Unexpected event"),
2947 assert!(failed_htlcs.contains(&first_payment_hash.0));
2948 assert!(failed_htlcs.contains(&second_payment_hash.0));
2949 assert!(failed_htlcs.contains(&third_payment_hash.0));
2953 fn test_commitment_revoked_fail_backward_exhaustive_a() {
2954 do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
2955 do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
2956 do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
2957 do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
2961 fn test_commitment_revoked_fail_backward_exhaustive_b() {
2962 do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
2963 do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
2964 do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
2965 do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
2969 fn test_htlc_ignore_latest_remote_commitment() {
2970 // Test that HTLC transactions spending the latest remote commitment transaction are simply
2971 // ignored if we cannot claim them. This originally tickled an invalid unwrap().
2972 let chanmon_cfgs = create_chanmon_cfgs(2);
2973 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2974 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2975 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2976 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2978 route_payment(&nodes[0], &[&nodes[1]], 10000000);
2979 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id);
2980 check_closed_broadcast!(nodes[0], false);
2982 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2983 assert_eq!(node_txn.len(), 2);
2985 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2986 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
2987 check_closed_broadcast!(nodes[1], false);
2989 // Duplicate the block_connected call since this may happen due to other listeners
2990 // registering new transactions
2991 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
2995 fn test_force_close_fail_back() {
2996 // Check which HTLCs are failed-backwards on channel force-closure
2997 let chanmon_cfgs = create_chanmon_cfgs(3);
2998 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2999 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3000 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3001 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3002 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
3004 let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, 42).unwrap();
3006 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3008 let mut payment_event = {
3009 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
3010 check_added_monitors!(nodes[0], 1);
3012 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3013 assert_eq!(events.len(), 1);
3014 SendEvent::from_event(events.remove(0))
3017 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3018 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3020 expect_pending_htlcs_forwardable!(nodes[1]);
3022 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3023 assert_eq!(events_2.len(), 1);
3024 payment_event = SendEvent::from_event(events_2.remove(0));
3025 assert_eq!(payment_event.msgs.len(), 1);
3027 check_added_monitors!(nodes[1], 1);
3028 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3029 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3030 check_added_monitors!(nodes[2], 1);
3031 let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3033 // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3034 // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3035 // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3037 nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id);
3038 check_closed_broadcast!(nodes[2], false);
3040 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3041 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3042 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3043 // back to nodes[1] upon timeout otherwise.
3044 assert_eq!(node_txn.len(), 1);
3048 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3049 nodes[1].block_notifier.block_connected_checked(&header, 1, &[&tx], &[1]);
3051 // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3052 check_closed_broadcast!(nodes[1], false);
3054 // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3056 let mut monitors = nodes[2].chan_monitor.simple_monitor.monitors.lock().unwrap();
3057 monitors.get_mut(&OutPoint::new(Sha256dHash::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), 0)).unwrap()
3058 .provide_payment_preimage(&our_payment_hash, &our_payment_preimage);
3060 nodes[2].block_notifier.block_connected_checked(&header, 1, &[&tx], &[1]);
3061 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3062 assert_eq!(node_txn.len(), 1);
3063 assert_eq!(node_txn[0].input.len(), 1);
3064 assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3065 assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3066 assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3068 check_spends!(node_txn[0], tx);
3072 fn test_unconf_chan() {
3073 // After creating a chan between nodes, we disconnect all blocks previously seen to force a channel close on nodes[0] side
3074 let chanmon_cfgs = create_chanmon_cfgs(2);
3075 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3076 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3077 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3078 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3080 let channel_state = nodes[0].node.channel_state.lock().unwrap();
3081 assert_eq!(channel_state.by_id.len(), 1);
3082 assert_eq!(channel_state.short_to_id.len(), 1);
3083 mem::drop(channel_state);
3085 let mut headers = Vec::new();
3086 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3087 headers.push(header.clone());
3089 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3090 headers.push(header.clone());
3092 let mut height = 99;
3093 while !headers.is_empty() {
3094 nodes[0].node.block_disconnected(&headers.pop().unwrap(), height);
3097 check_closed_broadcast!(nodes[0], false);
3098 let channel_state = nodes[0].node.channel_state.lock().unwrap();
3099 assert_eq!(channel_state.by_id.len(), 0);
3100 assert_eq!(channel_state.short_to_id.len(), 0);
3104 fn test_simple_peer_disconnect() {
3105 // Test that we can reconnect when there are no lost messages
3106 let chanmon_cfgs = create_chanmon_cfgs(3);
3107 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3108 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3109 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3110 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3111 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
3113 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3114 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3115 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3117 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3118 let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3119 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3120 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1, 1_000_000);
3122 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3123 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3124 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3126 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3127 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3128 let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3129 let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3131 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3132 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3134 claim_payment_along_route(&nodes[0], &vec!(&nodes[1], &nodes[2]), true, payment_preimage_3, 1_000_000);
3135 fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3137 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3139 let events = nodes[0].node.get_and_clear_pending_events();
3140 assert_eq!(events.len(), 2);
3142 Event::PaymentSent { payment_preimage } => {
3143 assert_eq!(payment_preimage, payment_preimage_3);
3145 _ => panic!("Unexpected event"),
3148 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3149 assert_eq!(payment_hash, payment_hash_5);
3150 assert!(rejected_by_dest);
3152 _ => panic!("Unexpected event"),
3156 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4, 1_000_000);
3157 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3160 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
3161 // Test that we can reconnect when in-flight HTLC updates get dropped
3162 let chanmon_cfgs = create_chanmon_cfgs(2);
3163 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3164 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3165 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3166 if messages_delivered == 0 {
3167 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
3168 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3170 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3173 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();
3174 let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
3176 let payment_event = {
3177 nodes[0].node.send_payment(route.clone(), payment_hash_1).unwrap();
3178 check_added_monitors!(nodes[0], 1);
3180 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3181 assert_eq!(events.len(), 1);
3182 SendEvent::from_event(events.remove(0))
3184 assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3186 if messages_delivered < 2 {
3187 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3189 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3190 if messages_delivered >= 3 {
3191 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3192 check_added_monitors!(nodes[1], 1);
3193 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3195 if messages_delivered >= 4 {
3196 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3197 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3198 check_added_monitors!(nodes[0], 1);
3200 if messages_delivered >= 5 {
3201 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3202 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3203 // No commitment_signed so get_event_msg's assert(len == 1) passes
3204 check_added_monitors!(nodes[0], 1);
3206 if messages_delivered >= 6 {
3207 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3208 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3209 check_added_monitors!(nodes[1], 1);
3216 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3217 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3218 if messages_delivered < 3 {
3219 // Even if the funding_locked messages get exchanged, as long as nothing further was
3220 // received on either side, both sides will need to resend them.
3221 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3222 } else if messages_delivered == 3 {
3223 // nodes[0] still wants its RAA + commitment_signed
3224 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3225 } else if messages_delivered == 4 {
3226 // nodes[0] still wants its commitment_signed
3227 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3228 } else if messages_delivered == 5 {
3229 // nodes[1] still wants its final RAA
3230 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3231 } else if messages_delivered == 6 {
3232 // Everything was delivered...
3233 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3236 let events_1 = nodes[1].node.get_and_clear_pending_events();
3237 assert_eq!(events_1.len(), 1);
3239 Event::PendingHTLCsForwardable { .. } => { },
3240 _ => panic!("Unexpected event"),
3243 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3244 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3245 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3247 nodes[1].node.process_pending_htlc_forwards();
3249 let events_2 = nodes[1].node.get_and_clear_pending_events();
3250 assert_eq!(events_2.len(), 1);
3252 Event::PaymentReceived { ref payment_hash, amt } => {
3253 assert_eq!(payment_hash_1, *payment_hash);
3254 assert_eq!(amt, 1000000);
3256 _ => panic!("Unexpected event"),
3259 nodes[1].node.claim_funds(payment_preimage_1, 1_000_000);
3260 check_added_monitors!(nodes[1], 1);
3262 let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3263 assert_eq!(events_3.len(), 1);
3264 let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3265 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3266 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3267 assert!(updates.update_add_htlcs.is_empty());
3268 assert!(updates.update_fail_htlcs.is_empty());
3269 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3270 assert!(updates.update_fail_malformed_htlcs.is_empty());
3271 assert!(updates.update_fee.is_none());
3272 (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3274 _ => panic!("Unexpected event"),
3277 if messages_delivered >= 1 {
3278 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3280 let events_4 = nodes[0].node.get_and_clear_pending_events();
3281 assert_eq!(events_4.len(), 1);
3283 Event::PaymentSent { ref payment_preimage } => {
3284 assert_eq!(payment_preimage_1, *payment_preimage);
3286 _ => panic!("Unexpected event"),
3289 if messages_delivered >= 2 {
3290 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3291 check_added_monitors!(nodes[0], 1);
3292 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3294 if messages_delivered >= 3 {
3295 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3296 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3297 check_added_monitors!(nodes[1], 1);
3299 if messages_delivered >= 4 {
3300 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3301 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3302 // No commitment_signed so get_event_msg's assert(len == 1) passes
3303 check_added_monitors!(nodes[1], 1);
3305 if messages_delivered >= 5 {
3306 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3307 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3308 check_added_monitors!(nodes[0], 1);
3315 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3316 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3317 if messages_delivered < 2 {
3318 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3319 //TODO: Deduplicate PaymentSent events, then enable this if:
3320 //if messages_delivered < 1 {
3321 let events_4 = nodes[0].node.get_and_clear_pending_events();
3322 assert_eq!(events_4.len(), 1);
3324 Event::PaymentSent { ref payment_preimage } => {
3325 assert_eq!(payment_preimage_1, *payment_preimage);
3327 _ => panic!("Unexpected event"),
3330 } else if messages_delivered == 2 {
3331 // nodes[0] still wants its RAA + commitment_signed
3332 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3333 } else if messages_delivered == 3 {
3334 // nodes[0] still wants its commitment_signed
3335 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3336 } else if messages_delivered == 4 {
3337 // nodes[1] still wants its final RAA
3338 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3339 } else if messages_delivered == 5 {
3340 // Everything was delivered...
3341 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3344 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3345 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3346 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3348 // Channel should still work fine...
3349 let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3350 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3354 fn test_drop_messages_peer_disconnect_a() {
3355 do_test_drop_messages_peer_disconnect(0);
3356 do_test_drop_messages_peer_disconnect(1);
3357 do_test_drop_messages_peer_disconnect(2);
3358 do_test_drop_messages_peer_disconnect(3);
3362 fn test_drop_messages_peer_disconnect_b() {
3363 do_test_drop_messages_peer_disconnect(4);
3364 do_test_drop_messages_peer_disconnect(5);
3365 do_test_drop_messages_peer_disconnect(6);
3369 fn test_funding_peer_disconnect() {
3370 // Test that we can lock in our funding tx while disconnected
3371 let chanmon_cfgs = create_chanmon_cfgs(2);
3372 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3373 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3374 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3375 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
3377 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3378 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3380 confirm_transaction(&nodes[0].block_notifier, &nodes[0].chain_monitor, &tx, tx.version);
3381 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3382 assert_eq!(events_1.len(), 1);
3384 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3385 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3387 _ => panic!("Unexpected event"),
3390 reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3392 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3393 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3395 confirm_transaction(&nodes[1].block_notifier, &nodes[1].chain_monitor, &tx, tx.version);
3396 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3397 assert_eq!(events_2.len(), 2);
3398 let funding_locked = match events_2[0] {
3399 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3400 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3403 _ => panic!("Unexpected event"),
3405 let bs_announcement_sigs = match events_2[1] {
3406 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3407 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3410 _ => panic!("Unexpected event"),
3413 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3415 nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3416 nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3417 let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3418 assert_eq!(events_3.len(), 2);
3419 let as_announcement_sigs = match events_3[0] {
3420 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3421 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3424 _ => panic!("Unexpected event"),
3426 let (as_announcement, as_update) = match events_3[1] {
3427 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3428 (msg.clone(), update_msg.clone())
3430 _ => panic!("Unexpected event"),
3433 nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3434 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3435 assert_eq!(events_4.len(), 1);
3436 let (_, bs_update) = match events_4[0] {
3437 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3438 (msg.clone(), update_msg.clone())
3440 _ => panic!("Unexpected event"),
3443 nodes[0].router.handle_channel_announcement(&as_announcement).unwrap();
3444 nodes[0].router.handle_channel_update(&bs_update).unwrap();
3445 nodes[0].router.handle_channel_update(&as_update).unwrap();
3447 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
3448 let (payment_preimage, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3449 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage, 1_000_000);
3453 fn test_drop_messages_peer_disconnect_dual_htlc() {
3454 // Test that we can handle reconnecting when both sides of a channel have pending
3455 // commitment_updates when we disconnect.
3456 let chanmon_cfgs = create_chanmon_cfgs(2);
3457 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3458 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3459 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3460 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3462 let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3464 // Now try to send a second payment which will fail to send
3465 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
3466 let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
3468 nodes[0].node.send_payment(route.clone(), payment_hash_2).unwrap();
3469 check_added_monitors!(nodes[0], 1);
3471 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3472 assert_eq!(events_1.len(), 1);
3474 MessageSendEvent::UpdateHTLCs { .. } => {},
3475 _ => panic!("Unexpected event"),
3478 assert!(nodes[1].node.claim_funds(payment_preimage_1, 1_000_000));
3479 check_added_monitors!(nodes[1], 1);
3481 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3482 assert_eq!(events_2.len(), 1);
3484 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 } } => {
3485 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3486 assert!(update_add_htlcs.is_empty());
3487 assert_eq!(update_fulfill_htlcs.len(), 1);
3488 assert!(update_fail_htlcs.is_empty());
3489 assert!(update_fail_malformed_htlcs.is_empty());
3490 assert!(update_fee.is_none());
3492 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3493 let events_3 = nodes[0].node.get_and_clear_pending_events();
3494 assert_eq!(events_3.len(), 1);
3496 Event::PaymentSent { ref payment_preimage } => {
3497 assert_eq!(*payment_preimage, payment_preimage_1);
3499 _ => panic!("Unexpected event"),
3502 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
3503 let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3504 // No commitment_signed so get_event_msg's assert(len == 1) passes
3505 check_added_monitors!(nodes[0], 1);
3507 _ => panic!("Unexpected event"),
3510 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3511 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3513 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3514 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3515 assert_eq!(reestablish_1.len(), 1);
3516 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3517 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3518 assert_eq!(reestablish_2.len(), 1);
3520 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3521 let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3522 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3523 let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3525 assert!(as_resp.0.is_none());
3526 assert!(bs_resp.0.is_none());
3528 assert!(bs_resp.1.is_none());
3529 assert!(bs_resp.2.is_none());
3531 assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3533 assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3534 assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3535 assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3536 assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3537 assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3538 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
3539 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
3540 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3541 // No commitment_signed so get_event_msg's assert(len == 1) passes
3542 check_added_monitors!(nodes[1], 1);
3544 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
3545 let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3546 assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
3547 assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
3548 assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
3549 assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
3550 assert!(bs_second_commitment_signed.update_fee.is_none());
3551 check_added_monitors!(nodes[1], 1);
3553 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3554 let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3555 assert!(as_commitment_signed.update_add_htlcs.is_empty());
3556 assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
3557 assert!(as_commitment_signed.update_fail_htlcs.is_empty());
3558 assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
3559 assert!(as_commitment_signed.update_fee.is_none());
3560 check_added_monitors!(nodes[0], 1);
3562 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
3563 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3564 // No commitment_signed so get_event_msg's assert(len == 1) passes
3565 check_added_monitors!(nodes[0], 1);
3567 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
3568 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3569 // No commitment_signed so get_event_msg's assert(len == 1) passes
3570 check_added_monitors!(nodes[1], 1);
3572 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3573 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3574 check_added_monitors!(nodes[1], 1);
3576 expect_pending_htlcs_forwardable!(nodes[1]);
3578 let events_5 = nodes[1].node.get_and_clear_pending_events();
3579 assert_eq!(events_5.len(), 1);
3581 Event::PaymentReceived { ref payment_hash, amt: _ } => {
3582 assert_eq!(payment_hash_2, *payment_hash);
3584 _ => panic!("Unexpected event"),
3587 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
3588 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3589 check_added_monitors!(nodes[0], 1);
3591 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3595 fn test_invalid_channel_announcement() {
3596 //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
3597 let secp_ctx = Secp256k1::new();
3598 let chanmon_cfgs = create_chanmon_cfgs(2);
3599 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3600 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3601 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3603 let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::supported(), InitFeatures::supported());
3605 let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
3606 let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
3607 let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
3608 let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
3610 nodes[0].router.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap(), is_permanent: false } );
3612 let as_bitcoin_key = as_chan.get_local_keys().inner.local_channel_pubkeys.funding_pubkey;
3613 let bs_bitcoin_key = bs_chan.get_local_keys().inner.local_channel_pubkeys.funding_pubkey;
3615 let as_network_key = nodes[0].node.get_our_node_id();
3616 let bs_network_key = nodes[1].node.get_our_node_id();
3618 let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
3620 let mut chan_announcement;
3622 macro_rules! dummy_unsigned_msg {
3624 msgs::UnsignedChannelAnnouncement {
3625 features: ChannelFeatures::supported(),
3626 chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
3627 short_channel_id: as_chan.get_short_channel_id().unwrap(),
3628 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
3629 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
3630 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
3631 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
3632 excess_data: Vec::new(),
3637 macro_rules! sign_msg {
3638 ($unsigned_msg: expr) => {
3639 let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
3640 let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_local_keys().inner.funding_key());
3641 let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_local_keys().inner.funding_key());
3642 let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
3643 let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
3644 chan_announcement = msgs::ChannelAnnouncement {
3645 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
3646 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
3647 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
3648 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
3649 contents: $unsigned_msg
3654 let unsigned_msg = dummy_unsigned_msg!();
3655 sign_msg!(unsigned_msg);
3656 assert_eq!(nodes[0].router.handle_channel_announcement(&chan_announcement).unwrap(), true);
3657 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 } );
3659 // Configured with Network::Testnet
3660 let mut unsigned_msg = dummy_unsigned_msg!();
3661 unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.bitcoin_hash();
3662 sign_msg!(unsigned_msg);
3663 assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
3665 let mut unsigned_msg = dummy_unsigned_msg!();
3666 unsigned_msg.chain_hash = Sha256dHash::hash(&[1,2,3,4,5,6,7,8,9]);
3667 sign_msg!(unsigned_msg);
3668 assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
3672 fn test_no_txn_manager_serialize_deserialize() {
3673 let chanmon_cfgs = create_chanmon_cfgs(2);
3674 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3675 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3676 let new_chan_monitor: test_utils::TestChannelMonitor;
3677 let keys_manager: test_utils::TestKeysInterface;
3678 let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface>;
3679 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3681 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
3683 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3685 let nodes_0_serialized = nodes[0].node.encode();
3686 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3687 nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
3689 new_chan_monitor = test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), Arc::new(test_utils::TestLogger::new()), Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }));
3690 nodes[0].chan_monitor = &new_chan_monitor;
3691 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3692 let (_, mut chan_0_monitor) = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
3693 assert!(chan_0_monitor_read.is_empty());
3695 let mut nodes_0_read = &nodes_0_serialized[..];
3696 let config = UserConfig::default();
3697 keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new()));
3698 let (_, nodes_0_deserialized_tmp) = {
3699 let mut channel_monitors = HashMap::new();
3700 channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &mut chan_0_monitor);
3701 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3702 default_config: config,
3703 keys_manager: &keys_manager,
3704 fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
3705 monitor: nodes[0].chan_monitor,
3706 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3707 logger: Arc::new(test_utils::TestLogger::new()),
3708 channel_monitors: &mut channel_monitors,
3711 nodes_0_deserialized = nodes_0_deserialized_tmp;
3712 assert!(nodes_0_read.is_empty());
3714 assert!(nodes[0].chan_monitor.add_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
3715 nodes[0].node = &nodes_0_deserialized;
3716 nodes[0].block_notifier.register_listener(nodes[0].node);
3717 assert_eq!(nodes[0].node.list_channels().len(), 1);
3718 check_added_monitors!(nodes[0], 1);
3720 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3721 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3722 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3723 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3725 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3726 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3727 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3728 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3730 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
3731 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
3732 for node in nodes.iter() {
3733 assert!(node.router.handle_channel_announcement(&announcement).unwrap());
3734 node.router.handle_channel_update(&as_update).unwrap();
3735 node.router.handle_channel_update(&bs_update).unwrap();
3738 send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
3742 fn test_simple_manager_serialize_deserialize() {
3743 let chanmon_cfgs = create_chanmon_cfgs(2);
3744 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3745 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3746 let new_chan_monitor: test_utils::TestChannelMonitor;
3747 let keys_manager: test_utils::TestKeysInterface;
3748 let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface>;
3749 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3750 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3752 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3753 let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3755 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3757 let nodes_0_serialized = nodes[0].node.encode();
3758 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3759 nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
3761 new_chan_monitor = test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), Arc::new(test_utils::TestLogger::new()), Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }));
3762 nodes[0].chan_monitor = &new_chan_monitor;
3763 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3764 let (_, mut chan_0_monitor) = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
3765 assert!(chan_0_monitor_read.is_empty());
3767 let mut nodes_0_read = &nodes_0_serialized[..];
3768 keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new()));
3769 let (_, nodes_0_deserialized_tmp) = {
3770 let mut channel_monitors = HashMap::new();
3771 channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &mut chan_0_monitor);
3772 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3773 default_config: UserConfig::default(),
3774 keys_manager: &keys_manager,
3775 fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
3776 monitor: nodes[0].chan_monitor,
3777 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3778 logger: Arc::new(test_utils::TestLogger::new()),
3779 channel_monitors: &mut channel_monitors,
3782 nodes_0_deserialized = nodes_0_deserialized_tmp;
3783 assert!(nodes_0_read.is_empty());
3785 assert!(nodes[0].chan_monitor.add_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
3786 nodes[0].node = &nodes_0_deserialized;
3787 check_added_monitors!(nodes[0], 1);
3789 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3791 fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
3792 claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage, 1_000_000);
3796 fn test_manager_serialize_deserialize_inconsistent_monitor() {
3797 // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
3798 let chanmon_cfgs = create_chanmon_cfgs(4);
3799 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
3800 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
3801 let new_chan_monitor: test_utils::TestChannelMonitor;
3802 let keys_manager: test_utils::TestKeysInterface;
3803 let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface>;
3804 let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
3805 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3806 create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::supported(), InitFeatures::supported());
3807 let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::supported(), InitFeatures::supported());
3809 let (our_payment_preimage, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
3811 // Serialize the ChannelManager here, but the monitor we keep up-to-date
3812 let nodes_0_serialized = nodes[0].node.encode();
3814 route_payment(&nodes[0], &[&nodes[3]], 1000000);
3815 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3816 nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3817 nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3819 // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
3821 let mut node_0_monitors_serialized = Vec::new();
3822 for monitor in nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter() {
3823 let mut writer = test_utils::TestVecWriter(Vec::new());
3824 monitor.1.write_for_disk(&mut writer).unwrap();
3825 node_0_monitors_serialized.push(writer.0);
3828 new_chan_monitor = test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), Arc::new(test_utils::TestLogger::new()), Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }));
3829 nodes[0].chan_monitor = &new_chan_monitor;
3830 let mut node_0_monitors = Vec::new();
3831 for serialized in node_0_monitors_serialized.iter() {
3832 let mut read = &serialized[..];
3833 let (_, monitor) = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut read, Arc::new(test_utils::TestLogger::new())).unwrap();
3834 assert!(read.is_empty());
3835 node_0_monitors.push(monitor);
3838 let mut nodes_0_read = &nodes_0_serialized[..];
3839 keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new()));
3840 let (_, nodes_0_deserialized_tmp) = <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3841 default_config: UserConfig::default(),
3842 keys_manager: &keys_manager,
3843 fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
3844 monitor: nodes[0].chan_monitor,
3845 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3846 logger: Arc::new(test_utils::TestLogger::new()),
3847 channel_monitors: &mut node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().unwrap(), monitor) }).collect(),
3849 nodes_0_deserialized = nodes_0_deserialized_tmp;
3850 assert!(nodes_0_read.is_empty());
3852 { // Channel close should result in a commitment tx and an HTLC tx
3853 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3854 assert_eq!(txn.len(), 2);
3855 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
3856 assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
3859 for monitor in node_0_monitors.drain(..) {
3860 assert!(nodes[0].chan_monitor.add_monitor(monitor.get_funding_txo().unwrap(), monitor).is_ok());
3861 check_added_monitors!(nodes[0], 1);
3863 nodes[0].node = &nodes_0_deserialized;
3865 // nodes[1] and nodes[2] have no lost state with nodes[0]...
3866 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3867 reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3868 //... and we can even still claim the payment!
3869 claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage, 1_000_000);
3871 nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3872 let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
3873 nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3874 nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
3875 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
3876 assert_eq!(msg_events.len(), 1);
3877 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
3879 &ErrorAction::SendErrorMessage { ref msg } => {
3880 assert_eq!(msg.channel_id, channel_id);
3882 _ => panic!("Unexpected event!"),
3887 macro_rules! check_spendable_outputs {
3888 ($node: expr, $der_idx: expr) => {
3890 let events = $node.chan_monitor.simple_monitor.get_and_clear_pending_events();
3891 let mut txn = Vec::new();
3892 for event in events {
3894 Event::SpendableOutputs { ref outputs } => {
3895 for outp in outputs {
3897 SpendableOutputDescriptor::DynamicOutputP2WPKH { ref outpoint, ref key, ref output } => {
3899 previous_output: outpoint.clone(),
3900 script_sig: Script::new(),
3902 witness: Vec::new(),
3905 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
3906 value: output.value,
3908 let mut spend_tx = Transaction {
3914 let secp_ctx = Secp256k1::new();
3915 let remotepubkey = PublicKey::from_secret_key(&secp_ctx, &key);
3916 let witness_script = Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: remotepubkey}, Network::Testnet).script_pubkey();
3917 let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
3918 let remotesig = secp_ctx.sign(&sighash, key);
3919 spend_tx.input[0].witness.push(remotesig.serialize_der().to_vec());
3920 spend_tx.input[0].witness[0].push(SigHashType::All as u8);
3921 spend_tx.input[0].witness.push(remotepubkey.serialize().to_vec());
3924 SpendableOutputDescriptor::DynamicOutputP2WSH { ref outpoint, ref key, ref witness_script, ref to_self_delay, ref output } => {
3926 previous_output: outpoint.clone(),
3927 script_sig: Script::new(),
3928 sequence: *to_self_delay as u32,
3929 witness: Vec::new(),
3932 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
3933 value: output.value,
3935 let mut spend_tx = Transaction {
3941 let secp_ctx = Secp256k1::new();
3942 let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], witness_script, output.value)[..]).unwrap();
3943 let local_delaysig = secp_ctx.sign(&sighash, key);
3944 spend_tx.input[0].witness.push(local_delaysig.serialize_der().to_vec());
3945 spend_tx.input[0].witness[0].push(SigHashType::All as u8);
3946 spend_tx.input[0].witness.push(vec!(0));
3947 spend_tx.input[0].witness.push(witness_script.clone().into_bytes());
3950 SpendableOutputDescriptor::StaticOutput { ref outpoint, ref output } => {
3951 let secp_ctx = Secp256k1::new();
3953 previous_output: outpoint.clone(),
3954 script_sig: Script::new(),
3956 witness: Vec::new(),
3959 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
3960 value: output.value,
3962 let mut spend_tx = Transaction {
3966 output: vec![outp.clone()],
3969 match ExtendedPrivKey::new_master(Network::Testnet, &$node.node_seed) {
3971 match master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx($der_idx).expect("key space exhausted")) {
3973 Err(_) => panic!("Your RNG is busted"),
3976 Err(_) => panic!("Your rng is busted"),
3979 let pubkey = ExtendedPubKey::from_private(&secp_ctx, &secret).public_key;
3980 let witness_script = Address::p2pkh(&pubkey, Network::Testnet).script_pubkey();
3981 let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
3982 let sig = secp_ctx.sign(&sighash, &secret.private_key.key);
3983 spend_tx.input[0].witness.push(sig.serialize_der().to_vec());
3984 spend_tx.input[0].witness[0].push(SigHashType::All as u8);
3985 spend_tx.input[0].witness.push(pubkey.key.serialize().to_vec());
3991 _ => panic!("Unexpected event"),
4000 fn test_claim_sizeable_push_msat() {
4001 // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4002 let chanmon_cfgs = create_chanmon_cfgs(2);
4003 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4004 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4005 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4007 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::supported(), InitFeatures::supported());
4008 nodes[1].node.force_close_channel(&chan.2);
4009 check_closed_broadcast!(nodes[1], false);
4010 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4011 assert_eq!(node_txn.len(), 1);
4012 check_spends!(node_txn[0], chan.3.clone());
4013 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
4015 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4016 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
4017 let spend_txn = check_spendable_outputs!(nodes[1], 1);
4018 assert_eq!(spend_txn.len(), 1);
4019 check_spends!(spend_txn[0], node_txn[0].clone());
4023 fn test_claim_on_remote_sizeable_push_msat() {
4024 // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4025 // to_remote output is encumbered by a P2WPKH
4026 let chanmon_cfgs = create_chanmon_cfgs(2);
4027 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4028 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4029 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4031 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::supported(), InitFeatures::supported());
4032 nodes[0].node.force_close_channel(&chan.2);
4033 check_closed_broadcast!(nodes[0], false);
4035 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4036 assert_eq!(node_txn.len(), 1);
4037 check_spends!(node_txn[0], chan.3.clone());
4038 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
4040 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4041 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
4042 check_closed_broadcast!(nodes[1], false);
4043 let spend_txn = check_spendable_outputs!(nodes[1], 1);
4044 assert_eq!(spend_txn.len(), 2);
4045 assert_eq!(spend_txn[0], spend_txn[1]);
4046 check_spends!(spend_txn[0], node_txn[0].clone());
4050 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4051 // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4052 // to_remote output is encumbered by a P2WPKH
4054 let chanmon_cfgs = create_chanmon_cfgs(2);
4055 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4056 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4057 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4059 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::supported(), InitFeatures::supported());
4060 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4061 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
4062 assert_eq!(revoked_local_txn[0].input.len(), 1);
4063 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4065 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4066 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4067 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4068 check_closed_broadcast!(nodes[1], false);
4070 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4071 let spend_txn = check_spendable_outputs!(nodes[1], 1);
4072 assert_eq!(spend_txn.len(), 4);
4073 assert_eq!(spend_txn[0], spend_txn[2]); // to_remote output on revoked remote commitment_tx
4074 check_spends!(spend_txn[0], revoked_local_txn[0].clone());
4075 assert_eq!(spend_txn[1], spend_txn[3]); // to_local output on local commitment tx
4076 check_spends!(spend_txn[1], node_txn[0].clone());
4080 fn test_static_spendable_outputs_preimage_tx() {
4081 let chanmon_cfgs = create_chanmon_cfgs(2);
4082 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4083 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4084 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4086 // Create some initial channels
4087 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4089 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4091 let commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
4092 assert_eq!(commitment_tx[0].input.len(), 1);
4093 assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4095 // Settle A's commitment tx on B's chain
4096 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4097 assert!(nodes[1].node.claim_funds(payment_preimage, 3_000_000));
4098 check_added_monitors!(nodes[1], 1);
4099 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()] }, 1);
4100 let events = nodes[1].node.get_and_clear_pending_msg_events();
4102 MessageSendEvent::UpdateHTLCs { .. } => {},
4103 _ => panic!("Unexpected event"),
4106 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4107 _ => panic!("Unexepected event"),
4110 // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4111 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4112 assert_eq!(node_txn.len(), 3);
4113 check_spends!(node_txn[0], commitment_tx[0].clone());
4114 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4115 eprintln!("{:?}", node_txn[1]);
4116 check_spends!(node_txn[1], chan_1.3.clone());
4117 check_spends!(node_txn[2], node_txn[1]);
4119 let spend_txn = check_spendable_outputs!(nodes[1], 1); // , 0, 0, 1, 1);
4120 assert_eq!(spend_txn.len(), 2);
4121 assert_eq!(spend_txn[0], spend_txn[1]);
4122 check_spends!(spend_txn[0], node_txn[0].clone());
4126 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
4127 let chanmon_cfgs = create_chanmon_cfgs(2);
4128 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4129 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4130 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4132 // Create some initial channels
4133 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4135 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4136 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.iter_mut().next().unwrap().1.channel_monitor().get_latest_local_commitment_txn();
4137 assert_eq!(revoked_local_txn[0].input.len(), 1);
4138 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4140 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4142 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4143 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4144 check_closed_broadcast!(nodes[1], false);
4146 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4147 assert_eq!(node_txn.len(), 2);
4148 assert_eq!(node_txn[0].input.len(), 2);
4149 check_spends!(node_txn[0], revoked_local_txn[0].clone());
4151 let spend_txn = check_spendable_outputs!(nodes[1], 1);
4152 assert_eq!(spend_txn.len(), 2);
4153 assert_eq!(spend_txn[0], spend_txn[1]);
4154 check_spends!(spend_txn[0], node_txn[0].clone());
4158 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
4159 let chanmon_cfgs = create_chanmon_cfgs(2);
4160 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4161 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4162 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4164 // Create some initial channels
4165 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4167 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4168 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
4169 assert_eq!(revoked_local_txn[0].input.len(), 1);
4170 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4172 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4174 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4175 // A will generate HTLC-Timeout from revoked commitment tx
4176 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4177 check_closed_broadcast!(nodes[0], false);
4179 let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4180 assert_eq!(revoked_htlc_txn.len(), 3);
4181 assert_eq!(revoked_htlc_txn[0], revoked_htlc_txn[2]);
4182 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4183 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4184 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
4185 check_spends!(revoked_htlc_txn[1], chan_1.3.clone());
4187 // B will generate justice tx from A's revoked commitment/HTLC tx
4188 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
4189 check_closed_broadcast!(nodes[1], false);
4191 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4192 assert_eq!(node_txn.len(), 4 ); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-timeout, adjusted justice tx, ChannelManager: local commitment tx
4193 assert_eq!(node_txn[2].input.len(), 1);
4194 check_spends!(node_txn[2], revoked_htlc_txn[0].clone());
4196 // Check B's ChannelMonitor was able to generate the right spendable output descriptor
4197 let spend_txn = check_spendable_outputs!(nodes[1], 1);
4198 assert_eq!(spend_txn.len(), 3);
4199 assert_eq!(spend_txn[0], spend_txn[1]);
4200 check_spends!(spend_txn[0], node_txn[0].clone());
4201 check_spends!(spend_txn[2], node_txn[2].clone());
4205 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
4206 let chanmon_cfgs = create_chanmon_cfgs(2);
4207 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4208 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4209 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4211 // Create some initial channels
4212 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4214 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4215 let revoked_local_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
4216 assert_eq!(revoked_local_txn[0].input.len(), 1);
4217 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4219 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4221 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4222 // B will generate HTLC-Success from revoked commitment tx
4223 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4224 check_closed_broadcast!(nodes[1], false);
4225 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4227 assert_eq!(revoked_htlc_txn.len(), 3);
4228 assert_eq!(revoked_htlc_txn[0], revoked_htlc_txn[2]);
4229 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4230 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4231 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
4233 // A will generate justice tx from B's revoked commitment/HTLC tx
4234 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
4235 check_closed_broadcast!(nodes[0], false);
4237 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4238 assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
4239 assert_eq!(node_txn[2].input.len(), 1);
4240 check_spends!(node_txn[2], revoked_htlc_txn[0].clone());
4242 // Check A's ChannelMonitor was able to generate the right spendable output descriptor
4243 let spend_txn = check_spendable_outputs!(nodes[0], 1);
4244 assert_eq!(spend_txn.len(), 5);
4245 assert_eq!(spend_txn[0], spend_txn[2]);
4246 assert_eq!(spend_txn[1], spend_txn[3]);
4247 check_spends!(spend_txn[0], revoked_local_txn[0].clone()); // spending to_remote output from revoked local tx
4248 check_spends!(spend_txn[1], node_txn[0].clone()); // spending justice tx output from revoked local tx htlc received output
4249 check_spends!(spend_txn[4], node_txn[2].clone()); // spending justice tx output on htlc success tx
4253 fn test_onchain_to_onchain_claim() {
4254 // Test that in case of channel closure, we detect the state of output thanks to
4255 // ChainWatchInterface and claim HTLC on downstream peer's remote commitment tx.
4256 // First, have C claim an HTLC against its own latest commitment transaction.
4257 // Then, broadcast these to B, which should update the monitor downstream on the A<->B
4259 // Finally, check that B will claim the HTLC output if A's latest commitment transaction
4262 let chanmon_cfgs = create_chanmon_cfgs(3);
4263 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4264 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4265 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4267 // Create some initial channels
4268 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4269 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
4271 // Rebalance the network a bit by relaying one payment through all the channels ...
4272 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
4273 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
4275 let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
4276 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
4277 let commitment_tx = nodes[2].node.channel_state.lock().unwrap().by_id.get_mut(&chan_2.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
4278 check_spends!(commitment_tx[0], chan_2.3.clone());
4279 nodes[2].node.claim_funds(payment_preimage, 3_000_000);
4280 check_added_monitors!(nodes[2], 1);
4281 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
4282 assert!(updates.update_add_htlcs.is_empty());
4283 assert!(updates.update_fail_htlcs.is_empty());
4284 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4285 assert!(updates.update_fail_malformed_htlcs.is_empty());
4287 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
4288 check_closed_broadcast!(nodes[2], false);
4290 let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
4291 assert_eq!(c_txn.len(), 4);
4292 assert_eq!(c_txn[0], c_txn[2]);
4293 assert_eq!(c_txn[0], c_txn[3]);
4294 assert_eq!(commitment_tx[0], c_txn[1]);
4295 check_spends!(c_txn[1], chan_2.3.clone());
4296 check_spends!(c_txn[2], c_txn[1].clone());
4297 assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
4298 assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4299 assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
4300 assert_eq!(c_txn[0].lock_time, 0); // Success tx
4302 // 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
4303 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]}, 1);
4305 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4306 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-timeout tx
4307 assert_eq!(b_txn.len(), 3);
4308 check_spends!(b_txn[1], chan_2.3); // B local commitment tx, issued by ChannelManager
4309 check_spends!(b_txn[2], b_txn[1].clone()); // HTLC-Timeout on B local commitment tx, issued by ChannelManager
4310 assert_eq!(b_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4311 assert!(b_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
4312 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
4313 check_spends!(b_txn[0], c_txn[1].clone()); // timeout tx on C remote commitment tx, issued by ChannelMonitor, * 2 due to block rescan
4314 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4315 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
4316 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
4319 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
4320 check_added_monitors!(nodes[1], 1);
4321 match msg_events[0] {
4322 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4323 _ => panic!("Unexpected event"),
4325 match msg_events[1] {
4326 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, .. } } => {
4327 assert!(update_add_htlcs.is_empty());
4328 assert!(update_fail_htlcs.is_empty());
4329 assert_eq!(update_fulfill_htlcs.len(), 1);
4330 assert!(update_fail_malformed_htlcs.is_empty());
4331 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
4333 _ => panic!("Unexpected event"),
4335 // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
4336 let commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
4337 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
4338 let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4339 // ChannelMonitor: HTLC-Success tx, ChannelManager: local commitment tx + HTLC-Success tx
4340 assert_eq!(b_txn.len(), 3);
4341 check_spends!(b_txn[1], chan_1.3);
4342 check_spends!(b_txn[2], b_txn[1].clone());
4343 check_spends!(b_txn[0], commitment_tx[0].clone());
4344 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4345 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
4346 assert_eq!(b_txn[0].lock_time, 0); // Success tx
4348 check_closed_broadcast!(nodes[1], false);
4352 fn test_duplicate_payment_hash_one_failure_one_success() {
4353 // Topology : A --> B --> C
4354 // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
4355 let chanmon_cfgs = create_chanmon_cfgs(3);
4356 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4357 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4358 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4360 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4361 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
4363 let (our_payment_preimage, duplicate_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
4364 *nodes[0].network_payment_count.borrow_mut() -= 1;
4365 assert_eq!(route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000).1, duplicate_payment_hash);
4367 let commitment_txn = nodes[2].node.channel_state.lock().unwrap().by_id.get_mut(&chan_2.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
4368 assert_eq!(commitment_txn[0].input.len(), 1);
4369 check_spends!(commitment_txn[0], chan_2.3.clone());
4371 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4372 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
4373 check_closed_broadcast!(nodes[1], false);
4375 let htlc_timeout_tx;
4376 { // Extract one of the two HTLC-Timeout transaction
4377 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4378 // ChannelMonitor: timeout tx * 2, ChannelManager: local commitment tx + HTLC-timeout * 2
4379 assert_eq!(node_txn.len(), 5);
4380 check_spends!(node_txn[0], commitment_txn[0].clone());
4381 assert_eq!(node_txn[0].input.len(), 1);
4382 check_spends!(node_txn[1], commitment_txn[0].clone());
4383 assert_eq!(node_txn[1].input.len(), 1);
4384 assert_ne!(node_txn[0].input[0], node_txn[1].input[0]);
4385 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4386 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4387 check_spends!(node_txn[2], chan_2.3.clone());
4388 check_spends!(node_txn[3], node_txn[2].clone());
4389 check_spends!(node_txn[4], node_txn[2].clone());
4390 htlc_timeout_tx = node_txn[1].clone();
4393 nodes[2].node.claim_funds(our_payment_preimage, 900_000);
4394 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
4395 check_added_monitors!(nodes[2], 2);
4396 let events = nodes[2].node.get_and_clear_pending_msg_events();
4398 MessageSendEvent::UpdateHTLCs { .. } => {},
4399 _ => panic!("Unexpected event"),
4402 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4403 _ => panic!("Unexepected event"),
4405 let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
4406 assert_eq!(htlc_success_txn.len(), 7);
4407 check_spends!(htlc_success_txn[2], chan_2.3.clone());
4408 check_spends!(htlc_success_txn[3], htlc_success_txn[2]);
4409 check_spends!(htlc_success_txn[4], htlc_success_txn[2]);
4410 assert_eq!(htlc_success_txn[0], htlc_success_txn[5]);
4411 assert_eq!(htlc_success_txn[0].input.len(), 1);
4412 assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4413 assert_eq!(htlc_success_txn[1], htlc_success_txn[4]);
4414 assert_eq!(htlc_success_txn[1].input.len(), 1);
4415 assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4416 assert_ne!(htlc_success_txn[0].input[0], htlc_success_txn[1].input[0]);
4417 check_spends!(htlc_success_txn[0], commitment_txn[0].clone());
4418 check_spends!(htlc_success_txn[1], commitment_txn[0].clone());
4420 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![htlc_timeout_tx] }, 200);
4421 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
4422 expect_pending_htlcs_forwardable!(nodes[1]);
4423 let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4424 assert!(htlc_updates.update_add_htlcs.is_empty());
4425 assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
4426 assert_eq!(htlc_updates.update_fail_htlcs[0].htlc_id, 1);
4427 assert!(htlc_updates.update_fulfill_htlcs.is_empty());
4428 assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
4429 check_added_monitors!(nodes[1], 1);
4431 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
4432 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4434 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
4435 let events = nodes[0].node.get_and_clear_pending_msg_events();
4436 assert_eq!(events.len(), 1);
4438 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. } } => {
4440 _ => { panic!("Unexpected event"); }
4443 let events = nodes[0].node.get_and_clear_pending_events();
4445 Event::PaymentFailed { ref payment_hash, .. } => {
4446 assert_eq!(*payment_hash, duplicate_payment_hash);
4448 _ => panic!("Unexpected event"),
4451 // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
4452 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![htlc_success_txn[0].clone()] }, 200);
4453 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4454 assert!(updates.update_add_htlcs.is_empty());
4455 assert!(updates.update_fail_htlcs.is_empty());
4456 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4457 assert_eq!(updates.update_fulfill_htlcs[0].htlc_id, 0);
4458 assert!(updates.update_fail_malformed_htlcs.is_empty());
4459 check_added_monitors!(nodes[1], 1);
4461 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
4462 commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
4464 let events = nodes[0].node.get_and_clear_pending_events();
4466 Event::PaymentSent { ref payment_preimage } => {
4467 assert_eq!(*payment_preimage, our_payment_preimage);
4469 _ => panic!("Unexpected event"),
4474 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
4475 let chanmon_cfgs = create_chanmon_cfgs(2);
4476 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4477 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4478 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4480 // Create some initial channels
4481 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4483 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
4484 let local_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
4485 assert_eq!(local_txn[0].input.len(), 1);
4486 check_spends!(local_txn[0], chan_1.3.clone());
4488 // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
4489 nodes[1].node.claim_funds(payment_preimage, 9_000_000);
4490 check_added_monitors!(nodes[1], 1);
4491 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4492 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![local_txn[0].clone()] }, 1);
4493 let events = nodes[1].node.get_and_clear_pending_msg_events();
4495 MessageSendEvent::UpdateHTLCs { .. } => {},
4496 _ => panic!("Unexpected event"),
4499 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4500 _ => panic!("Unexepected event"),
4502 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4503 assert_eq!(node_txn[0].input.len(), 1);
4504 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4505 check_spends!(node_txn[0], local_txn[0].clone());
4507 // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
4508 let spend_txn = check_spendable_outputs!(nodes[1], 1);
4509 assert_eq!(spend_txn.len(), 2);
4510 check_spends!(spend_txn[0], node_txn[0].clone());
4511 check_spends!(spend_txn[1], node_txn[2].clone());
4514 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
4515 // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
4516 // unrevoked commitment transaction.
4517 // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
4518 // a remote RAA before they could be failed backwards (and combinations thereof).
4519 // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
4520 // use the same payment hashes.
4521 // Thus, we use a six-node network:
4526 // And test where C fails back to A/B when D announces its latest commitment transaction
4527 let chanmon_cfgs = create_chanmon_cfgs(6);
4528 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
4529 let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
4530 let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
4532 create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::supported(), InitFeatures::supported());
4533 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
4534 let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
4535 create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::supported(), InitFeatures::supported());
4536 create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::supported(), InitFeatures::supported());
4538 // Rebalance and check output sanity...
4539 send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000, 500_000);
4540 send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000, 500_000);
4541 assert_eq!(nodes[3].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn()[0].output.len(), 2);
4543 let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
4545 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
4547 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
4548 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();
4550 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
4552 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
4554 let (_, payment_hash_3) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4556 let (_, payment_hash_4) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4557 let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4559 send_along_route_with_hash(&nodes[1], route.clone(), &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_3);
4561 send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_4);
4564 let (_, payment_hash_5) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4566 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();
4567 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
4570 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
4572 let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4573 send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_6);
4575 // Double-check that six of the new HTLC were added
4576 // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
4577 // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
4578 assert_eq!(nodes[3].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn().len(), 1);
4579 assert_eq!(nodes[3].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn()[0].output.len(), 8);
4581 // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
4582 // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
4583 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1));
4584 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3));
4585 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5));
4586 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6));
4587 check_added_monitors!(nodes[4], 0);
4588 expect_pending_htlcs_forwardable!(nodes[4]);
4589 check_added_monitors!(nodes[4], 1);
4591 let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
4592 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
4593 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
4594 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
4595 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
4596 commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
4598 // Fail 3rd below-dust and 7th above-dust HTLCs
4599 assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2));
4600 assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4));
4601 check_added_monitors!(nodes[5], 0);
4602 expect_pending_htlcs_forwardable!(nodes[5]);
4603 check_added_monitors!(nodes[5], 1);
4605 let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
4606 nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
4607 nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
4608 commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
4610 let ds_prev_commitment_tx = nodes[3].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
4612 expect_pending_htlcs_forwardable!(nodes[3]);
4613 check_added_monitors!(nodes[3], 1);
4614 let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
4615 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
4616 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
4617 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
4618 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
4619 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
4620 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
4621 if deliver_last_raa {
4622 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
4624 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
4627 // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
4628 // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
4629 // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
4630 // propagated back to A/B yet (and D has two unrevoked commitment transactions).
4632 // We now broadcast the latest commitment transaction, which *should* result in failures for
4633 // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
4634 // the non-broadcast above-dust HTLCs.
4636 // Alternatively, we may broadcast the previous commitment transaction, which should only
4637 // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
4638 let ds_last_commitment_tx = nodes[3].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
4640 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4641 if announce_latest {
4642 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![ds_last_commitment_tx[0].clone()]}, 1);
4644 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![ds_prev_commitment_tx[0].clone()]}, 1);
4646 connect_blocks(&nodes[2].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4647 check_closed_broadcast!(nodes[2], false);
4648 expect_pending_htlcs_forwardable!(nodes[2]);
4649 check_added_monitors!(nodes[2], 2);
4651 let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
4652 assert_eq!(cs_msgs.len(), 2);
4653 let mut a_done = false;
4654 for msg in cs_msgs {
4656 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
4657 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
4658 // should be failed-backwards here.
4659 let target = if *node_id == nodes[0].node.get_our_node_id() {
4660 // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
4661 for htlc in &updates.update_fail_htlcs {
4662 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 });
4664 assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
4669 // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
4670 for htlc in &updates.update_fail_htlcs {
4671 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
4673 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
4674 assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
4677 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
4678 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
4679 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
4680 if announce_latest {
4681 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
4682 if *node_id == nodes[0].node.get_our_node_id() {
4683 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
4686 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
4688 _ => panic!("Unexpected event"),
4692 let as_events = nodes[0].node.get_and_clear_pending_events();
4693 assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
4694 let mut as_failds = HashSet::new();
4695 for event in as_events.iter() {
4696 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
4697 assert!(as_failds.insert(*payment_hash));
4698 if *payment_hash != payment_hash_2 {
4699 assert_eq!(*rejected_by_dest, deliver_last_raa);
4701 assert!(!rejected_by_dest);
4703 } else { panic!("Unexpected event"); }
4705 assert!(as_failds.contains(&payment_hash_1));
4706 assert!(as_failds.contains(&payment_hash_2));
4707 if announce_latest {
4708 assert!(as_failds.contains(&payment_hash_3));
4709 assert!(as_failds.contains(&payment_hash_5));
4711 assert!(as_failds.contains(&payment_hash_6));
4713 let bs_events = nodes[1].node.get_and_clear_pending_events();
4714 assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
4715 let mut bs_failds = HashSet::new();
4716 for event in bs_events.iter() {
4717 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
4718 assert!(bs_failds.insert(*payment_hash));
4719 if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
4720 assert_eq!(*rejected_by_dest, deliver_last_raa);
4722 assert!(!rejected_by_dest);
4724 } else { panic!("Unexpected event"); }
4726 assert!(bs_failds.contains(&payment_hash_1));
4727 assert!(bs_failds.contains(&payment_hash_2));
4728 if announce_latest {
4729 assert!(bs_failds.contains(&payment_hash_4));
4731 assert!(bs_failds.contains(&payment_hash_5));
4733 // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
4734 // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
4735 // to unknown-preimage-etc, B should have gotten 2. Thus, in the
4736 // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
4737 // PaymentFailureNetworkUpdates.
4738 let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4739 assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
4740 let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
4741 assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
4742 for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
4744 &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
4745 _ => panic!("Unexpected event"),
4751 fn test_fail_backwards_latest_remote_announce_a() {
4752 do_test_fail_backwards_unrevoked_remote_announce(false, true);
4756 fn test_fail_backwards_latest_remote_announce_b() {
4757 do_test_fail_backwards_unrevoked_remote_announce(true, true);
4761 fn test_fail_backwards_previous_remote_announce() {
4762 do_test_fail_backwards_unrevoked_remote_announce(false, false);
4763 // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
4764 // tested for in test_commitment_revoked_fail_backward_exhaustive()
4768 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
4769 let chanmon_cfgs = create_chanmon_cfgs(2);
4770 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4771 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4772 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4774 // Create some initial channels
4775 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4777 route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
4778 let local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
4779 assert_eq!(local_txn[0].input.len(), 1);
4780 check_spends!(local_txn[0], chan_1.3.clone());
4782 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
4783 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4784 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![local_txn[0].clone()] }, 200);
4785 check_closed_broadcast!(nodes[0], false);
4787 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4788 assert_eq!(node_txn[0].input.len(), 1);
4789 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4790 check_spends!(node_txn[0], local_txn[0].clone());
4792 // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
4793 let spend_txn = check_spendable_outputs!(nodes[0], 1);
4794 assert_eq!(spend_txn.len(), 8);
4795 assert_eq!(spend_txn[0], spend_txn[2]);
4796 assert_eq!(spend_txn[0], spend_txn[4]);
4797 assert_eq!(spend_txn[0], spend_txn[6]);
4798 assert_eq!(spend_txn[1], spend_txn[3]);
4799 assert_eq!(spend_txn[1], spend_txn[5]);
4800 assert_eq!(spend_txn[1], spend_txn[7]);
4801 check_spends!(spend_txn[0], local_txn[0].clone());
4802 check_spends!(spend_txn[1], node_txn[0].clone());
4806 fn test_static_output_closing_tx() {
4807 let chanmon_cfgs = create_chanmon_cfgs(2);
4808 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4809 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4810 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4812 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4814 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
4815 let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
4817 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4818 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![closing_tx.clone()] }, 1);
4819 let spend_txn = check_spendable_outputs!(nodes[0], 2);
4820 assert_eq!(spend_txn.len(), 1);
4821 check_spends!(spend_txn[0], closing_tx.clone());
4823 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![closing_tx.clone()] }, 1);
4824 let spend_txn = check_spendable_outputs!(nodes[1], 2);
4825 assert_eq!(spend_txn.len(), 1);
4826 check_spends!(spend_txn[0], closing_tx);
4829 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
4830 let chanmon_cfgs = create_chanmon_cfgs(2);
4831 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4832 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4833 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4834 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4836 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
4838 // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
4839 // present in B's local commitment transaction, but none of A's commitment transactions.
4840 assert!(nodes[1].node.claim_funds(our_payment_preimage, if use_dust { 50_000 } else { 3_000_000 }));
4841 check_added_monitors!(nodes[1], 1);
4843 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4844 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
4845 let events = nodes[0].node.get_and_clear_pending_events();
4846 assert_eq!(events.len(), 1);
4848 Event::PaymentSent { payment_preimage } => {
4849 assert_eq!(payment_preimage, our_payment_preimage);
4851 _ => panic!("Unexpected event"),
4854 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
4855 check_added_monitors!(nodes[0], 1);
4856 let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4857 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
4858 check_added_monitors!(nodes[1], 1);
4860 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4861 for i in 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + CHAN_CONFIRM_DEPTH + 1 {
4862 nodes[1].block_notifier.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
4863 header.prev_blockhash = header.bitcoin_hash();
4865 test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
4866 check_closed_broadcast!(nodes[1], false);
4869 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
4870 let chanmon_cfgs = create_chanmon_cfgs(2);
4871 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4872 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4873 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4874 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4876 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();
4877 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
4878 nodes[0].node.send_payment(route, payment_hash).unwrap();
4879 check_added_monitors!(nodes[0], 1);
4881 let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4883 // As far as A is concerned, the HTLC is now present only in the latest remote commitment
4884 // transaction, however it is not in A's latest local commitment, so we can just broadcast that
4885 // to "time out" the HTLC.
4887 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4889 for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
4890 nodes[0].block_notifier.block_connected(&Block { header, txdata: Vec::new()}, i);
4891 header.prev_blockhash = header.bitcoin_hash();
4893 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
4894 check_closed_broadcast!(nodes[0], false);
4897 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
4898 let chanmon_cfgs = create_chanmon_cfgs(3);
4899 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4900 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4901 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4902 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4904 // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
4905 // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
4906 // Also optionally test that we *don't* fail the channel in case the commitment transaction was
4907 // actually revoked.
4908 let htlc_value = if use_dust { 50000 } else { 3000000 };
4909 let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
4910 assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash));
4911 expect_pending_htlcs_forwardable!(nodes[1]);
4912 check_added_monitors!(nodes[1], 1);
4914 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4915 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
4916 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
4917 check_added_monitors!(nodes[0], 1);
4918 let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4919 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
4920 check_added_monitors!(nodes[1], 1);
4921 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
4922 check_added_monitors!(nodes[1], 1);
4923 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4925 if check_revoke_no_close {
4926 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
4927 check_added_monitors!(nodes[0], 1);
4930 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4931 for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
4932 nodes[0].block_notifier.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
4933 header.prev_blockhash = header.bitcoin_hash();
4935 if !check_revoke_no_close {
4936 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
4937 check_closed_broadcast!(nodes[0], false);
4939 let events = nodes[0].node.get_and_clear_pending_events();
4940 assert_eq!(events.len(), 1);
4942 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
4943 assert_eq!(payment_hash, our_payment_hash);
4944 assert!(rejected_by_dest);
4946 _ => panic!("Unexpected event"),
4951 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
4952 // There are only a few cases to test here:
4953 // * its not really normative behavior, but we test that below-dust HTLCs "included" in
4954 // broadcastable commitment transactions result in channel closure,
4955 // * its included in an unrevoked-but-previous remote commitment transaction,
4956 // * its included in the latest remote or local commitment transactions.
4957 // We test each of the three possible commitment transactions individually and use both dust and
4959 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
4960 // assume they are handled the same across all six cases, as both outbound and inbound failures are
4961 // tested for at least one of the cases in other tests.
4963 fn htlc_claim_single_commitment_only_a() {
4964 do_htlc_claim_local_commitment_only(true);
4965 do_htlc_claim_local_commitment_only(false);
4967 do_htlc_claim_current_remote_commitment_only(true);
4968 do_htlc_claim_current_remote_commitment_only(false);
4972 fn htlc_claim_single_commitment_only_b() {
4973 do_htlc_claim_previous_remote_commitment_only(true, false);
4974 do_htlc_claim_previous_remote_commitment_only(false, false);
4975 do_htlc_claim_previous_remote_commitment_only(true, true);
4976 do_htlc_claim_previous_remote_commitment_only(false, true);
4979 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>)
4980 where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
4983 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);
4987 // 0: node1 fails backward
4988 // 1: final node fails backward
4989 // 2: payment completed but the user rejects the payment
4990 // 3: final node fails backward (but tamper onion payloads from node0)
4991 // 100: trigger error in the intermediate node and tamper returning fail_htlc
4992 // 200: trigger error in the final node and tamper returning fail_htlc
4993 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>)
4994 where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
4995 F2: for <'a> FnMut(&'a mut msgs::UpdateFailHTLC),
4999 // reset block height
5000 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5001 for ix in 0..nodes.len() {
5002 nodes[ix].block_notifier.block_connected_checked(&header, 1, &[], &[]);
5005 macro_rules! expect_event {
5006 ($node: expr, $event_type: path) => {{
5007 let events = $node.node.get_and_clear_pending_events();
5008 assert_eq!(events.len(), 1);
5010 $event_type { .. } => {},
5011 _ => panic!("Unexpected event"),
5016 macro_rules! expect_htlc_forward {
5018 expect_event!($node, Event::PendingHTLCsForwardable);
5019 $node.node.process_pending_htlc_forwards();
5023 // 0 ~~> 2 send payment
5024 nodes[0].node.send_payment(route.clone(), payment_hash.clone()).unwrap();
5025 check_added_monitors!(nodes[0], 1);
5026 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5027 // temper update_add (0 => 1)
5028 let mut update_add_0 = update_0.update_add_htlcs[0].clone();
5029 if test_case == 0 || test_case == 3 || test_case == 100 {
5030 callback_msg(&mut update_add_0);
5033 // 0 => 1 update_add & CS
5034 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0);
5035 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
5037 let update_1_0 = match test_case {
5038 0|100 => { // intermediate node failure; fail backward to 0
5039 let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5040 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));
5043 1|2|3|200 => { // final node failure; forwarding to 2
5044 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
5046 if test_case != 200 {
5049 expect_htlc_forward!(&nodes[1]);
5051 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
5052 check_added_monitors!(&nodes[1], 1);
5053 assert_eq!(update_1.update_add_htlcs.len(), 1);
5054 // tamper update_add (1 => 2)
5055 let mut update_add_1 = update_1.update_add_htlcs[0].clone();
5056 if test_case != 3 && test_case != 200 {
5057 callback_msg(&mut update_add_1);
5061 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1);
5062 commitment_signed_dance!(nodes[2], nodes[1], update_1.commitment_signed, false, true);
5064 if test_case == 2 || test_case == 200 {
5065 expect_htlc_forward!(&nodes[2]);
5066 expect_event!(&nodes[2], Event::PaymentReceived);
5068 expect_pending_htlcs_forwardable!(nodes[2]);
5071 let update_2_1 = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5072 if test_case == 2 || test_case == 200 {
5073 check_added_monitors!(&nodes[2], 1);
5075 assert!(update_2_1.update_fail_htlcs.len() == 1);
5077 let mut fail_msg = update_2_1.update_fail_htlcs[0].clone();
5078 if test_case == 200 {
5079 callback_fail(&mut fail_msg);
5083 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &fail_msg);
5084 commitment_signed_dance!(nodes[1], nodes[2], update_2_1.commitment_signed, true);
5086 // backward fail on 1
5087 let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5088 assert!(update_1_0.update_fail_htlcs.len() == 1);
5091 _ => unreachable!(),
5094 // 1 => 0 commitment_signed_dance
5095 if update_1_0.update_fail_htlcs.len() > 0 {
5096 let mut fail_msg = update_1_0.update_fail_htlcs[0].clone();
5097 if test_case == 100 {
5098 callback_fail(&mut fail_msg);
5100 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
5102 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_1_0.update_fail_malformed_htlcs[0]);
5105 commitment_signed_dance!(nodes[0], nodes[1], update_1_0.commitment_signed, false, true);
5107 let events = nodes[0].node.get_and_clear_pending_events();
5108 assert_eq!(events.len(), 1);
5109 if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code } = &events[0] {
5110 assert_eq!(*rejected_by_dest, !expected_retryable);
5111 assert_eq!(*error_code, expected_error_code);
5113 panic!("Uexpected event");
5116 let events = nodes[0].node.get_and_clear_pending_msg_events();
5117 if expected_channel_update.is_some() {
5118 assert_eq!(events.len(), 1);
5120 MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
5122 &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {
5123 if let HTLCFailChannelUpdate::ChannelUpdateMessage { .. } = expected_channel_update.unwrap() {} else {
5124 panic!("channel_update not found!");
5127 &HTLCFailChannelUpdate::ChannelClosed { ref short_channel_id, ref is_permanent } => {
5128 if let HTLCFailChannelUpdate::ChannelClosed { short_channel_id: ref expected_short_channel_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
5129 assert!(*short_channel_id == *expected_short_channel_id);
5130 assert!(*is_permanent == *expected_is_permanent);
5132 panic!("Unexpected message event");
5135 &HTLCFailChannelUpdate::NodeFailure { ref node_id, ref is_permanent } => {
5136 if let HTLCFailChannelUpdate::NodeFailure { node_id: ref expected_node_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
5137 assert!(*node_id == *expected_node_id);
5138 assert!(*is_permanent == *expected_is_permanent);
5140 panic!("Unexpected message event");
5145 _ => panic!("Unexpected message event"),
5148 assert_eq!(events.len(), 0);
5152 impl msgs::ChannelUpdate {
5153 fn dummy() -> msgs::ChannelUpdate {
5154 use secp256k1::ffi::Signature as FFISignature;
5155 use secp256k1::Signature;
5156 msgs::ChannelUpdate {
5157 signature: Signature::from(FFISignature::new()),
5158 contents: msgs::UnsignedChannelUpdate {
5159 chain_hash: Sha256dHash::hash(&vec![0u8][..]),
5160 short_channel_id: 0,
5163 cltv_expiry_delta: 0,
5164 htlc_minimum_msat: 0,
5166 fee_proportional_millionths: 0,
5167 excess_data: vec![],
5173 struct BogusOnionHopData {
5176 impl BogusOnionHopData {
5177 fn new(orig: msgs::OnionHopData) -> Self {
5178 Self { data: orig.encode() }
5181 impl Writeable for BogusOnionHopData {
5182 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
5183 writer.write_all(&self.data[..])
5188 fn test_onion_failure() {
5189 use ln::msgs::ChannelUpdate;
5190 use ln::channelmanager::CLTV_FAR_FAR_AWAY;
5193 const BADONION: u16 = 0x8000;
5194 const PERM: u16 = 0x4000;
5195 const NODE: u16 = 0x2000;
5196 const UPDATE: u16 = 0x1000;
5198 let chanmon_cfgs = create_chanmon_cfgs(3);
5199 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5200 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5201 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5202 for node in nodes.iter() {
5203 *node.keys_manager.override_session_priv.lock().unwrap() = Some(SecretKey::from_slice(&[3; 32]).unwrap());
5205 let channels = [create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()), create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported())];
5206 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
5207 let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV).unwrap();
5209 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 40000, 40_000);
5211 // intermediate node failure
5212 run_onion_failure_test("invalid_realm", 0, &nodes, &route, &payment_hash, |msg| {
5213 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5214 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5215 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5216 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
5217 let mut new_payloads = Vec::new();
5218 for payload in onion_payloads.drain(..) {
5219 new_payloads.push(BogusOnionHopData::new(payload));
5221 // break the first (non-final) hop payload by swapping the realm (0) byte for a byte
5222 // describing a length-1 TLV payload, which is obviously bogus.
5223 new_payloads[0].data[0] = 1;
5224 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
5225 }, ||{}, true, Some(PERM|22), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));//XXX incremented channels idx here
5227 // final node failure
5228 run_onion_failure_test("invalid_realm", 3, &nodes, &route, &payment_hash, |msg| {
5229 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5230 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5231 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5232 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
5233 let mut new_payloads = Vec::new();
5234 for payload in onion_payloads.drain(..) {
5235 new_payloads.push(BogusOnionHopData::new(payload));
5237 // break the last-hop payload by swapping the realm (0) byte for a byte describing a
5238 // length-1 TLV payload, which is obviously bogus.
5239 new_payloads[1].data[0] = 1;
5240 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
5241 }, ||{}, false, Some(PERM|22), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
5243 // the following three with run_onion_failure_test_with_fail_intercept() test only the origin node
5244 // receiving simulated fail messages
5245 // intermediate node failure
5246 run_onion_failure_test_with_fail_intercept("temporary_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
5248 msg.amount_msat -= 1;
5250 // and tamper returning error message
5251 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5252 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5253 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], NODE|2, &[0;0]);
5254 }, ||{}, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: false}));
5256 // final node failure
5257 run_onion_failure_test_with_fail_intercept("temporary_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
5258 // and tamper returning error message
5259 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5260 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5261 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], NODE|2, &[0;0]);
5263 nodes[2].node.fail_htlc_backwards(&payment_hash);
5264 }, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: false}));
5266 // intermediate node failure
5267 run_onion_failure_test_with_fail_intercept("permanent_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
5268 msg.amount_msat -= 1;
5270 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5271 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5272 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|2, &[0;0]);
5273 }, ||{}, true, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: true}));
5275 // final node failure
5276 run_onion_failure_test_with_fail_intercept("permanent_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
5277 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5278 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5279 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|2, &[0;0]);
5281 nodes[2].node.fail_htlc_backwards(&payment_hash);
5282 }, false, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: true}));
5284 // intermediate node failure
5285 run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
5286 msg.amount_msat -= 1;
5288 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5289 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5290 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|3, &[0;0]);
5292 nodes[2].node.fail_htlc_backwards(&payment_hash);
5293 }, true, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: true}));
5295 // final node failure
5296 run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
5297 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5298 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5299 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|3, &[0;0]);
5301 nodes[2].node.fail_htlc_backwards(&payment_hash);
5302 }, false, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: true}));
5304 run_onion_failure_test("invalid_onion_version", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.version = 1; }, ||{}, true,
5305 Some(BADONION|PERM|4), None);
5307 run_onion_failure_test("invalid_onion_hmac", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.hmac = [3; 32]; }, ||{}, true,
5308 Some(BADONION|PERM|5), None);
5310 run_onion_failure_test("invalid_onion_key", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.public_key = Err(secp256k1::Error::InvalidPublicKey);}, ||{}, true,
5311 Some(BADONION|PERM|6), None);
5313 run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
5314 msg.amount_msat -= 1;
5316 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5317 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5318 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], UPDATE|7, &ChannelUpdate::dummy().encode_with_len()[..]);
5319 }, ||{}, true, Some(UPDATE|7), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5321 run_onion_failure_test_with_fail_intercept("permanent_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
5322 msg.amount_msat -= 1;
5324 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5325 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5326 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|8, &[0;0]);
5327 // short_channel_id from the processing node
5328 }, ||{}, true, Some(PERM|8), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
5330 run_onion_failure_test_with_fail_intercept("required_channel_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
5331 msg.amount_msat -= 1;
5333 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5334 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5335 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|9, &[0;0]);
5336 // short_channel_id from the processing node
5337 }, ||{}, true, Some(PERM|9), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
5339 let mut bogus_route = route.clone();
5340 bogus_route.hops[1].short_channel_id -= 1;
5341 run_onion_failure_test("unknown_next_peer", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(PERM|10),
5342 Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: bogus_route.hops[1].short_channel_id, is_permanent:true}));
5344 let amt_to_forward = nodes[1].node.channel_state.lock().unwrap().by_id.get(&channels[1].2).unwrap().get_their_htlc_minimum_msat() - 1;
5345 let mut bogus_route = route.clone();
5346 let route_len = bogus_route.hops.len();
5347 bogus_route.hops[route_len-1].fee_msat = amt_to_forward;
5348 run_onion_failure_test("amount_below_minimum", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(UPDATE|11), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5350 //TODO: with new config API, we will be able to generate both valid and
5351 //invalid channel_update cases.
5352 run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, |msg| {
5353 msg.amount_msat -= 1;
5354 }, || {}, true, Some(UPDATE|12), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
5356 run_onion_failure_test("incorrect_cltv_expiry", 0, &nodes, &route, &payment_hash, |msg| {
5357 // need to violate: cltv_expiry - cltv_expiry_delta >= outgoing_cltv_value
5358 msg.cltv_expiry -= 1;
5359 }, || {}, true, Some(UPDATE|13), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
5361 run_onion_failure_test("expiry_too_soon", 0, &nodes, &route, &payment_hash, |msg| {
5362 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
5363 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5365 nodes[1].block_notifier.block_connected_checked(&header, height, &[], &[]);
5366 }, ||{}, true, Some(UPDATE|14), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5368 run_onion_failure_test("unknown_payment_hash", 2, &nodes, &route, &payment_hash, |_| {}, || {
5369 nodes[2].node.fail_htlc_backwards(&payment_hash);
5370 }, false, Some(PERM|15), None);
5372 run_onion_failure_test("final_expiry_too_soon", 1, &nodes, &route, &payment_hash, |msg| {
5373 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
5374 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5376 nodes[2].block_notifier.block_connected_checked(&header, height, &[], &[]);
5377 }, || {}, true, Some(17), None);
5379 run_onion_failure_test("final_incorrect_cltv_expiry", 1, &nodes, &route, &payment_hash, |_| {}, || {
5380 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
5381 for f in pending_forwards.iter_mut() {
5383 &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
5384 forward_info.outgoing_cltv_value += 1,
5389 }, true, Some(18), None);
5391 run_onion_failure_test("final_incorrect_htlc_amount", 1, &nodes, &route, &payment_hash, |_| {}, || {
5392 // violate amt_to_forward > msg.amount_msat
5393 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
5394 for f in pending_forwards.iter_mut() {
5396 &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
5397 forward_info.amt_to_forward -= 1,
5402 }, true, Some(19), None);
5404 run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, |_| {}, || {
5405 // disconnect event to the channel between nodes[1] ~ nodes[2]
5406 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
5407 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5408 }, true, Some(UPDATE|20), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5409 reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
5411 run_onion_failure_test("expiry_too_far", 0, &nodes, &route, &payment_hash, |msg| {
5412 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5413 let mut route = route.clone();
5415 route.hops[1].cltv_expiry_delta += CLTV_FAR_FAR_AWAY + route.hops[0].cltv_expiry_delta + 1;
5416 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5417 let (onion_payloads, _, htlc_cltv) = onion_utils::build_onion_payloads(&route, height).unwrap();
5418 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
5419 msg.cltv_expiry = htlc_cltv;
5420 msg.onion_routing_packet = onion_packet;
5421 }, ||{}, true, Some(21), None);
5426 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
5427 let chanmon_cfgs = create_chanmon_cfgs(2);
5428 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5429 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5430 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5431 //Force duplicate channel ids
5432 for node in nodes.iter() {
5433 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
5436 // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
5437 let channel_value_satoshis=10000;
5438 let push_msat=10001;
5439 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).unwrap();
5440 let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5441 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::supported(), &node0_to_1_send_open_channel);
5443 //Create a second channel with a channel_id collision
5444 assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).is_err());
5448 fn bolt2_open_channel_sending_node_checks_part2() {
5449 let chanmon_cfgs = create_chanmon_cfgs(2);
5450 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5451 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5452 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5454 // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
5455 let channel_value_satoshis=2^24;
5456 let push_msat=10001;
5457 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).is_err());
5459 // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
5460 let channel_value_satoshis=10000;
5461 // Test when push_msat is equal to 1000 * funding_satoshis.
5462 let push_msat=1000*channel_value_satoshis+1;
5463 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).is_err());
5465 // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
5466 let channel_value_satoshis=10000;
5467 let push_msat=10001;
5468 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
5469 let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5470 assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
5472 // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
5473 // 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
5474 assert!(node0_to_1_send_open_channel.channel_flags<=1);
5476 // 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.
5477 assert!(BREAKDOWN_TIMEOUT>0);
5478 assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
5480 // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
5481 let chain_hash=genesis_block(Network::Testnet).header.bitcoin_hash();
5482 assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
5484 // 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.
5485 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
5486 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
5487 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
5488 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_basepoint.serialize()).is_ok());
5489 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
5492 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
5493 // 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.
5494 //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.
5497 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
5498 //BOLT2 Requirement: MUST offer amount_msat greater than 0.
5499 //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
5500 let chanmon_cfgs = create_chanmon_cfgs(2);
5501 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5502 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5503 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5504 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5505 let mut route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5506 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5508 route.hops[0].fee_msat = 0;
5510 let err = nodes[0].node.send_payment(route, our_payment_hash);
5512 if let Err(APIError::ChannelUnavailable{err}) = err {
5513 assert_eq!(err, "Cannot send less than their minimum HTLC value");
5517 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5518 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
5522 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
5523 //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
5524 //It is enforced when constructing a route.
5525 let chanmon_cfgs = create_chanmon_cfgs(2);
5526 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5527 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5528 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5529 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 0, InitFeatures::supported(), InitFeatures::supported());
5530 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000000, 500000001).unwrap();
5531 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5533 let err = nodes[0].node.send_payment(route, our_payment_hash);
5535 if let Err(APIError::RouteError{err}) = err {
5536 assert_eq!(err, "Channel CLTV overflowed?!");
5543 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
5544 //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.
5545 //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
5546 //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
5547 let chanmon_cfgs = create_chanmon_cfgs(2);
5548 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5549 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5550 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5551 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::supported(), InitFeatures::supported());
5552 let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().their_max_accepted_htlcs as u64;
5554 for i in 0..max_accepted_htlcs {
5555 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5556 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5557 let payment_event = {
5558 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5559 check_added_monitors!(nodes[0], 1);
5561 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5562 assert_eq!(events.len(), 1);
5563 if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
5564 assert_eq!(htlcs[0].htlc_id, i);
5568 SendEvent::from_event(events.remove(0))
5570 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
5571 check_added_monitors!(nodes[1], 0);
5572 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
5574 expect_pending_htlcs_forwardable!(nodes[1]);
5575 expect_payment_received!(nodes[1], our_payment_hash, 100000);
5577 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5578 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5579 let err = nodes[0].node.send_payment(route, our_payment_hash);
5581 if let Err(APIError::ChannelUnavailable{err}) = err {
5582 assert_eq!(err, "Cannot push more than their max accepted HTLCs");
5586 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5587 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
5591 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
5592 //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.
5593 let chanmon_cfgs = create_chanmon_cfgs(2);
5594 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5595 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5596 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5597 let channel_value = 100000;
5598 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::supported(), InitFeatures::supported());
5599 let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).their_max_htlc_value_in_flight_msat;
5601 send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight, max_in_flight);
5603 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], max_in_flight+1, TEST_FINAL_CLTV).unwrap();
5604 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5605 let err = nodes[0].node.send_payment(route, our_payment_hash);
5607 if let Err(APIError::ChannelUnavailable{err}) = err {
5608 assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight our peer will accept");
5612 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5613 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over the max HTLC value in flight our peer will accept".to_string(), 1);
5615 send_payment(&nodes[0], &[&nodes[1]], max_in_flight, max_in_flight);
5618 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
5620 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
5621 //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
5622 let chanmon_cfgs = create_chanmon_cfgs(2);
5623 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5624 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5625 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5626 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5627 let htlc_minimum_msat: u64;
5629 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
5630 let channel = chan_lock.by_id.get(&chan.2).unwrap();
5631 htlc_minimum_msat = channel.get_our_htlc_minimum_msat();
5633 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], htlc_minimum_msat, TEST_FINAL_CLTV).unwrap();
5634 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5635 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5636 check_added_monitors!(nodes[0], 1);
5637 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5638 updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
5639 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5640 assert!(nodes[1].node.list_channels().is_empty());
5641 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5642 assert_eq!(err_msg.data, "Remote side tried to send less than our minimum HTLC value");
5646 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
5647 //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
5648 let chanmon_cfgs = create_chanmon_cfgs(2);
5649 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5650 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5651 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5652 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5654 let their_channel_reserve = get_channel_value_stat!(nodes[0], chan.2).channel_reserve_msat;
5656 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 5000000-their_channel_reserve, TEST_FINAL_CLTV).unwrap();
5657 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5658 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5659 check_added_monitors!(nodes[0], 1);
5660 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5662 updates.update_add_htlcs[0].amount_msat = 5000000-their_channel_reserve+1;
5663 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5665 assert!(nodes[1].node.list_channels().is_empty());
5666 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5667 assert_eq!(err_msg.data, "Remote HTLC add would put them over their reserve value");
5671 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
5672 //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
5673 //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
5674 let chanmon_cfgs = create_chanmon_cfgs(2);
5675 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5676 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5677 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5678 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5679 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 3999999, TEST_FINAL_CLTV).unwrap();
5680 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5682 let session_priv = SecretKey::from_slice(&{
5683 let mut session_key = [0; 32];
5684 let mut rng = thread_rng();
5685 rng.fill_bytes(&mut session_key);
5687 }).expect("RNG is bad!");
5689 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5690 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route, &session_priv).unwrap();
5691 let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
5692 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
5694 let mut msg = msgs::UpdateAddHTLC {
5698 payment_hash: our_payment_hash,
5699 cltv_expiry: htlc_cltv,
5700 onion_routing_packet: onion_packet.clone(),
5703 for i in 0..super::channel::OUR_MAX_HTLCS {
5704 msg.htlc_id = i as u64;
5705 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
5707 msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
5708 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
5710 assert!(nodes[1].node.list_channels().is_empty());
5711 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5712 assert_eq!(err_msg.data, "Remote tried to push more than our max accepted HTLCs");
5716 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
5717 //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
5718 let chanmon_cfgs = create_chanmon_cfgs(2);
5719 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5720 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5721 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5722 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
5723 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5724 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5725 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5726 check_added_monitors!(nodes[0], 1);
5727 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5728 updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).their_max_htlc_value_in_flight_msat + 1;
5729 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5731 assert!(nodes[1].node.list_channels().is_empty());
5732 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5733 assert_eq!(err_msg.data,"Remote HTLC add would put them over our max HTLC value");
5737 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
5738 //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
5739 let chanmon_cfgs = create_chanmon_cfgs(2);
5740 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5741 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5742 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5743 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5744 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 3999999, TEST_FINAL_CLTV).unwrap();
5745 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5746 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5747 check_added_monitors!(nodes[0], 1);
5748 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5749 updates.update_add_htlcs[0].cltv_expiry = 500000000;
5750 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5752 assert!(nodes[1].node.list_channels().is_empty());
5753 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5754 assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
5758 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
5759 //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
5760 // We test this by first testing that that repeated HTLCs pass commitment signature checks
5761 // after disconnect and that non-sequential htlc_ids result in a channel failure.
5762 let chanmon_cfgs = create_chanmon_cfgs(2);
5763 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5764 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5765 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5766 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5767 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5768 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5769 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5770 check_added_monitors!(nodes[0], 1);
5771 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5772 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5774 //Disconnect and Reconnect
5775 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5776 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5777 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
5778 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
5779 assert_eq!(reestablish_1.len(), 1);
5780 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
5781 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
5782 assert_eq!(reestablish_2.len(), 1);
5783 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
5784 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
5785 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
5786 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
5789 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5790 assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
5791 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
5792 check_added_monitors!(nodes[1], 1);
5793 let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5795 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5797 assert!(nodes[1].node.list_channels().is_empty());
5798 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5799 assert_eq!(err_msg.data, "Remote skipped HTLC ID");
5803 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
5804 //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.
5806 let chanmon_cfgs = create_chanmon_cfgs(2);
5807 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5808 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5809 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5810 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5812 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5813 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5814 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5815 check_added_monitors!(nodes[0], 1);
5816 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5817 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5819 let update_msg = msgs::UpdateFulfillHTLC{
5822 payment_preimage: our_payment_preimage,
5825 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5827 assert!(nodes[0].node.list_channels().is_empty());
5828 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5829 assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
5833 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
5834 //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.
5836 let chanmon_cfgs = create_chanmon_cfgs(2);
5837 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5838 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5839 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5840 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5842 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5843 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5844 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5845 check_added_monitors!(nodes[0], 1);
5846 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5847 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5849 let update_msg = msgs::UpdateFailHTLC{
5852 reason: msgs::OnionErrorPacket { data: Vec::new()},
5855 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5857 assert!(nodes[0].node.list_channels().is_empty());
5858 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5859 assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
5863 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
5864 //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.
5866 let chanmon_cfgs = create_chanmon_cfgs(2);
5867 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5868 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5869 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5870 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5872 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5873 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5874 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5875 check_added_monitors!(nodes[0], 1);
5876 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5877 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5879 let update_msg = msgs::UpdateFailMalformedHTLC{
5882 sha256_of_onion: [1; 32],
5883 failure_code: 0x8000,
5886 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5888 assert!(nodes[0].node.list_channels().is_empty());
5889 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5890 assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
5894 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
5895 //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
5897 let chanmon_cfgs = create_chanmon_cfgs(2);
5898 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5899 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5900 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5901 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5903 let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
5905 nodes[1].node.claim_funds(our_payment_preimage, 100_000);
5906 check_added_monitors!(nodes[1], 1);
5908 let events = nodes[1].node.get_and_clear_pending_msg_events();
5909 assert_eq!(events.len(), 1);
5910 let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
5912 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, .. } } => {
5913 assert!(update_add_htlcs.is_empty());
5914 assert_eq!(update_fulfill_htlcs.len(), 1);
5915 assert!(update_fail_htlcs.is_empty());
5916 assert!(update_fail_malformed_htlcs.is_empty());
5917 assert!(update_fee.is_none());
5918 update_fulfill_htlcs[0].clone()
5920 _ => panic!("Unexpected event"),
5924 update_fulfill_msg.htlc_id = 1;
5926 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
5928 assert!(nodes[0].node.list_channels().is_empty());
5929 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5930 assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
5934 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
5935 //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.
5937 let chanmon_cfgs = create_chanmon_cfgs(2);
5938 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5939 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5940 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5941 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5943 let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
5945 nodes[1].node.claim_funds(our_payment_preimage, 100_000);
5946 check_added_monitors!(nodes[1], 1);
5948 let events = nodes[1].node.get_and_clear_pending_msg_events();
5949 assert_eq!(events.len(), 1);
5950 let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
5952 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, .. } } => {
5953 assert!(update_add_htlcs.is_empty());
5954 assert_eq!(update_fulfill_htlcs.len(), 1);
5955 assert!(update_fail_htlcs.is_empty());
5956 assert!(update_fail_malformed_htlcs.is_empty());
5957 assert!(update_fee.is_none());
5958 update_fulfill_htlcs[0].clone()
5960 _ => panic!("Unexpected event"),
5964 update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
5966 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
5968 assert!(nodes[0].node.list_channels().is_empty());
5969 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5970 assert_eq!(err_msg.data, "Remote tried to fulfill HTLC with an incorrect preimage");
5975 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
5976 //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.
5978 let chanmon_cfgs = create_chanmon_cfgs(2);
5979 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5980 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5981 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5982 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
5983 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5984 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5985 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5986 check_added_monitors!(nodes[0], 1);
5988 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5989 updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
5991 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5992 check_added_monitors!(nodes[1], 0);
5993 commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
5995 let events = nodes[1].node.get_and_clear_pending_msg_events();
5997 let mut update_msg: msgs::UpdateFailMalformedHTLC = {
5999 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, .. } } => {
6000 assert!(update_add_htlcs.is_empty());
6001 assert!(update_fulfill_htlcs.is_empty());
6002 assert!(update_fail_htlcs.is_empty());
6003 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6004 assert!(update_fee.is_none());
6005 update_fail_malformed_htlcs[0].clone()
6007 _ => panic!("Unexpected event"),
6010 update_msg.failure_code &= !0x8000;
6011 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6013 assert!(nodes[0].node.list_channels().is_empty());
6014 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6015 assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
6019 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
6020 //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
6021 // * 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.
6023 let chanmon_cfgs = create_chanmon_cfgs(3);
6024 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6025 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6026 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6027 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
6028 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
6030 let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
6031 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6034 let mut payment_event = {
6035 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
6036 check_added_monitors!(nodes[0], 1);
6037 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6038 assert_eq!(events.len(), 1);
6039 SendEvent::from_event(events.remove(0))
6041 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6042 check_added_monitors!(nodes[1], 0);
6043 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6044 expect_pending_htlcs_forwardable!(nodes[1]);
6045 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
6046 assert_eq!(events_2.len(), 1);
6047 check_added_monitors!(nodes[1], 1);
6048 payment_event = SendEvent::from_event(events_2.remove(0));
6049 assert_eq!(payment_event.msgs.len(), 1);
6052 payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6053 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
6054 check_added_monitors!(nodes[2], 0);
6055 commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
6057 let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
6058 assert_eq!(events_3.len(), 1);
6059 let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
6061 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 } } => {
6062 assert!(update_add_htlcs.is_empty());
6063 assert!(update_fulfill_htlcs.is_empty());
6064 assert!(update_fail_htlcs.is_empty());
6065 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6066 assert!(update_fee.is_none());
6067 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
6069 _ => panic!("Unexpected event"),
6073 nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
6075 check_added_monitors!(nodes[1], 0);
6076 commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
6077 expect_pending_htlcs_forwardable!(nodes[1]);
6078 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
6079 assert_eq!(events_4.len(), 1);
6081 //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
6083 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, .. } } => {
6084 assert!(update_add_htlcs.is_empty());
6085 assert!(update_fulfill_htlcs.is_empty());
6086 assert_eq!(update_fail_htlcs.len(), 1);
6087 assert!(update_fail_malformed_htlcs.is_empty());
6088 assert!(update_fee.is_none());
6090 _ => panic!("Unexpected event"),
6093 check_added_monitors!(nodes[1], 1);
6096 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
6097 // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
6098 // We can have at most two valid local commitment tx, so both cases must be covered, and both txs must be checked to get them all as
6099 // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
6101 let chanmon_cfgs = create_chanmon_cfgs(2);
6102 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6103 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6104 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6105 let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6107 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6109 // We route 2 dust-HTLCs between A and B
6110 let (_, payment_hash_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6111 let (_, payment_hash_2) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6112 route_payment(&nodes[0], &[&nodes[1]], 1000000);
6114 // Cache one local commitment tx as previous
6115 let as_prev_commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
6117 // Fail one HTLC to prune it in the will-be-latest-local commitment tx
6118 assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2));
6119 check_added_monitors!(nodes[1], 0);
6120 expect_pending_htlcs_forwardable!(nodes[1]);
6121 check_added_monitors!(nodes[1], 1);
6123 let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6124 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
6125 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
6126 check_added_monitors!(nodes[0], 1);
6128 // Cache one local commitment tx as lastest
6129 let as_last_commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
6131 let events = nodes[0].node.get_and_clear_pending_msg_events();
6133 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
6134 assert_eq!(node_id, nodes[1].node.get_our_node_id());
6136 _ => panic!("Unexpected event"),
6139 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
6140 assert_eq!(node_id, nodes[1].node.get_our_node_id());
6142 _ => panic!("Unexpected event"),
6145 assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
6146 // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
6147 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6149 if announce_latest {
6150 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_last_commitment_tx[0].clone()]}, 1);
6152 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_prev_commitment_tx[0].clone()]}, 1);
6155 let events = nodes[0].node.get_and_clear_pending_msg_events();
6156 assert_eq!(events.len(), 1);
6158 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
6159 _ => panic!("Unexpected event"),
6162 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6163 connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
6164 let events = nodes[0].node.get_and_clear_pending_events();
6165 // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
6166 assert_eq!(events.len(), 2);
6167 let mut first_failed = false;
6168 for event in events {
6170 Event::PaymentFailed { payment_hash, .. } => {
6171 if payment_hash == payment_hash_1 {
6172 assert!(!first_failed);
6173 first_failed = true;
6175 assert_eq!(payment_hash, payment_hash_2);
6178 _ => panic!("Unexpected event"),
6184 fn test_failure_delay_dust_htlc_local_commitment() {
6185 do_test_failure_delay_dust_htlc_local_commitment(true);
6186 do_test_failure_delay_dust_htlc_local_commitment(false);
6190 fn test_no_failure_dust_htlc_local_commitment() {
6191 // Transaction filters for failing back dust htlc based on local commitment txn infos has been
6192 // prone to error, we test here that a dummy transaction don't fail them.
6194 let chanmon_cfgs = create_chanmon_cfgs(2);
6195 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6196 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6197 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6198 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6201 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
6203 let as_dust_limit = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6204 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6206 // We route 2 dust-HTLCs between A and B
6207 let (preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6208 let (preimage_2, _) = route_payment(&nodes[1], &[&nodes[0]], as_dust_limit*1000);
6210 // Build a dummy invalid transaction trying to spend a commitment tx
6212 previous_output: BitcoinOutPoint { txid: chan.3.txid(), vout: 0 },
6213 script_sig: Script::new(),
6215 witness: Vec::new(),
6219 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
6223 let dummy_tx = Transaction {
6230 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6231 nodes[0].chan_monitor.simple_monitor.block_connected(&header, 1, &[&dummy_tx], &[1;1]);
6232 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6233 assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
6234 // We broadcast a few more block to check everything is all right
6235 connect_blocks(&nodes[0].block_notifier, 20, 1, true, header.bitcoin_hash());
6236 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6237 assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
6239 claim_payment(&nodes[0], &vec!(&nodes[1])[..], preimage_1, bs_dust_limit*1000);
6240 claim_payment(&nodes[1], &vec!(&nodes[0])[..], preimage_2, as_dust_limit*1000);
6243 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
6244 // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
6245 // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
6246 // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
6247 // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
6248 // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
6249 // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
6251 let chanmon_cfgs = create_chanmon_cfgs(3);
6252 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6253 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6254 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6255 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6257 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6259 let (_payment_preimage_1, dust_hash) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6260 let (_payment_preimage_2, non_dust_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
6262 let as_commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
6263 let bs_commitment_tx = nodes[1].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
6265 // We revoked bs_commitment_tx
6267 let (payment_preimage_3, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
6268 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 1_000_000);
6271 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6272 let mut timeout_tx = Vec::new();
6274 // We fail dust-HTLC 1 by broadcast of local commitment tx
6275 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_commitment_tx[0].clone()]}, 1);
6276 let events = nodes[0].node.get_and_clear_pending_msg_events();
6277 assert_eq!(events.len(), 1);
6279 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
6280 _ => panic!("Unexpected event"),
6282 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6283 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
6284 let parent_hash = connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
6285 let events = nodes[0].node.get_and_clear_pending_events();
6286 assert_eq!(events.len(), 1);
6288 Event::PaymentFailed { payment_hash, .. } => {
6289 assert_eq!(payment_hash, dust_hash);
6291 _ => panic!("Unexpected event"),
6293 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
6294 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
6295 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6296 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6297 nodes[0].block_notifier.block_connected(&Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
6298 let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6299 connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
6300 let events = nodes[0].node.get_and_clear_pending_events();
6301 assert_eq!(events.len(), 1);
6303 Event::PaymentFailed { payment_hash, .. } => {
6304 assert_eq!(payment_hash, non_dust_hash);
6306 _ => panic!("Unexpected event"),
6309 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
6310 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![bs_commitment_tx[0].clone()]}, 1);
6311 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6312 let events = nodes[0].node.get_and_clear_pending_msg_events();
6313 assert_eq!(events.len(), 1);
6315 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
6316 _ => panic!("Unexpected event"),
6318 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
6319 let parent_hash = connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
6320 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6322 let events = nodes[0].node.get_and_clear_pending_events();
6323 assert_eq!(events.len(), 1);
6325 Event::PaymentFailed { payment_hash, .. } => {
6326 assert_eq!(payment_hash, dust_hash);
6328 _ => panic!("Unexpected event"),
6330 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
6331 // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
6332 nodes[0].block_notifier.block_connected(&Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
6333 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6334 let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6335 connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
6336 let events = nodes[0].node.get_and_clear_pending_events();
6337 assert_eq!(events.len(), 1);
6339 Event::PaymentFailed { payment_hash, .. } => {
6340 assert_eq!(payment_hash, non_dust_hash);
6342 _ => panic!("Unexpected event"),
6345 // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
6347 let events = nodes[0].node.get_and_clear_pending_events();
6348 assert_eq!(events.len(), 2);
6351 Event::PaymentFailed { payment_hash, .. } => {
6352 if payment_hash == dust_hash { first = true; }
6353 else { first = false; }
6355 _ => panic!("Unexpected event"),
6358 Event::PaymentFailed { payment_hash, .. } => {
6359 if first { assert_eq!(payment_hash, non_dust_hash); }
6360 else { assert_eq!(payment_hash, dust_hash); }
6362 _ => panic!("Unexpected event"),
6369 fn test_sweep_outbound_htlc_failure_update() {
6370 do_test_sweep_outbound_htlc_failure_update(false, true);
6371 do_test_sweep_outbound_htlc_failure_update(false, false);
6372 do_test_sweep_outbound_htlc_failure_update(true, false);
6376 fn test_upfront_shutdown_script() {
6377 // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
6378 // enforce it at shutdown message
6380 let mut config = UserConfig::default();
6381 config.channel_options.announced_channel = true;
6382 config.peer_channel_config_limits.force_announced_channel_preference = false;
6383 config.channel_options.commit_upfront_shutdown_pubkey = false;
6384 let user_cfgs = [None, Some(config), None];
6385 let chanmon_cfgs = create_chanmon_cfgs(3);
6386 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6387 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
6388 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6390 // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
6391 let flags = InitFeatures::supported();
6392 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
6393 nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6394 let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
6395 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6396 // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that we disconnect peer
6397 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
6398 let events = nodes[2].node.get_and_clear_pending_msg_events();
6399 assert_eq!(events.len(), 2);
6401 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
6402 _ => panic!("Unexpected event"),
6404 if let MessageSendEvent::HandleError { ref action, .. } = events[1] {
6406 &ErrorAction::SendErrorMessage { ref msg } => {
6407 assert_eq!(msg.data,"Got shutdown request with a scriptpubkey which did not match their previous scriptpubkey");
6409 _ => { assert!(false); }
6411 } else { assert!(false); }
6413 // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
6414 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
6415 nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6416 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
6417 // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
6418 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
6419 let events = nodes[2].node.get_and_clear_pending_msg_events();
6420 assert_eq!(events.len(), 1);
6422 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
6423 _ => panic!("Unexpected event"),
6426 // We test that if case of peer non-signaling we don't enforce committed script at channel opening
6427 let mut flags_no = InitFeatures::supported();
6428 flags_no.unset_upfront_shutdown_script();
6429 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
6430 nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6431 let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
6432 node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6433 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_1_shutdown);
6434 let events = nodes[1].node.get_and_clear_pending_msg_events();
6435 assert_eq!(events.len(), 1);
6437 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
6438 _ => panic!("Unexpected event"),
6441 // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
6442 // channel smoothly, opt-out is from channel initiator here
6443 let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
6444 nodes[1].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6445 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
6446 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6447 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
6448 let events = nodes[0].node.get_and_clear_pending_msg_events();
6449 assert_eq!(events.len(), 1);
6451 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6452 _ => panic!("Unexpected event"),
6455 //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
6456 //// channel smoothly
6457 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
6458 nodes[1].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6459 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
6460 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6461 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
6462 let events = nodes[0].node.get_and_clear_pending_msg_events();
6463 assert_eq!(events.len(), 2);
6465 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6466 _ => panic!("Unexpected event"),
6469 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6470 _ => panic!("Unexpected event"),
6475 fn test_user_configurable_csv_delay() {
6476 // We test our channel constructors yield errors when we pass them absurd csv delay
6478 let mut low_our_to_self_config = UserConfig::default();
6479 low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
6480 let mut high_their_to_self_config = UserConfig::default();
6481 high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
6482 let user_cfgs = [Some(high_their_to_self_config.clone()), None];
6483 let chanmon_cfgs = create_chanmon_cfgs(2);
6484 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6485 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
6486 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6488 // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
6489 let keys_manager: Arc<KeysInterface<ChanKeySigner = EnforcingChannelKeys>> = Arc::new(test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
6490 if let Err(error) = Channel::new_outbound(&test_utils::TestFeeEstimator { sat_per_kw: 253 }, &keys_manager, nodes[1].node.get_our_node_id(), 1000000, 1000000, 0, Arc::new(test_utils::TestLogger::new()), &low_our_to_self_config) {
6492 APIError::APIMisuseError { err } => { assert_eq!(err, "Configured with an unreasonable our_to_self_delay putting user funds at risks"); },
6493 _ => panic!("Unexpected event"),
6495 } else { assert!(false) }
6497 // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
6498 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42).unwrap();
6499 let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
6500 open_channel.to_self_delay = 200;
6501 if let Err(error) = Channel::new_from_req(&test_utils::TestFeeEstimator { sat_per_kw: 253 }, &keys_manager, nodes[1].node.get_our_node_id(), InitFeatures::supported(), &open_channel, 0, Arc::new(test_utils::TestLogger::new()), &low_our_to_self_config) {
6503 ChannelError::Close(err) => { assert_eq!(err, "Configured with an unreasonable our_to_self_delay putting user funds at risks"); },
6504 _ => panic!("Unexpected event"),
6506 } else { assert!(false); }
6508 // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
6509 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42).unwrap();
6510 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::supported(), &get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id()));
6511 let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
6512 accept_channel.to_self_delay = 200;
6513 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::supported(), &accept_channel);
6514 if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
6516 &ErrorAction::SendErrorMessage { ref msg } => {
6517 assert_eq!(msg.data,"They wanted our payments to be delayed by a needlessly long period");
6519 _ => { assert!(false); }
6521 } else { assert!(false); }
6523 // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
6524 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42).unwrap();
6525 let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
6526 open_channel.to_self_delay = 200;
6527 if let Err(error) = Channel::new_from_req(&test_utils::TestFeeEstimator { sat_per_kw: 253 }, &keys_manager, nodes[1].node.get_our_node_id(), InitFeatures::supported(), &open_channel, 0, Arc::new(test_utils::TestLogger::new()), &high_their_to_self_config) {
6529 ChannelError::Close(err) => { assert_eq!(err, "They wanted our payments to be delayed by a needlessly long period"); },
6530 _ => panic!("Unexpected event"),
6532 } else { assert!(false); }
6536 fn test_data_loss_protect() {
6537 // We want to be sure that :
6538 // * we don't broadcast our Local Commitment Tx in case of fallen behind
6539 // * we close channel in case of detecting other being fallen behind
6540 // * we are able to claim our own outputs thanks to remote my_current_per_commitment_point
6545 let chanmon_cfgs = create_chanmon_cfgs(2);
6546 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6547 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6548 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6550 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
6552 // Cache node A state before any channel update
6553 let previous_node_state = nodes[0].node.encode();
6554 let mut previous_chan_monitor_state = test_utils::TestVecWriter(Vec::new());
6555 nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut previous_chan_monitor_state).unwrap();
6557 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
6558 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
6560 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6561 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6563 // Restore node A from previous state
6564 let logger: Arc<Logger> = Arc::new(test_utils::TestLogger::with_id(format!("node {}", 0)));
6565 let mut chan_monitor = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut ::std::io::Cursor::new(previous_chan_monitor_state.0), Arc::clone(&logger)).unwrap().1;
6566 let chain_monitor = Arc::new(ChainWatchInterfaceUtil::new(Network::Testnet, Arc::clone(&logger)));
6567 tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), broadcasted_txn: Mutex::new(HashSet::new())};
6568 let feeest = Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 });
6569 keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::clone(&logger));
6570 monitor = test_utils::TestChannelMonitor::new(chain_monitor.clone(), &tx_broadcaster, logger.clone(), feeest.clone());
6572 let mut channel_monitors = HashMap::new();
6573 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chan_monitor);
6574 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface>)>::read(&mut ::std::io::Cursor::new(previous_node_state), ChannelManagerReadArgs {
6575 keys_manager: &keys_manager,
6576 fee_estimator: feeest.clone(),
6578 logger: Arc::clone(&logger),
6579 tx_broadcaster: &tx_broadcaster,
6580 default_config: UserConfig::default(),
6581 channel_monitors: &mut channel_monitors,
6584 nodes[0].node = &node_state_0;
6585 assert!(monitor.add_monitor(OutPoint { txid: chan.3.txid(), index: 0 }, chan_monitor).is_ok());
6586 nodes[0].chan_monitor = &monitor;
6587 nodes[0].chain_monitor = chain_monitor;
6589 nodes[0].block_notifier = BlockNotifier::new(nodes[0].chain_monitor.clone());
6590 nodes[0].block_notifier.register_listener(&nodes[0].chan_monitor.simple_monitor);
6591 nodes[0].block_notifier.register_listener(nodes[0].node);
6593 check_added_monitors!(nodes[0], 1);
6595 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6596 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6598 let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6600 // Check we update monitor following learning of per_commitment_point from B
6601 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
6602 check_added_monitors!(nodes[0], 1);
6605 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
6606 assert_eq!(node_txn.len(), 0);
6609 let mut reestablish_1 = Vec::with_capacity(1);
6610 for msg in nodes[0].node.get_and_clear_pending_msg_events() {
6611 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
6612 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
6613 reestablish_1.push(msg.clone());
6614 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
6615 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
6617 &ErrorAction::SendErrorMessage { ref msg } => {
6618 assert_eq!(msg.data, "We have fallen behind - we have received proof that if we broadcast remote is going to claim our funds - we can't do any automated broadcasting");
6620 _ => panic!("Unexpected event!"),
6623 panic!("Unexpected event")
6627 // Check we close channel detecting A is fallen-behind
6628 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6629 let events = nodes[1].node.get_and_clear_pending_msg_events();
6630 assert_eq!(events.len(), 2);
6632 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
6633 _ => panic!("Unexpected event"),
6636 MessageSendEvent::HandleError { ref action, .. } => {
6638 &ErrorAction::SendErrorMessage { ref msg } => {
6639 assert_eq!(msg.data, "Peer attempted to reestablish channel with a very old local commitment transaction"); },
6640 _ => panic!("Unexpected event!"),
6643 _ => panic!("Unexpected event"),
6646 // Check A is able to claim to_remote output
6647 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
6648 assert_eq!(node_txn.len(), 1);
6649 check_spends!(node_txn[0], chan.3.clone());
6650 assert_eq!(node_txn[0].output.len(), 2);
6651 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
6652 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()]}, 1);
6653 let spend_txn = check_spendable_outputs!(nodes[0], 1);
6654 assert_eq!(spend_txn.len(), 1);
6655 check_spends!(spend_txn[0], node_txn[0].clone());
6659 fn test_check_htlc_underpaying() {
6660 // Send payment through A -> B but A is maliciously
6661 // sending a probe payment (i.e less than expected value0
6662 // to B, B should refuse payment.
6664 let chanmon_cfgs = create_chanmon_cfgs(2);
6665 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6666 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6667 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6669 // Create some initial channels
6670 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6672 let (payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 10_000);
6674 // Node 3 is expecting payment of 100_000 but receive 10_000,
6675 // fail htlc like we didn't know the preimage.
6676 nodes[1].node.claim_funds(payment_preimage, 100_000);
6677 nodes[1].node.process_pending_htlc_forwards();
6679 let events = nodes[1].node.get_and_clear_pending_msg_events();
6680 assert_eq!(events.len(), 1);
6681 let (update_fail_htlc, commitment_signed) = match events[0] {
6682 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 } } => {
6683 assert!(update_add_htlcs.is_empty());
6684 assert!(update_fulfill_htlcs.is_empty());
6685 assert_eq!(update_fail_htlcs.len(), 1);
6686 assert!(update_fail_malformed_htlcs.is_empty());
6687 assert!(update_fee.is_none());
6688 (update_fail_htlcs[0].clone(), commitment_signed)
6690 _ => panic!("Unexpected event"),
6692 check_added_monitors!(nodes[1], 1);
6694 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
6695 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
6697 let events = nodes[0].node.get_and_clear_pending_events();
6698 assert_eq!(events.len(), 1);
6699 if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code } = &events[0] {
6700 assert_eq!(*rejected_by_dest, true);
6701 assert_eq!(error_code.unwrap(), 0x4000|15);
6703 panic!("Unexpected event");
6705 nodes[1].node.get_and_clear_pending_events();
6709 fn test_announce_disable_channels() {
6710 // Create 2 channels between A and B. Disconnect B. Call timer_chan_freshness_every_min and check for generated
6711 // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
6713 let chanmon_cfgs = create_chanmon_cfgs(2);
6714 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6715 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6716 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6718 let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
6719 let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
6720 let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
6723 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6724 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6726 nodes[0].node.timer_chan_freshness_every_min(); // dirty -> stagged
6727 nodes[0].node.timer_chan_freshness_every_min(); // staged -> fresh
6728 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
6729 assert_eq!(msg_events.len(), 3);
6730 for e in msg_events {
6732 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
6733 let short_id = msg.contents.short_channel_id;
6734 // Check generated channel_update match list in PendingChannelUpdate
6735 if short_id != short_id_1 && short_id != short_id_2 && short_id != short_id_3 {
6736 panic!("Generated ChannelUpdate for wrong chan!");
6739 _ => panic!("Unexpected event"),
6743 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6744 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6745 assert_eq!(reestablish_1.len(), 3);
6746 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6747 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6748 assert_eq!(reestablish_2.len(), 3);
6750 // Reestablish chan_1
6751 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6752 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6753 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6754 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6755 // Reestablish chan_2
6756 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
6757 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6758 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
6759 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6760 // Reestablish chan_3
6761 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
6762 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6763 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
6764 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6766 nodes[0].node.timer_chan_freshness_every_min();
6767 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6771 fn test_bump_penalty_txn_on_revoked_commitment() {
6772 // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
6773 // we're able to claim outputs on revoked commitment transaction before timelocks expiration
6775 let chanmon_cfgs = create_chanmon_cfgs(2);
6776 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6777 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6778 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6780 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
6781 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
6782 let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 3000000, 30).unwrap();
6783 send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
6785 let revoked_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
6786 // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
6787 assert_eq!(revoked_txn[0].output.len(), 4);
6788 assert_eq!(revoked_txn[0].input.len(), 1);
6789 assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
6790 let revoked_txid = revoked_txn[0].txid();
6792 let mut penalty_sum = 0;
6793 for outp in revoked_txn[0].output.iter() {
6794 if outp.script_pubkey.is_v0_p2wsh() {
6795 penalty_sum += outp.value;
6799 // Connect blocks to change height_timer range to see if we use right soonest_timelock
6800 let header_114 = connect_blocks(&nodes[1].block_notifier, 114, 0, false, Default::default());
6802 // Actually revoke tx by claiming a HTLC
6803 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
6804 let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6805 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_txn[0].clone()] }, 115);
6807 // One or more justice tx should have been broadcast, check it
6811 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6812 assert_eq!(node_txn.len(), 3); // justice tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout (broadcasted from ChannelManager)
6813 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
6814 assert_eq!(node_txn[0].output.len(), 1);
6815 check_spends!(node_txn[0], revoked_txn[0].clone());
6816 let fee_1 = penalty_sum - node_txn[0].output[0].value;
6817 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
6818 penalty_1 = node_txn[0].txid();
6822 // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
6823 let header = connect_blocks(&nodes[1].block_notifier, 3, 115, true, header.bitcoin_hash());
6824 let mut penalty_2 = penalty_1;
6825 let mut feerate_2 = 0;
6827 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6828 assert_eq!(node_txn.len(), 1);
6829 if node_txn[0].input[0].previous_output.txid == revoked_txid {
6830 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
6831 assert_eq!(node_txn[0].output.len(), 1);
6832 check_spends!(node_txn[0], revoked_txn[0].clone());
6833 penalty_2 = node_txn[0].txid();
6834 // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
6835 assert_ne!(penalty_2, penalty_1);
6836 let fee_2 = penalty_sum - node_txn[0].output[0].value;
6837 feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
6838 // Verify 25% bump heuristic
6839 assert!(feerate_2 * 100 >= feerate_1 * 125);
6843 assert_ne!(feerate_2, 0);
6845 // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
6846 connect_blocks(&nodes[1].block_notifier, 3, 118, true, header);
6848 let mut feerate_3 = 0;
6850 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6851 assert_eq!(node_txn.len(), 1);
6852 if node_txn[0].input[0].previous_output.txid == revoked_txid {
6853 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
6854 assert_eq!(node_txn[0].output.len(), 1);
6855 check_spends!(node_txn[0], revoked_txn[0].clone());
6856 penalty_3 = node_txn[0].txid();
6857 // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
6858 assert_ne!(penalty_3, penalty_2);
6859 let fee_3 = penalty_sum - node_txn[0].output[0].value;
6860 feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
6861 // Verify 25% bump heuristic
6862 assert!(feerate_3 * 100 >= feerate_2 * 125);
6866 assert_ne!(feerate_3, 0);
6868 nodes[1].node.get_and_clear_pending_events();
6869 nodes[1].node.get_and_clear_pending_msg_events();
6873 fn test_bump_penalty_txn_on_revoked_htlcs() {
6874 // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
6875 // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
6877 let chanmon_cfgs = create_chanmon_cfgs(2);
6878 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6879 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6880 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6882 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
6883 // Lock HTLC in both directions
6884 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3_000_000).0;
6885 route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
6887 let revoked_local_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
6888 assert_eq!(revoked_local_txn[0].input.len(), 1);
6889 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
6891 // Revoke local commitment tx
6892 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
6894 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6895 // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
6896 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
6897 check_closed_broadcast!(nodes[1], false);
6899 let mut received = ::std::usize::MAX;
6900 let mut offered = ::std::usize::MAX;
6901 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6902 assert_eq!(revoked_htlc_txn.len(), 6);
6903 if revoked_htlc_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
6904 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
6905 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
6906 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
6907 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
6908 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0].clone());
6911 } else if revoked_htlc_txn[1].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
6912 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
6913 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0].clone());
6914 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
6915 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
6916 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
6921 // Broadcast set of revoked txn on A
6922 let header_128 = connect_blocks(&nodes[0].block_notifier, 128, 0, true, header.bitcoin_hash());
6923 let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6924 nodes[0].block_notifier.block_connected(&Block { header: header_129, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone(), revoked_htlc_txn[1].clone()] }, 129);
6930 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6931 assert_eq!(node_txn.len(), 6); // 3 penalty txn on revoked commitment tx + A commitment tx + 2 penalty tnx on revoked HTLC txn
6932 // Verify claim tx are spending revoked HTLC txn
6933 assert_eq!(node_txn[4].input.len(), 1);
6934 assert_eq!(node_txn[4].output.len(), 1);
6935 check_spends!(node_txn[4], revoked_htlc_txn[0].clone());
6936 first = node_txn[4].txid();
6937 assert_eq!(node_txn[5].input.len(), 1);
6938 assert_eq!(node_txn[5].output.len(), 1);
6939 check_spends!(node_txn[5], revoked_htlc_txn[1].clone());
6940 second = node_txn[5].txid();
6941 // Store both feerates for later comparison
6942 let fee_1 = revoked_htlc_txn[0].output[0].value - node_txn[4].output[0].value;
6943 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
6944 let fee_2 = revoked_htlc_txn[1].output[0].value - node_txn[5].output[0].value;
6945 feerate_2 = fee_2 * 1000 / node_txn[5].get_weight() as u64;
6949 // Connect three more block to see if bumped penalty are issued for HTLC txn
6950 let header_132 = connect_blocks(&nodes[0].block_notifier, 3, 129, true, header_129.bitcoin_hash());
6951 let penalty_local_tx;
6953 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6954 assert_eq!(node_txn.len(), 3); // 2 bumped penalty txn on offered/received HTLC outputs of revoked commitment tx + 1 penalty tx on to_local of revoked commitment tx + 2 bumped penalty tx on revoked HTLC txn
6956 check_spends!(node_txn[0], revoked_local_txn[0].clone());
6957 check_spends!(node_txn[1], revoked_local_txn[0].clone());
6959 check_spends!(node_txn[2], revoked_local_txn[0].clone());
6961 penalty_local_tx = node_txn[2].clone();
6964 // Few more blocks to broadcast and confirm penalty_local_tx
6965 let header_133 = BlockHeader { version: 0x20000000, prev_blockhash: header_132, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6966 nodes[0].block_notifier.block_connected(&Block { header: header_133, txdata: vec![penalty_local_tx] }, 133);
6967 let header_135 = connect_blocks(&nodes[0].block_notifier, 2, 133, true, header_133.bitcoin_hash());
6969 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6970 assert_eq!(node_txn.len(), 1);
6971 check_spends!(node_txn[0], revoked_local_txn[0].clone());
6974 let header_144 = connect_blocks(&nodes[0].block_notifier, 9, 135, true, header_135);
6976 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6977 assert_eq!(node_txn.len(), 2);
6979 let mut penalty_offered = ::std::usize::MAX;
6980 let mut penalty_received = ::std::usize::MAX;
6983 for (i, tx) in node_txn.iter().enumerate() {
6984 if tx.input[0].previous_output.txid == revoked_htlc_txn[offered].txid() {
6985 penalty_offered = i;
6986 } else if tx.input[0].previous_output.txid == revoked_htlc_txn[received].txid() {
6987 penalty_received = i;
6992 assert_eq!(node_txn[penalty_received].input.len(), 1);
6993 assert_eq!(node_txn[penalty_received].output.len(), 1);
6994 assert_eq!(node_txn[penalty_offered].input.len(), 1);
6995 assert_eq!(node_txn[penalty_offered].output.len(), 1);
6996 // Verify bumped tx is different and 25% bump heuristic
6997 check_spends!(node_txn[penalty_offered], revoked_htlc_txn[offered].clone());
6998 assert_ne!(first, node_txn[penalty_offered].txid());
6999 let fee = revoked_htlc_txn[offered].output[0].value - node_txn[penalty_offered].output[0].value;
7000 let new_feerate = fee * 1000 / node_txn[penalty_offered].get_weight() as u64;
7001 assert!(new_feerate * 100 > feerate_1 * 125);
7003 check_spends!(node_txn[penalty_received], revoked_htlc_txn[received].clone());
7004 assert_ne!(second, node_txn[penalty_received].txid());
7005 let fee = revoked_htlc_txn[received].output[0].value - node_txn[penalty_received].output[0].value;
7006 let new_feerate = fee * 1000 / node_txn[penalty_received].get_weight() as u64;
7007 assert!(new_feerate * 100 > feerate_2 * 125);
7008 let txn = vec![node_txn[0].clone(), node_txn[1].clone()];
7012 // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
7013 let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7014 nodes[0].block_notifier.block_connected(&Block { header: header_145, txdata: node_txn }, 145);
7015 connect_blocks(&nodes[0].block_notifier, 20, 145, true, header_145.bitcoin_hash());
7017 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7018 assert_eq!(node_txn.len(), 2); //TODO: fix check_spend_remote_htlc lack of watch output
7021 check_closed_broadcast!(nodes[0], false);
7025 fn test_bump_penalty_txn_on_remote_commitment() {
7026 // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
7027 // we're able to claim outputs on remote commitment transaction before timelocks expiration
7030 // Provide preimage for one
7031 // Check aggregation
7033 let chanmon_cfgs = create_chanmon_cfgs(2);
7034 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7035 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7036 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7038 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
7039 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7040 route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
7042 // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7043 let remote_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
7044 assert_eq!(remote_txn[0].output.len(), 4);
7045 assert_eq!(remote_txn[0].input.len(), 1);
7046 assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
7048 // Claim a HTLC without revocation (provide B monitor with preimage)
7049 nodes[1].node.claim_funds(payment_preimage, 3_000_000);
7050 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7051 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
7052 check_added_monitors!(nodes[1], 1);
7054 // One or more claim tx should have been broadcast, check it
7057 let feerate_timeout;
7058 let feerate_preimage;
7060 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7061 assert_eq!(node_txn.len(), 5); // 2 * claim tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout + local HTLC-success (broadcasted from ChannelManager)
7062 assert_eq!(node_txn[0].input.len(), 1);
7063 assert_eq!(node_txn[1].input.len(), 1);
7064 check_spends!(node_txn[0], remote_txn[0].clone());
7065 check_spends!(node_txn[1], remote_txn[0].clone());
7066 check_spends!(node_txn[2], chan.3);
7067 check_spends!(node_txn[3], node_txn[2]);
7068 check_spends!(node_txn[4], node_txn[2]);
7069 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7070 timeout = node_txn[0].txid();
7071 let index = node_txn[0].input[0].previous_output.vout;
7072 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7073 feerate_timeout = fee * 1000 / node_txn[0].get_weight() as u64;
7075 preimage = node_txn[1].txid();
7076 let index = node_txn[1].input[0].previous_output.vout;
7077 let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7078 feerate_preimage = fee * 1000 / node_txn[1].get_weight() as u64;
7080 timeout = node_txn[1].txid();
7081 let index = node_txn[1].input[0].previous_output.vout;
7082 let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7083 feerate_timeout = fee * 1000 / node_txn[1].get_weight() as u64;
7085 preimage = node_txn[0].txid();
7086 let index = node_txn[0].input[0].previous_output.vout;
7087 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7088 feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
7092 assert_ne!(feerate_timeout, 0);
7093 assert_ne!(feerate_preimage, 0);
7095 // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
7096 connect_blocks(&nodes[1].block_notifier, 15, 1, true, header.bitcoin_hash());
7098 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7099 assert_eq!(node_txn.len(), 2);
7100 assert_eq!(node_txn[0].input.len(), 1);
7101 assert_eq!(node_txn[1].input.len(), 1);
7102 check_spends!(node_txn[0], remote_txn[0].clone());
7103 check_spends!(node_txn[1], remote_txn[0].clone());
7104 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7105 let index = node_txn[0].input[0].previous_output.vout;
7106 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7107 let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
7108 assert!(new_feerate * 100 > feerate_timeout * 125);
7109 assert_ne!(timeout, node_txn[0].txid());
7111 let index = node_txn[1].input[0].previous_output.vout;
7112 let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7113 let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
7114 assert!(new_feerate * 100 > feerate_preimage * 125);
7115 assert_ne!(preimage, node_txn[1].txid());
7117 let index = node_txn[1].input[0].previous_output.vout;
7118 let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7119 let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
7120 assert!(new_feerate * 100 > feerate_timeout * 125);
7121 assert_ne!(timeout, node_txn[1].txid());
7123 let index = node_txn[0].input[0].previous_output.vout;
7124 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7125 let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
7126 assert!(new_feerate * 100 > feerate_preimage * 125);
7127 assert_ne!(preimage, node_txn[0].txid());
7132 nodes[1].node.get_and_clear_pending_events();
7133 nodes[1].node.get_and_clear_pending_msg_events();
7137 fn test_set_outpoints_partial_claiming() {
7138 // - remote party claim tx, new bump tx
7139 // - disconnect remote claiming tx, new bump
7140 // - disconnect tx, see no tx anymore
7141 let chanmon_cfgs = create_chanmon_cfgs(2);
7142 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7143 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7144 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7146 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
7147 let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7148 let payment_preimage_2 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7150 // Remote commitment txn with 4 outputs: to_local, to_remote, 2 outgoing HTLC
7151 let remote_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
7152 assert_eq!(remote_txn.len(), 3);
7153 assert_eq!(remote_txn[0].output.len(), 4);
7154 assert_eq!(remote_txn[0].input.len(), 1);
7155 assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
7156 check_spends!(remote_txn[1], remote_txn[0].clone());
7157 check_spends!(remote_txn[2], remote_txn[0].clone());
7159 // Connect blocks on node A to advance height towards TEST_FINAL_CLTV
7160 let prev_header_100 = connect_blocks(&nodes[1].block_notifier, 100, 0, false, Default::default());
7161 // Provide node A with both preimage
7162 nodes[0].node.claim_funds(payment_preimage_1, 3_000_000);
7163 nodes[0].node.claim_funds(payment_preimage_2, 3_000_000);
7164 check_added_monitors!(nodes[0], 2);
7165 nodes[0].node.get_and_clear_pending_events();
7166 nodes[0].node.get_and_clear_pending_msg_events();
7168 // Connect blocks on node A commitment transaction
7169 let header = BlockHeader { version: 0x20000000, prev_blockhash: prev_header_100, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7170 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 101);
7171 // Verify node A broadcast tx claiming both HTLCs
7173 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7174 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-Success*2
7175 assert_eq!(node_txn.len(), 4);
7176 check_spends!(node_txn[0], remote_txn[0].clone());
7177 check_spends!(node_txn[1], chan.3.clone());
7178 check_spends!(node_txn[2], node_txn[1]);
7179 check_spends!(node_txn[3], node_txn[1]);
7180 assert_eq!(node_txn[0].input.len(), 2);
7183 nodes[0].node.get_and_clear_pending_msg_events();
7185 // Connect blocks on node B
7186 connect_blocks(&nodes[1].block_notifier, 135, 0, false, Default::default());
7187 // Verify node B broadcast 2 HTLC-timeout txn
7188 let partial_claim_tx = {
7189 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7190 assert_eq!(node_txn.len(), 3);
7191 check_spends!(node_txn[1], node_txn[0].clone());
7192 check_spends!(node_txn[2], node_txn[0].clone());
7193 assert_eq!(node_txn[1].input.len(), 1);
7194 assert_eq!(node_txn[2].input.len(), 1);
7197 nodes[1].node.get_and_clear_pending_msg_events();
7199 // Broadcast partial claim on node A, should regenerate a claiming tx with HTLC dropped
7200 let header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7201 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![partial_claim_tx.clone()] }, 102);
7203 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7204 assert_eq!(node_txn.len(), 1);
7205 check_spends!(node_txn[0], remote_txn[0].clone());
7206 assert_eq!(node_txn[0].input.len(), 1); //dropped HTLC
7209 nodes[0].node.get_and_clear_pending_msg_events();
7211 // Disconnect last block on node A, should regenerate a claiming tx with HTLC dropped
7212 nodes[0].block_notifier.block_disconnected(&header, 102);
7214 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7215 assert_eq!(node_txn.len(), 1);
7216 check_spends!(node_txn[0], remote_txn[0].clone());
7217 assert_eq!(node_txn[0].input.len(), 2); //resurrected HTLC
7221 //// Disconnect one more block and then reconnect multiple no transaction should be generated
7222 nodes[0].block_notifier.block_disconnected(&header, 101);
7223 connect_blocks(&nodes[1].block_notifier, 15, 101, false, prev_header_100);
7225 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7226 assert_eq!(node_txn.len(), 0);
7232 fn test_counterparty_raa_skip_no_crash() {
7233 // Previously, if our counterparty sent two RAAs in a row without us having provided a
7234 // commitment transaction, we would have happily carried on and provided them the next
7235 // commitment transaction based on one RAA forward. This would probably eventually have led to
7236 // channel closure, but it would not have resulted in funds loss. Still, our
7237 // EnforcingChannelKeys would have paniced as it doesn't like jumps into the future. Here, we
7238 // check simply that the channel is closed in response to such an RAA, but don't check whether
7239 // we decide to punish our counterparty for revoking their funds (as we don't currently
7241 let chanmon_cfgs = create_chanmon_cfgs(2);
7242 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7243 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7244 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7245 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).2;
7247 let commitment_seed = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&channel_id).unwrap().local_keys.commitment_seed().clone();
7248 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
7249 let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
7250 &SecretKey::from_slice(&chan_utils::build_commitment_secret(&commitment_seed, INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
7251 let per_commitment_secret = chan_utils::build_commitment_secret(&commitment_seed, INITIAL_COMMITMENT_NUMBER);
7253 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
7254 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
7255 assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
7259 fn test_bump_txn_sanitize_tracking_maps() {
7260 // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
7261 // verify we clean then right after expiration of ANTI_REORG_DELAY.
7263 let chanmon_cfgs = create_chanmon_cfgs(2);
7264 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7265 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7266 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7268 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
7269 // Lock HTLC in both directions
7270 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
7271 route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
7273 let revoked_local_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
7274 assert_eq!(revoked_local_txn[0].input.len(), 1);
7275 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7277 // Revoke local commitment tx
7278 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 9_000_000);
7280 // Broadcast set of revoked txn on A
7281 let header_128 = connect_blocks(&nodes[0].block_notifier, 128, 0, false, Default::default());
7282 let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7283 nodes[0].block_notifier.block_connected(&Block { header: header_129, txdata: vec![revoked_local_txn[0].clone()] }, 129);
7284 check_closed_broadcast!(nodes[0], false);
7286 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7287 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
7288 check_spends!(node_txn[0], revoked_local_txn[0].clone());
7289 check_spends!(node_txn[1], revoked_local_txn[0].clone());
7290 check_spends!(node_txn[2], revoked_local_txn[0].clone());
7291 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
7295 let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7296 nodes[0].block_notifier.block_connected(&Block { header: header_130, txdata: penalty_txn }, 130);
7297 connect_blocks(&nodes[0].block_notifier, 5, 130, false, header_130.bitcoin_hash());
7299 let monitors = nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap();
7300 if let Some(monitor) = monitors.get(&OutPoint::new(chan.3.txid(), 0)) {
7301 assert!(monitor.pending_claim_requests.is_empty());
7302 assert!(monitor.claimable_outpoints.is_empty());