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, None).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, None).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]);
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]);
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]);
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 // Verify broadcast of revoked HTLC-timeout
2131 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2132 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2133 // Broadcast revoked HTLC-timeout on node 1
2134 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2135 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2137 get_announce_close_broadcast_events(&nodes, 0, 1);
2139 assert_eq!(nodes[0].node.list_channels().len(), 0);
2140 assert_eq!(nodes[1].node.list_channels().len(), 0);
2142 // We test justice_tx build by A on B's revoked HTLC-Success tx
2143 // Create some new channels:
2144 let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2146 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2150 // A pending HTLC which will be revoked:
2151 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2152 // Get the will-be-revoked local txn from B
2153 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();
2154 assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2155 assert_eq!(revoked_local_txn[0].input.len(), 1);
2156 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2157 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2158 // Revoke the old state
2159 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4, 3_000_000);
2161 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2162 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2164 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2165 assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2166 assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2168 check_spends!(node_txn[0], revoked_local_txn[0]);
2169 node_txn.swap_remove(0);
2171 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2173 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2174 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2175 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2176 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2177 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2179 get_announce_close_broadcast_events(&nodes, 0, 1);
2180 assert_eq!(nodes[0].node.list_channels().len(), 0);
2181 assert_eq!(nodes[1].node.list_channels().len(), 0);
2185 fn revoked_output_claim() {
2186 // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2187 // transaction is broadcast by its counterparty
2188 let chanmon_cfgs = create_chanmon_cfgs(2);
2189 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2190 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2191 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2192 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2193 // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2194 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();
2195 assert_eq!(revoked_local_txn.len(), 1);
2196 // Only output is the full channel value back to nodes[0]:
2197 assert_eq!(revoked_local_txn[0].output.len(), 1);
2198 // Send a payment through, updating everyone's latest commitment txn
2199 send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000, 5_000_000);
2201 // Inform nodes[1] that nodes[0] broadcast a stale tx
2202 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2203 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2204 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2205 assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2207 check_spends!(node_txn[0], revoked_local_txn[0]);
2208 check_spends!(node_txn[1], chan_1.3);
2210 // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2211 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2212 get_announce_close_broadcast_events(&nodes, 0, 1);
2216 fn claim_htlc_outputs_shared_tx() {
2217 // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2218 let chanmon_cfgs = create_chanmon_cfgs(2);
2219 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2220 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2221 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2223 // Create some new channel:
2224 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2226 // Rebalance the network to generate htlc in the two directions
2227 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2228 // 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
2229 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2230 let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2232 // Get the will-be-revoked local txn from node[0]
2233 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();
2234 assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2235 assert_eq!(revoked_local_txn[0].input.len(), 1);
2236 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2237 assert_eq!(revoked_local_txn[1].input.len(), 1);
2238 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2239 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2240 check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2242 //Revoke the old state
2243 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2246 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2247 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2248 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2249 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2251 let events = nodes[1].node.get_and_clear_pending_events();
2252 assert_eq!(events.len(), 1);
2254 Event::PaymentFailed { payment_hash, .. } => {
2255 assert_eq!(payment_hash, payment_hash_2);
2257 _ => panic!("Unexpected event"),
2260 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2261 assert_eq!(node_txn.len(), 3); // ChannelMonitor: penalty tx, ChannelManager: local commitment + HTLC-timeout
2263 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2264 check_spends!(node_txn[0], revoked_local_txn[0]);
2266 let mut witness_lens = BTreeSet::new();
2267 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2268 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2269 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2270 assert_eq!(witness_lens.len(), 3);
2271 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2272 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2273 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2275 // Next nodes[1] broadcasts its current local tx state:
2276 assert_eq!(node_txn[1].input.len(), 1);
2277 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2279 assert_eq!(node_txn[2].input.len(), 1);
2280 let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
2281 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2282 assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
2283 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2284 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
2286 get_announce_close_broadcast_events(&nodes, 0, 1);
2287 assert_eq!(nodes[0].node.list_channels().len(), 0);
2288 assert_eq!(nodes[1].node.list_channels().len(), 0);
2292 fn claim_htlc_outputs_single_tx() {
2293 // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2294 let chanmon_cfgs = create_chanmon_cfgs(2);
2295 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2296 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2297 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2299 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2301 // Rebalance the network to generate htlc in the two directions
2302 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2303 // 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
2304 // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2305 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2306 let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2308 // Get the will-be-revoked local txn from node[0]
2309 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();
2311 //Revoke the old state
2312 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2315 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2316 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2317 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2318 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
2320 let events = nodes[1].node.get_and_clear_pending_events();
2321 assert_eq!(events.len(), 1);
2323 Event::PaymentFailed { payment_hash, .. } => {
2324 assert_eq!(payment_hash, payment_hash_2);
2326 _ => panic!("Unexpected event"),
2329 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2330 assert_eq!(node_txn.len(), 21);
2331 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2332 // ChannelManager: local commmitment + local HTLC-timeout (2)
2333 // ChannelMonitor: bumped justice tx (4), after one increase, bumps on HTLC aren't generated not being substantial anymore
2334 // ChannelMonito r: local commitment + local HTLC-timeout (14)
2336 assert_eq!(node_txn[0], node_txn[5]);
2337 assert_eq!(node_txn[0], node_txn[7]);
2338 assert_eq!(node_txn[0], node_txn[9]);
2339 assert_eq!(node_txn[0], node_txn[13]);
2340 assert_eq!(node_txn[0], node_txn[15]);
2341 assert_eq!(node_txn[0], node_txn[17]);
2342 assert_eq!(node_txn[0], node_txn[19]);
2344 assert_eq!(node_txn[1], node_txn[6]);
2345 assert_eq!(node_txn[1], node_txn[8]);
2346 assert_eq!(node_txn[1], node_txn[10]);
2347 assert_eq!(node_txn[1], node_txn[14]);
2348 assert_eq!(node_txn[1], node_txn[16]);
2349 assert_eq!(node_txn[1], node_txn[18]);
2350 assert_eq!(node_txn[1], node_txn[20]);
2353 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration and present 8 times (rebroadcast at every block from 200 to 206)
2354 assert_eq!(node_txn[0].input.len(), 1);
2355 check_spends!(node_txn[0], chan_1.3);
2356 assert_eq!(node_txn[1].input.len(), 1);
2357 let witness_script = node_txn[1].input[0].witness.last().unwrap();
2358 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2359 check_spends!(node_txn[1], node_txn[0]);
2361 // Justice transactions are indices 2-3-4
2362 assert_eq!(node_txn[2].input.len(), 1);
2363 assert_eq!(node_txn[3].input.len(), 1);
2364 assert_eq!(node_txn[4].input.len(), 1);
2365 check_spends!(node_txn[2], revoked_local_txn[0]);
2366 check_spends!(node_txn[3], revoked_local_txn[0]);
2367 check_spends!(node_txn[4], revoked_local_txn[0]);
2369 let mut witness_lens = BTreeSet::new();
2370 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2371 witness_lens.insert(node_txn[3].input[0].witness.last().unwrap().len());
2372 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2373 assert_eq!(witness_lens.len(), 3);
2374 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2375 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2376 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2378 get_announce_close_broadcast_events(&nodes, 0, 1);
2379 assert_eq!(nodes[0].node.list_channels().len(), 0);
2380 assert_eq!(nodes[1].node.list_channels().len(), 0);
2384 fn test_htlc_on_chain_success() {
2385 // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2386 // ChainWatchInterface and pass the preimage backward accordingly. So here we test that ChannelManager is
2387 // broadcasting the right event to other nodes in payment path.
2388 // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2389 // A --------------------> B ----------------------> C (preimage)
2390 // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2391 // commitment transaction was broadcast.
2392 // Then, B should learn the preimage from said transactions, attempting to claim backwards
2394 // B should be able to claim via preimage if A then broadcasts its local tx.
2395 // Finally, when A sees B's latest local commitment transaction it should be able to claim
2396 // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2397 // PaymentSent event).
2399 let chanmon_cfgs = create_chanmon_cfgs(3);
2400 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2401 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2402 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2404 // Create some initial channels
2405 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2406 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2408 // Rebalance the network a bit by relaying one payment through all the channels...
2409 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2410 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2412 let (our_payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2413 let (our_payment_preimage_2, _payment_hash_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2414 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2416 // Broadcast legit commitment tx from C on B's chain
2417 // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2418 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();
2419 assert_eq!(commitment_tx.len(), 1);
2420 check_spends!(commitment_tx[0], chan_2.3);
2421 nodes[2].node.claim_funds(our_payment_preimage, 3_000_000);
2422 nodes[2].node.claim_funds(our_payment_preimage_2, 3_000_000);
2423 check_added_monitors!(nodes[2], 2);
2424 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2425 assert!(updates.update_add_htlcs.is_empty());
2426 assert!(updates.update_fail_htlcs.is_empty());
2427 assert!(updates.update_fail_malformed_htlcs.is_empty());
2428 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2430 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2431 check_closed_broadcast!(nodes[2], false);
2432 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)
2433 assert_eq!(node_txn.len(), 7);
2434 assert_eq!(node_txn[0], node_txn[3]);
2435 assert_eq!(node_txn[1], node_txn[4]);
2436 assert_eq!(node_txn[0], node_txn[5]);
2437 assert_eq!(node_txn[1], node_txn[6]);
2438 assert_eq!(node_txn[2], commitment_tx[0]);
2439 check_spends!(node_txn[0], commitment_tx[0]);
2440 check_spends!(node_txn[1], commitment_tx[0]);
2441 assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2442 assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2443 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2444 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2445 assert_eq!(node_txn[0].lock_time, 0);
2446 assert_eq!(node_txn[1].lock_time, 0);
2448 // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2449 nodes[1].block_notifier.block_connected(&Block { header, txdata: node_txn}, 1);
2450 let events = nodes[1].node.get_and_clear_pending_msg_events();
2452 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
2453 assert_eq!(added_monitors.len(), 2);
2454 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2455 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2456 added_monitors.clear();
2458 assert_eq!(events.len(), 2);
2460 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2461 _ => panic!("Unexpected event"),
2464 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, .. } } => {
2465 assert!(update_add_htlcs.is_empty());
2466 assert!(update_fail_htlcs.is_empty());
2467 assert_eq!(update_fulfill_htlcs.len(), 1);
2468 assert!(update_fail_malformed_htlcs.is_empty());
2469 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2471 _ => panic!("Unexpected event"),
2473 macro_rules! check_tx_local_broadcast {
2474 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2475 let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2476 assert_eq!(node_txn.len(), if $htlc_offered { 7 } else { 5 });
2477 // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2478 // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout * 2 (block-rescan)
2479 check_spends!(node_txn[0], $commitment_tx);
2480 check_spends!(node_txn[1], $commitment_tx);
2482 assert_eq!(node_txn[0], node_txn[5]);
2483 assert_eq!(node_txn[1], node_txn[6]);
2485 assert_ne!(node_txn[0].lock_time, 0);
2486 assert_ne!(node_txn[1].lock_time, 0);
2488 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2489 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2490 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2491 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2493 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2494 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2495 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2496 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2498 check_spends!(node_txn[2], $chan_tx);
2499 check_spends!(node_txn[3], node_txn[2]);
2500 check_spends!(node_txn[4], node_txn[2]);
2501 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), 71);
2502 assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2503 assert_eq!(node_txn[4].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2504 assert!(node_txn[3].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2505 assert!(node_txn[4].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2506 assert_ne!(node_txn[3].lock_time, 0);
2507 assert_ne!(node_txn[4].lock_time, 0);
2511 // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2512 // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2513 // timeout-claim of the output that nodes[2] just claimed via success.
2514 check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2516 // Broadcast legit commitment tx from A on B's chain
2517 // Broadcast preimage tx by B on offered output from A commitment tx on A's chain
2518 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();
2519 check_spends!(commitment_tx[0], chan_1.3);
2520 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2521 check_closed_broadcast!(nodes[1], false);
2522 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 1 (HTLC-Success)
2523 assert_eq!(node_txn.len(), 4);
2524 check_spends!(node_txn[0], commitment_tx[0]);
2525 assert_eq!(node_txn[0].input.len(), 2);
2526 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2527 assert_eq!(node_txn[0].input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2528 assert_eq!(node_txn[0].lock_time, 0);
2529 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2530 check_spends!(node_txn[1], chan_1.3);
2531 assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2532 check_spends!(node_txn[2], node_txn[1]);
2533 check_spends!(node_txn[3], node_txn[1]);
2534 // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2535 // we already checked the same situation with A.
2537 // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2538 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone(), node_txn[0].clone()] }, 1);
2539 check_closed_broadcast!(nodes[0], false);
2540 let events = nodes[0].node.get_and_clear_pending_events();
2541 assert_eq!(events.len(), 2);
2542 let mut first_claimed = false;
2543 for event in events {
2545 Event::PaymentSent { payment_preimage } => {
2546 if payment_preimage == our_payment_preimage {
2547 assert!(!first_claimed);
2548 first_claimed = true;
2550 assert_eq!(payment_preimage, our_payment_preimage_2);
2553 _ => panic!("Unexpected event"),
2556 check_tx_local_broadcast!(nodes[0], true, commitment_tx[0], chan_1.3);
2560 fn test_htlc_on_chain_timeout() {
2561 // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2562 // ChainWatchInterface and timeout the HTLC backward accordingly. So here we test that ChannelManager is
2563 // broadcasting the right event to other nodes in payment path.
2564 // A ------------------> B ----------------------> C (timeout)
2565 // B's commitment tx C's commitment tx
2567 // B's HTLC timeout tx B's timeout tx
2569 let chanmon_cfgs = create_chanmon_cfgs(3);
2570 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2571 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2572 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2574 // Create some intial channels
2575 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2576 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2578 // Rebalance the network a bit by relaying one payment thorugh all the channels...
2579 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2580 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2582 let (_payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2583 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2585 // Broadcast legit commitment tx from C on B's chain
2586 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();
2587 check_spends!(commitment_tx[0], chan_2.3);
2588 nodes[2].node.fail_htlc_backwards(&payment_hash);
2589 check_added_monitors!(nodes[2], 0);
2590 expect_pending_htlcs_forwardable!(nodes[2]);
2591 check_added_monitors!(nodes[2], 1);
2593 let events = nodes[2].node.get_and_clear_pending_msg_events();
2594 assert_eq!(events.len(), 1);
2596 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, .. } } => {
2597 assert!(update_add_htlcs.is_empty());
2598 assert!(!update_fail_htlcs.is_empty());
2599 assert!(update_fulfill_htlcs.is_empty());
2600 assert!(update_fail_malformed_htlcs.is_empty());
2601 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2603 _ => panic!("Unexpected event"),
2605 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2606 check_closed_broadcast!(nodes[2], false);
2607 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2608 assert_eq!(node_txn.len(), 1);
2609 check_spends!(node_txn[0], chan_2.3);
2610 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2612 // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2613 // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2614 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2617 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2618 assert_eq!(node_txn.len(), 7); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : (local commitment tx + HTLC-timeout) * 2 (block-rescan), timeout tx
2619 assert_eq!(node_txn[0], node_txn[3]);
2620 assert_eq!(node_txn[0], node_txn[5]);
2621 assert_eq!(node_txn[1], node_txn[4]);
2622 assert_eq!(node_txn[1], node_txn[6]);
2624 check_spends!(node_txn[2], commitment_tx[0]);
2625 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2627 check_spends!(node_txn[0], chan_2.3);
2628 check_spends!(node_txn[1], node_txn[0]);
2629 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
2630 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2632 timeout_tx = node_txn[2].clone();
2636 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![timeout_tx]}, 1);
2637 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2638 check_added_monitors!(nodes[1], 0);
2639 check_closed_broadcast!(nodes[1], false);
2641 expect_pending_htlcs_forwardable!(nodes[1]);
2642 check_added_monitors!(nodes[1], 1);
2643 let events = nodes[1].node.get_and_clear_pending_msg_events();
2644 assert_eq!(events.len(), 1);
2646 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, .. } } => {
2647 assert!(update_add_htlcs.is_empty());
2648 assert!(!update_fail_htlcs.is_empty());
2649 assert!(update_fulfill_htlcs.is_empty());
2650 assert!(update_fail_malformed_htlcs.is_empty());
2651 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2653 _ => panic!("Unexpected event"),
2655 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
2656 assert_eq!(node_txn.len(), 0);
2658 // Broadcast legit commitment tx from B on A's chain
2659 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();
2660 check_spends!(commitment_tx[0], chan_1.3);
2662 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2663 check_closed_broadcast!(nodes[0], false);
2664 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 1 timeout tx
2665 assert_eq!(node_txn.len(), 3);
2666 check_spends!(node_txn[0], commitment_tx[0]);
2667 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2668 check_spends!(node_txn[1], chan_1.3);
2669 check_spends!(node_txn[2], node_txn[1]);
2670 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2671 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2675 fn test_simple_commitment_revoked_fail_backward() {
2676 // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
2677 // and fail backward accordingly.
2679 let chanmon_cfgs = create_chanmon_cfgs(3);
2680 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2681 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2682 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2684 // Create some initial channels
2685 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2686 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2688 let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2689 // Get the will-be-revoked local txn from nodes[2]
2690 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();
2691 // Revoke the old state
2692 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, 3_000_000);
2694 route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2696 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2697 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2698 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2699 check_added_monitors!(nodes[1], 0);
2700 check_closed_broadcast!(nodes[1], false);
2702 expect_pending_htlcs_forwardable!(nodes[1]);
2703 check_added_monitors!(nodes[1], 1);
2704 let events = nodes[1].node.get_and_clear_pending_msg_events();
2705 assert_eq!(events.len(), 1);
2707 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, .. } } => {
2708 assert!(update_add_htlcs.is_empty());
2709 assert_eq!(update_fail_htlcs.len(), 1);
2710 assert!(update_fulfill_htlcs.is_empty());
2711 assert!(update_fail_malformed_htlcs.is_empty());
2712 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2714 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
2715 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2717 let events = nodes[0].node.get_and_clear_pending_msg_events();
2718 assert_eq!(events.len(), 1);
2720 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
2721 _ => panic!("Unexpected event"),
2723 let events = nodes[0].node.get_and_clear_pending_events();
2724 assert_eq!(events.len(), 1);
2726 Event::PaymentFailed { .. } => {},
2727 _ => panic!("Unexpected event"),
2730 _ => panic!("Unexpected event"),
2734 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
2735 // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
2736 // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
2737 // commitment transaction anymore.
2738 // To do this, we have the peer which will broadcast a revoked commitment transaction send
2739 // a number of update_fail/commitment_signed updates without ever sending the RAA in
2740 // response to our commitment_signed. This is somewhat misbehavior-y, though not
2741 // technically disallowed and we should probably handle it reasonably.
2742 // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
2743 // failed/fulfilled backwards must be in at least one of the latest two remote commitment
2745 // * Once we move it out of our holding cell/add it, we will immediately include it in a
2746 // commitment_signed (implying it will be in the latest remote commitment transaction).
2747 // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
2748 // and once they revoke the previous commitment transaction (allowing us to send a new
2749 // commitment_signed) we will be free to fail/fulfill the HTLC backwards.
2750 let chanmon_cfgs = create_chanmon_cfgs(3);
2751 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2752 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2753 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2755 // Create some initial channels
2756 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2757 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2759 let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], if no_to_remote { 10_000 } else { 3_000_000 });
2760 // Get the will-be-revoked local txn from nodes[2]
2761 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();
2762 assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
2763 // Revoke the old state
2764 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, if no_to_remote { 10_000 } else { 3_000_000});
2766 let value = if use_dust {
2767 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
2768 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
2769 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().our_dust_limit_satoshis * 1000
2772 let (_, first_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2773 let (_, second_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2774 let (_, third_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2776 assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash));
2777 expect_pending_htlcs_forwardable!(nodes[2]);
2778 check_added_monitors!(nodes[2], 1);
2779 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2780 assert!(updates.update_add_htlcs.is_empty());
2781 assert!(updates.update_fulfill_htlcs.is_empty());
2782 assert!(updates.update_fail_malformed_htlcs.is_empty());
2783 assert_eq!(updates.update_fail_htlcs.len(), 1);
2784 assert!(updates.update_fee.is_none());
2785 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2786 let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
2787 // Drop the last RAA from 3 -> 2
2789 assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash));
2790 expect_pending_htlcs_forwardable!(nodes[2]);
2791 check_added_monitors!(nodes[2], 1);
2792 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2793 assert!(updates.update_add_htlcs.is_empty());
2794 assert!(updates.update_fulfill_htlcs.is_empty());
2795 assert!(updates.update_fail_malformed_htlcs.is_empty());
2796 assert_eq!(updates.update_fail_htlcs.len(), 1);
2797 assert!(updates.update_fee.is_none());
2798 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2799 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2800 check_added_monitors!(nodes[1], 1);
2801 // Note that nodes[1] is in AwaitingRAA, so won't send a CS
2802 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2803 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2804 check_added_monitors!(nodes[2], 1);
2806 assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash));
2807 expect_pending_htlcs_forwardable!(nodes[2]);
2808 check_added_monitors!(nodes[2], 1);
2809 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2810 assert!(updates.update_add_htlcs.is_empty());
2811 assert!(updates.update_fulfill_htlcs.is_empty());
2812 assert!(updates.update_fail_malformed_htlcs.is_empty());
2813 assert_eq!(updates.update_fail_htlcs.len(), 1);
2814 assert!(updates.update_fee.is_none());
2815 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2816 // At this point first_payment_hash has dropped out of the latest two commitment
2817 // transactions that nodes[1] is tracking...
2818 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2819 check_added_monitors!(nodes[1], 1);
2820 // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
2821 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2822 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2823 check_added_monitors!(nodes[2], 1);
2825 // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
2826 // on nodes[2]'s RAA.
2827 let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
2828 let (_, fourth_payment_hash) = get_payment_preimage_hash!(nodes[0]);
2829 nodes[1].node.send_payment(route, fourth_payment_hash).unwrap();
2830 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2831 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2832 check_added_monitors!(nodes[1], 0);
2835 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
2836 // One monitor for the new revocation preimage, no second on as we won't generate a new
2837 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
2838 check_added_monitors!(nodes[1], 1);
2839 let events = nodes[1].node.get_and_clear_pending_events();
2840 assert_eq!(events.len(), 1);
2842 Event::PendingHTLCsForwardable { .. } => { },
2843 _ => panic!("Unexpected event"),
2845 // Deliberately don't process the pending fail-back so they all fail back at once after
2846 // block connection just like the !deliver_bs_raa case
2849 let mut failed_htlcs = HashSet::new();
2850 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2852 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2853 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2854 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2856 let events = nodes[1].node.get_and_clear_pending_events();
2857 assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
2859 Event::PaymentFailed { ref payment_hash, .. } => {
2860 assert_eq!(*payment_hash, fourth_payment_hash);
2862 _ => panic!("Unexpected event"),
2864 if !deliver_bs_raa {
2866 Event::PendingHTLCsForwardable { .. } => { },
2867 _ => panic!("Unexpected event"),
2870 nodes[1].node.process_pending_htlc_forwards();
2871 check_added_monitors!(nodes[1], 1);
2873 let events = nodes[1].node.get_and_clear_pending_msg_events();
2874 assert_eq!(events.len(), if deliver_bs_raa { 3 } else { 2 });
2875 match events[if deliver_bs_raa { 1 } else { 0 }] {
2876 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
2877 _ => panic!("Unexpected event"),
2881 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, .. } } => {
2882 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
2883 assert_eq!(update_add_htlcs.len(), 1);
2884 assert!(update_fulfill_htlcs.is_empty());
2885 assert!(update_fail_htlcs.is_empty());
2886 assert!(update_fail_malformed_htlcs.is_empty());
2888 _ => panic!("Unexpected event"),
2891 match events[if deliver_bs_raa { 2 } else { 1 }] {
2892 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, .. } } => {
2893 assert!(update_add_htlcs.is_empty());
2894 assert_eq!(update_fail_htlcs.len(), 3);
2895 assert!(update_fulfill_htlcs.is_empty());
2896 assert!(update_fail_malformed_htlcs.is_empty());
2897 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2899 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
2900 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
2901 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
2903 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2905 let events = nodes[0].node.get_and_clear_pending_msg_events();
2906 // If we delivered B's RAA we got an unknown preimage error, not something
2907 // that we should update our routing table for.
2908 assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
2909 for event in events {
2911 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
2912 _ => panic!("Unexpected event"),
2915 let events = nodes[0].node.get_and_clear_pending_events();
2916 assert_eq!(events.len(), 3);
2918 Event::PaymentFailed { ref payment_hash, .. } => {
2919 assert!(failed_htlcs.insert(payment_hash.0));
2921 _ => panic!("Unexpected event"),
2924 Event::PaymentFailed { ref payment_hash, .. } => {
2925 assert!(failed_htlcs.insert(payment_hash.0));
2927 _ => panic!("Unexpected event"),
2930 Event::PaymentFailed { ref payment_hash, .. } => {
2931 assert!(failed_htlcs.insert(payment_hash.0));
2933 _ => panic!("Unexpected event"),
2936 _ => panic!("Unexpected event"),
2939 assert!(failed_htlcs.contains(&first_payment_hash.0));
2940 assert!(failed_htlcs.contains(&second_payment_hash.0));
2941 assert!(failed_htlcs.contains(&third_payment_hash.0));
2945 fn test_commitment_revoked_fail_backward_exhaustive_a() {
2946 do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
2947 do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
2948 do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
2949 do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
2953 fn test_commitment_revoked_fail_backward_exhaustive_b() {
2954 do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
2955 do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
2956 do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
2957 do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
2961 fn test_htlc_ignore_latest_remote_commitment() {
2962 // Test that HTLC transactions spending the latest remote commitment transaction are simply
2963 // ignored if we cannot claim them. This originally tickled an invalid unwrap().
2964 let chanmon_cfgs = create_chanmon_cfgs(2);
2965 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2966 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2967 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2968 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2970 route_payment(&nodes[0], &[&nodes[1]], 10000000);
2971 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id);
2972 check_closed_broadcast!(nodes[0], false);
2974 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2975 assert_eq!(node_txn.len(), 2);
2977 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2978 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
2979 check_closed_broadcast!(nodes[1], false);
2981 // Duplicate the block_connected call since this may happen due to other listeners
2982 // registering new transactions
2983 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
2987 fn test_force_close_fail_back() {
2988 // Check which HTLCs are failed-backwards on channel force-closure
2989 let chanmon_cfgs = create_chanmon_cfgs(3);
2990 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2991 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2992 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2993 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2994 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2996 let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, 42).unwrap();
2998 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3000 let mut payment_event = {
3001 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
3002 check_added_monitors!(nodes[0], 1);
3004 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3005 assert_eq!(events.len(), 1);
3006 SendEvent::from_event(events.remove(0))
3009 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3010 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3012 expect_pending_htlcs_forwardable!(nodes[1]);
3014 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3015 assert_eq!(events_2.len(), 1);
3016 payment_event = SendEvent::from_event(events_2.remove(0));
3017 assert_eq!(payment_event.msgs.len(), 1);
3019 check_added_monitors!(nodes[1], 1);
3020 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3021 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3022 check_added_monitors!(nodes[2], 1);
3023 let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3025 // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3026 // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3027 // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3029 nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id);
3030 check_closed_broadcast!(nodes[2], false);
3032 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3033 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3034 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3035 // back to nodes[1] upon timeout otherwise.
3036 assert_eq!(node_txn.len(), 1);
3040 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3041 nodes[1].block_notifier.block_connected_checked(&header, 1, &[&tx], &[1]);
3043 // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3044 check_closed_broadcast!(nodes[1], false);
3046 // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3048 let mut monitors = nodes[2].chan_monitor.simple_monitor.monitors.lock().unwrap();
3049 monitors.get_mut(&OutPoint::new(Sha256dHash::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), 0)).unwrap()
3050 .provide_payment_preimage(&our_payment_hash, &our_payment_preimage);
3052 nodes[2].block_notifier.block_connected_checked(&header, 1, &[&tx], &[1]);
3053 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3054 assert_eq!(node_txn.len(), 1);
3055 assert_eq!(node_txn[0].input.len(), 1);
3056 assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3057 assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3058 assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3060 check_spends!(node_txn[0], tx);
3064 fn test_unconf_chan() {
3065 // After creating a chan between nodes, we disconnect all blocks previously seen to force a channel close on nodes[0] side
3066 let chanmon_cfgs = create_chanmon_cfgs(2);
3067 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3068 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3069 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3070 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3072 let channel_state = nodes[0].node.channel_state.lock().unwrap();
3073 assert_eq!(channel_state.by_id.len(), 1);
3074 assert_eq!(channel_state.short_to_id.len(), 1);
3075 mem::drop(channel_state);
3077 let mut headers = Vec::new();
3078 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3079 headers.push(header.clone());
3081 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3082 headers.push(header.clone());
3084 let mut height = 99;
3085 while !headers.is_empty() {
3086 nodes[0].node.block_disconnected(&headers.pop().unwrap(), height);
3089 check_closed_broadcast!(nodes[0], false);
3090 let channel_state = nodes[0].node.channel_state.lock().unwrap();
3091 assert_eq!(channel_state.by_id.len(), 0);
3092 assert_eq!(channel_state.short_to_id.len(), 0);
3096 fn test_simple_peer_disconnect() {
3097 // Test that we can reconnect when there are no lost messages
3098 let chanmon_cfgs = create_chanmon_cfgs(3);
3099 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3100 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3101 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3102 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3103 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
3105 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3106 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3107 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3109 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3110 let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3111 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3112 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1, 1_000_000);
3114 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3115 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3116 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3118 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3119 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3120 let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3121 let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3123 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3124 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3126 claim_payment_along_route(&nodes[0], &vec!(&nodes[1], &nodes[2]), true, payment_preimage_3, 1_000_000);
3127 fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3129 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3131 let events = nodes[0].node.get_and_clear_pending_events();
3132 assert_eq!(events.len(), 2);
3134 Event::PaymentSent { payment_preimage } => {
3135 assert_eq!(payment_preimage, payment_preimage_3);
3137 _ => panic!("Unexpected event"),
3140 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3141 assert_eq!(payment_hash, payment_hash_5);
3142 assert!(rejected_by_dest);
3144 _ => panic!("Unexpected event"),
3148 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4, 1_000_000);
3149 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3152 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
3153 // Test that we can reconnect when in-flight HTLC updates get dropped
3154 let chanmon_cfgs = create_chanmon_cfgs(2);
3155 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3156 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3157 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3158 if messages_delivered == 0 {
3159 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
3160 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3162 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3165 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();
3166 let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
3168 let payment_event = {
3169 nodes[0].node.send_payment(route.clone(), payment_hash_1).unwrap();
3170 check_added_monitors!(nodes[0], 1);
3172 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3173 assert_eq!(events.len(), 1);
3174 SendEvent::from_event(events.remove(0))
3176 assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3178 if messages_delivered < 2 {
3179 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3181 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3182 if messages_delivered >= 3 {
3183 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3184 check_added_monitors!(nodes[1], 1);
3185 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3187 if messages_delivered >= 4 {
3188 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3189 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3190 check_added_monitors!(nodes[0], 1);
3192 if messages_delivered >= 5 {
3193 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3194 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3195 // No commitment_signed so get_event_msg's assert(len == 1) passes
3196 check_added_monitors!(nodes[0], 1);
3198 if messages_delivered >= 6 {
3199 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3200 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3201 check_added_monitors!(nodes[1], 1);
3208 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3209 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3210 if messages_delivered < 3 {
3211 // Even if the funding_locked messages get exchanged, as long as nothing further was
3212 // received on either side, both sides will need to resend them.
3213 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3214 } else if messages_delivered == 3 {
3215 // nodes[0] still wants its RAA + commitment_signed
3216 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3217 } else if messages_delivered == 4 {
3218 // nodes[0] still wants its commitment_signed
3219 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3220 } else if messages_delivered == 5 {
3221 // nodes[1] still wants its final RAA
3222 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3223 } else if messages_delivered == 6 {
3224 // Everything was delivered...
3225 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3228 let events_1 = nodes[1].node.get_and_clear_pending_events();
3229 assert_eq!(events_1.len(), 1);
3231 Event::PendingHTLCsForwardable { .. } => { },
3232 _ => panic!("Unexpected event"),
3235 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3236 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3237 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3239 nodes[1].node.process_pending_htlc_forwards();
3241 let events_2 = nodes[1].node.get_and_clear_pending_events();
3242 assert_eq!(events_2.len(), 1);
3244 Event::PaymentReceived { ref payment_hash, amt } => {
3245 assert_eq!(payment_hash_1, *payment_hash);
3246 assert_eq!(amt, 1000000);
3248 _ => panic!("Unexpected event"),
3251 nodes[1].node.claim_funds(payment_preimage_1, 1_000_000);
3252 check_added_monitors!(nodes[1], 1);
3254 let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3255 assert_eq!(events_3.len(), 1);
3256 let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3257 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3258 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3259 assert!(updates.update_add_htlcs.is_empty());
3260 assert!(updates.update_fail_htlcs.is_empty());
3261 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3262 assert!(updates.update_fail_malformed_htlcs.is_empty());
3263 assert!(updates.update_fee.is_none());
3264 (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3266 _ => panic!("Unexpected event"),
3269 if messages_delivered >= 1 {
3270 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3272 let events_4 = nodes[0].node.get_and_clear_pending_events();
3273 assert_eq!(events_4.len(), 1);
3275 Event::PaymentSent { ref payment_preimage } => {
3276 assert_eq!(payment_preimage_1, *payment_preimage);
3278 _ => panic!("Unexpected event"),
3281 if messages_delivered >= 2 {
3282 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3283 check_added_monitors!(nodes[0], 1);
3284 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3286 if messages_delivered >= 3 {
3287 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3288 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3289 check_added_monitors!(nodes[1], 1);
3291 if messages_delivered >= 4 {
3292 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3293 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3294 // No commitment_signed so get_event_msg's assert(len == 1) passes
3295 check_added_monitors!(nodes[1], 1);
3297 if messages_delivered >= 5 {
3298 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3299 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3300 check_added_monitors!(nodes[0], 1);
3307 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3308 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3309 if messages_delivered < 2 {
3310 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3311 //TODO: Deduplicate PaymentSent events, then enable this if:
3312 //if messages_delivered < 1 {
3313 let events_4 = nodes[0].node.get_and_clear_pending_events();
3314 assert_eq!(events_4.len(), 1);
3316 Event::PaymentSent { ref payment_preimage } => {
3317 assert_eq!(payment_preimage_1, *payment_preimage);
3319 _ => panic!("Unexpected event"),
3322 } else if messages_delivered == 2 {
3323 // nodes[0] still wants its RAA + commitment_signed
3324 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3325 } else if messages_delivered == 3 {
3326 // nodes[0] still wants its commitment_signed
3327 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3328 } else if messages_delivered == 4 {
3329 // nodes[1] still wants its final RAA
3330 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3331 } else if messages_delivered == 5 {
3332 // Everything was delivered...
3333 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3336 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3337 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3338 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3340 // Channel should still work fine...
3341 let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3342 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3346 fn test_drop_messages_peer_disconnect_a() {
3347 do_test_drop_messages_peer_disconnect(0);
3348 do_test_drop_messages_peer_disconnect(1);
3349 do_test_drop_messages_peer_disconnect(2);
3350 do_test_drop_messages_peer_disconnect(3);
3354 fn test_drop_messages_peer_disconnect_b() {
3355 do_test_drop_messages_peer_disconnect(4);
3356 do_test_drop_messages_peer_disconnect(5);
3357 do_test_drop_messages_peer_disconnect(6);
3361 fn test_funding_peer_disconnect() {
3362 // Test that we can lock in our funding tx while disconnected
3363 let chanmon_cfgs = create_chanmon_cfgs(2);
3364 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3365 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3366 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3367 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
3369 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3370 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3372 confirm_transaction(&nodes[0].block_notifier, &nodes[0].chain_monitor, &tx, tx.version);
3373 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3374 assert_eq!(events_1.len(), 1);
3376 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3377 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3379 _ => panic!("Unexpected event"),
3382 reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3384 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3385 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3387 confirm_transaction(&nodes[1].block_notifier, &nodes[1].chain_monitor, &tx, tx.version);
3388 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3389 assert_eq!(events_2.len(), 2);
3390 let funding_locked = match events_2[0] {
3391 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3392 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3395 _ => panic!("Unexpected event"),
3397 let bs_announcement_sigs = match events_2[1] {
3398 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3399 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3402 _ => panic!("Unexpected event"),
3405 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3407 nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3408 nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3409 let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3410 assert_eq!(events_3.len(), 2);
3411 let as_announcement_sigs = match events_3[0] {
3412 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3413 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3416 _ => panic!("Unexpected event"),
3418 let (as_announcement, as_update) = match events_3[1] {
3419 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3420 (msg.clone(), update_msg.clone())
3422 _ => panic!("Unexpected event"),
3425 nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3426 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3427 assert_eq!(events_4.len(), 1);
3428 let (_, bs_update) = match events_4[0] {
3429 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3430 (msg.clone(), update_msg.clone())
3432 _ => panic!("Unexpected event"),
3435 nodes[0].router.handle_channel_announcement(&as_announcement).unwrap();
3436 nodes[0].router.handle_channel_update(&bs_update).unwrap();
3437 nodes[0].router.handle_channel_update(&as_update).unwrap();
3439 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
3440 let (payment_preimage, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3441 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage, 1_000_000);
3445 fn test_drop_messages_peer_disconnect_dual_htlc() {
3446 // Test that we can handle reconnecting when both sides of a channel have pending
3447 // commitment_updates when we disconnect.
3448 let chanmon_cfgs = create_chanmon_cfgs(2);
3449 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3450 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3451 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3452 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3454 let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3456 // Now try to send a second payment which will fail to send
3457 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
3458 let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
3460 nodes[0].node.send_payment(route.clone(), payment_hash_2).unwrap();
3461 check_added_monitors!(nodes[0], 1);
3463 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3464 assert_eq!(events_1.len(), 1);
3466 MessageSendEvent::UpdateHTLCs { .. } => {},
3467 _ => panic!("Unexpected event"),
3470 assert!(nodes[1].node.claim_funds(payment_preimage_1, 1_000_000));
3471 check_added_monitors!(nodes[1], 1);
3473 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3474 assert_eq!(events_2.len(), 1);
3476 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 } } => {
3477 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3478 assert!(update_add_htlcs.is_empty());
3479 assert_eq!(update_fulfill_htlcs.len(), 1);
3480 assert!(update_fail_htlcs.is_empty());
3481 assert!(update_fail_malformed_htlcs.is_empty());
3482 assert!(update_fee.is_none());
3484 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3485 let events_3 = nodes[0].node.get_and_clear_pending_events();
3486 assert_eq!(events_3.len(), 1);
3488 Event::PaymentSent { ref payment_preimage } => {
3489 assert_eq!(*payment_preimage, payment_preimage_1);
3491 _ => panic!("Unexpected event"),
3494 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
3495 let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3496 // No commitment_signed so get_event_msg's assert(len == 1) passes
3497 check_added_monitors!(nodes[0], 1);
3499 _ => panic!("Unexpected event"),
3502 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3503 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3505 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3506 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3507 assert_eq!(reestablish_1.len(), 1);
3508 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3509 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3510 assert_eq!(reestablish_2.len(), 1);
3512 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3513 let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3514 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3515 let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3517 assert!(as_resp.0.is_none());
3518 assert!(bs_resp.0.is_none());
3520 assert!(bs_resp.1.is_none());
3521 assert!(bs_resp.2.is_none());
3523 assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3525 assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3526 assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3527 assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3528 assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3529 assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3530 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
3531 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
3532 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3533 // No commitment_signed so get_event_msg's assert(len == 1) passes
3534 check_added_monitors!(nodes[1], 1);
3536 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
3537 let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3538 assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
3539 assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
3540 assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
3541 assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
3542 assert!(bs_second_commitment_signed.update_fee.is_none());
3543 check_added_monitors!(nodes[1], 1);
3545 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3546 let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3547 assert!(as_commitment_signed.update_add_htlcs.is_empty());
3548 assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
3549 assert!(as_commitment_signed.update_fail_htlcs.is_empty());
3550 assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
3551 assert!(as_commitment_signed.update_fee.is_none());
3552 check_added_monitors!(nodes[0], 1);
3554 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
3555 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3556 // No commitment_signed so get_event_msg's assert(len == 1) passes
3557 check_added_monitors!(nodes[0], 1);
3559 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
3560 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3561 // No commitment_signed so get_event_msg's assert(len == 1) passes
3562 check_added_monitors!(nodes[1], 1);
3564 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3565 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3566 check_added_monitors!(nodes[1], 1);
3568 expect_pending_htlcs_forwardable!(nodes[1]);
3570 let events_5 = nodes[1].node.get_and_clear_pending_events();
3571 assert_eq!(events_5.len(), 1);
3573 Event::PaymentReceived { ref payment_hash, amt: _ } => {
3574 assert_eq!(payment_hash_2, *payment_hash);
3576 _ => panic!("Unexpected event"),
3579 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
3580 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3581 check_added_monitors!(nodes[0], 1);
3583 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3587 fn test_invalid_channel_announcement() {
3588 //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
3589 let secp_ctx = Secp256k1::new();
3590 let chanmon_cfgs = create_chanmon_cfgs(2);
3591 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3592 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3593 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3595 let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::supported(), InitFeatures::supported());
3597 let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
3598 let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
3599 let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
3600 let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
3602 nodes[0].router.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap(), is_permanent: false } );
3604 let as_bitcoin_key = as_chan.get_local_keys().inner.local_channel_pubkeys.funding_pubkey;
3605 let bs_bitcoin_key = bs_chan.get_local_keys().inner.local_channel_pubkeys.funding_pubkey;
3607 let as_network_key = nodes[0].node.get_our_node_id();
3608 let bs_network_key = nodes[1].node.get_our_node_id();
3610 let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
3612 let mut chan_announcement;
3614 macro_rules! dummy_unsigned_msg {
3616 msgs::UnsignedChannelAnnouncement {
3617 features: ChannelFeatures::supported(),
3618 chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
3619 short_channel_id: as_chan.get_short_channel_id().unwrap(),
3620 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
3621 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
3622 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
3623 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
3624 excess_data: Vec::new(),
3629 macro_rules! sign_msg {
3630 ($unsigned_msg: expr) => {
3631 let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
3632 let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_local_keys().inner.funding_key());
3633 let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_local_keys().inner.funding_key());
3634 let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
3635 let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
3636 chan_announcement = msgs::ChannelAnnouncement {
3637 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
3638 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
3639 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
3640 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
3641 contents: $unsigned_msg
3646 let unsigned_msg = dummy_unsigned_msg!();
3647 sign_msg!(unsigned_msg);
3648 assert_eq!(nodes[0].router.handle_channel_announcement(&chan_announcement).unwrap(), true);
3649 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 } );
3651 // Configured with Network::Testnet
3652 let mut unsigned_msg = dummy_unsigned_msg!();
3653 unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.bitcoin_hash();
3654 sign_msg!(unsigned_msg);
3655 assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
3657 let mut unsigned_msg = dummy_unsigned_msg!();
3658 unsigned_msg.chain_hash = Sha256dHash::hash(&[1,2,3,4,5,6,7,8,9]);
3659 sign_msg!(unsigned_msg);
3660 assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
3664 fn test_no_txn_manager_serialize_deserialize() {
3665 let chanmon_cfgs = create_chanmon_cfgs(2);
3666 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3667 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3668 let fee_estimator: test_utils::TestFeeEstimator;
3669 let new_chan_monitor: test_utils::TestChannelMonitor;
3670 let keys_manager: test_utils::TestKeysInterface;
3671 let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>;
3672 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3674 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
3676 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3678 let nodes_0_serialized = nodes[0].node.encode();
3679 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3680 nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
3682 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
3683 new_chan_monitor = test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), Arc::new(test_utils::TestLogger::new()), &fee_estimator);
3684 nodes[0].chan_monitor = &new_chan_monitor;
3685 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3686 let (_, mut chan_0_monitor) = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
3687 assert!(chan_0_monitor_read.is_empty());
3689 let mut nodes_0_read = &nodes_0_serialized[..];
3690 let config = UserConfig::default();
3691 keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new()));
3692 let (_, nodes_0_deserialized_tmp) = {
3693 let mut channel_monitors = HashMap::new();
3694 channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &mut chan_0_monitor);
3695 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3696 default_config: config,
3697 keys_manager: &keys_manager,
3698 fee_estimator: &fee_estimator,
3699 monitor: nodes[0].chan_monitor,
3700 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3701 logger: Arc::new(test_utils::TestLogger::new()),
3702 channel_monitors: &mut channel_monitors,
3705 nodes_0_deserialized = nodes_0_deserialized_tmp;
3706 assert!(nodes_0_read.is_empty());
3708 assert!(nodes[0].chan_monitor.add_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
3709 nodes[0].node = &nodes_0_deserialized;
3710 nodes[0].block_notifier.register_listener(nodes[0].node);
3711 assert_eq!(nodes[0].node.list_channels().len(), 1);
3712 check_added_monitors!(nodes[0], 1);
3714 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3715 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3716 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3717 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3719 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3720 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3721 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3722 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3724 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
3725 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
3726 for node in nodes.iter() {
3727 assert!(node.router.handle_channel_announcement(&announcement).unwrap());
3728 node.router.handle_channel_update(&as_update).unwrap();
3729 node.router.handle_channel_update(&bs_update).unwrap();
3732 send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
3736 fn test_simple_manager_serialize_deserialize() {
3737 let chanmon_cfgs = create_chanmon_cfgs(2);
3738 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3739 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3740 let fee_estimator: test_utils::TestFeeEstimator;
3741 let new_chan_monitor: test_utils::TestChannelMonitor;
3742 let keys_manager: test_utils::TestKeysInterface;
3743 let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>;
3744 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3745 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3747 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3748 let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3750 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3752 let nodes_0_serialized = nodes[0].node.encode();
3753 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3754 nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
3756 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
3757 new_chan_monitor = test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), Arc::new(test_utils::TestLogger::new()), &fee_estimator);
3758 nodes[0].chan_monitor = &new_chan_monitor;
3759 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3760 let (_, mut chan_0_monitor) = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
3761 assert!(chan_0_monitor_read.is_empty());
3763 let mut nodes_0_read = &nodes_0_serialized[..];
3764 keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new()));
3765 let (_, nodes_0_deserialized_tmp) = {
3766 let mut channel_monitors = HashMap::new();
3767 channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &mut chan_0_monitor);
3768 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3769 default_config: UserConfig::default(),
3770 keys_manager: &keys_manager,
3771 fee_estimator: &fee_estimator,
3772 monitor: nodes[0].chan_monitor,
3773 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3774 logger: Arc::new(test_utils::TestLogger::new()),
3775 channel_monitors: &mut channel_monitors,
3778 nodes_0_deserialized = nodes_0_deserialized_tmp;
3779 assert!(nodes_0_read.is_empty());
3781 assert!(nodes[0].chan_monitor.add_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
3782 nodes[0].node = &nodes_0_deserialized;
3783 check_added_monitors!(nodes[0], 1);
3785 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3787 fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
3788 claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage, 1_000_000);
3792 fn test_manager_serialize_deserialize_inconsistent_monitor() {
3793 // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
3794 let chanmon_cfgs = create_chanmon_cfgs(4);
3795 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
3796 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
3797 let fee_estimator: test_utils::TestFeeEstimator;
3798 let new_chan_monitor: test_utils::TestChannelMonitor;
3799 let keys_manager: test_utils::TestKeysInterface;
3800 let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>;
3801 let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
3802 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3803 create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::supported(), InitFeatures::supported());
3804 let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::supported(), InitFeatures::supported());
3806 let (our_payment_preimage, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
3808 // Serialize the ChannelManager here, but the monitor we keep up-to-date
3809 let nodes_0_serialized = nodes[0].node.encode();
3811 route_payment(&nodes[0], &[&nodes[3]], 1000000);
3812 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3813 nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3814 nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3816 // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
3818 let mut node_0_monitors_serialized = Vec::new();
3819 for monitor in nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter() {
3820 let mut writer = test_utils::TestVecWriter(Vec::new());
3821 monitor.1.write_for_disk(&mut writer).unwrap();
3822 node_0_monitors_serialized.push(writer.0);
3825 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
3826 new_chan_monitor = test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), Arc::new(test_utils::TestLogger::new()), &fee_estimator);
3827 nodes[0].chan_monitor = &new_chan_monitor;
3828 let mut node_0_monitors = Vec::new();
3829 for serialized in node_0_monitors_serialized.iter() {
3830 let mut read = &serialized[..];
3831 let (_, monitor) = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut read, Arc::new(test_utils::TestLogger::new())).unwrap();
3832 assert!(read.is_empty());
3833 node_0_monitors.push(monitor);
3836 let mut nodes_0_read = &nodes_0_serialized[..];
3837 keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new()));
3838 let (_, nodes_0_deserialized_tmp) = <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3839 default_config: UserConfig::default(),
3840 keys_manager: &keys_manager,
3841 fee_estimator: &fee_estimator,
3842 monitor: nodes[0].chan_monitor,
3843 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3844 logger: Arc::new(test_utils::TestLogger::new()),
3845 channel_monitors: &mut node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().unwrap(), monitor) }).collect(),
3847 nodes_0_deserialized = nodes_0_deserialized_tmp;
3848 assert!(nodes_0_read.is_empty());
3850 { // Channel close should result in a commitment tx and an HTLC tx
3851 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3852 assert_eq!(txn.len(), 2);
3853 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
3854 assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
3857 for monitor in node_0_monitors.drain(..) {
3858 assert!(nodes[0].chan_monitor.add_monitor(monitor.get_funding_txo().unwrap(), monitor).is_ok());
3859 check_added_monitors!(nodes[0], 1);
3861 nodes[0].node = &nodes_0_deserialized;
3863 // nodes[1] and nodes[2] have no lost state with nodes[0]...
3864 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3865 reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3866 //... and we can even still claim the payment!
3867 claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage, 1_000_000);
3869 nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3870 let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
3871 nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3872 nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
3873 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
3874 assert_eq!(msg_events.len(), 1);
3875 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
3877 &ErrorAction::SendErrorMessage { ref msg } => {
3878 assert_eq!(msg.channel_id, channel_id);
3880 _ => panic!("Unexpected event!"),
3885 macro_rules! check_spendable_outputs {
3886 ($node: expr, $der_idx: expr) => {
3888 let events = $node.chan_monitor.simple_monitor.get_and_clear_pending_events();
3889 let mut txn = Vec::new();
3890 for event in events {
3892 Event::SpendableOutputs { ref outputs } => {
3893 for outp in outputs {
3895 SpendableOutputDescriptor::DynamicOutputP2WPKH { ref outpoint, ref key, ref output } => {
3897 previous_output: outpoint.clone(),
3898 script_sig: Script::new(),
3900 witness: Vec::new(),
3903 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
3904 value: output.value,
3906 let mut spend_tx = Transaction {
3912 let secp_ctx = Secp256k1::new();
3913 let remotepubkey = PublicKey::from_secret_key(&secp_ctx, &key);
3914 let witness_script = Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: remotepubkey}, Network::Testnet).script_pubkey();
3915 let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
3916 let remotesig = secp_ctx.sign(&sighash, key);
3917 spend_tx.input[0].witness.push(remotesig.serialize_der().to_vec());
3918 spend_tx.input[0].witness[0].push(SigHashType::All as u8);
3919 spend_tx.input[0].witness.push(remotepubkey.serialize().to_vec());
3922 SpendableOutputDescriptor::DynamicOutputP2WSH { ref outpoint, ref key, ref witness_script, ref to_self_delay, ref output } => {
3924 previous_output: outpoint.clone(),
3925 script_sig: Script::new(),
3926 sequence: *to_self_delay as u32,
3927 witness: Vec::new(),
3930 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
3931 value: output.value,
3933 let mut spend_tx = Transaction {
3939 let secp_ctx = Secp256k1::new();
3940 let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], witness_script, output.value)[..]).unwrap();
3941 let local_delaysig = secp_ctx.sign(&sighash, key);
3942 spend_tx.input[0].witness.push(local_delaysig.serialize_der().to_vec());
3943 spend_tx.input[0].witness[0].push(SigHashType::All as u8);
3944 spend_tx.input[0].witness.push(vec!(0));
3945 spend_tx.input[0].witness.push(witness_script.clone().into_bytes());
3948 SpendableOutputDescriptor::StaticOutput { ref outpoint, ref output } => {
3949 let secp_ctx = Secp256k1::new();
3951 previous_output: outpoint.clone(),
3952 script_sig: Script::new(),
3954 witness: Vec::new(),
3957 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
3958 value: output.value,
3960 let mut spend_tx = Transaction {
3964 output: vec![outp.clone()],
3967 match ExtendedPrivKey::new_master(Network::Testnet, &$node.node_seed) {
3969 match master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx($der_idx).expect("key space exhausted")) {
3971 Err(_) => panic!("Your RNG is busted"),
3974 Err(_) => panic!("Your rng is busted"),
3977 let pubkey = ExtendedPubKey::from_private(&secp_ctx, &secret).public_key;
3978 let witness_script = Address::p2pkh(&pubkey, Network::Testnet).script_pubkey();
3979 let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
3980 let sig = secp_ctx.sign(&sighash, &secret.private_key.key);
3981 spend_tx.input[0].witness.push(sig.serialize_der().to_vec());
3982 spend_tx.input[0].witness[0].push(SigHashType::All as u8);
3983 spend_tx.input[0].witness.push(pubkey.key.serialize().to_vec());
3989 _ => panic!("Unexpected event"),
3998 fn test_claim_sizeable_push_msat() {
3999 // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4000 let chanmon_cfgs = create_chanmon_cfgs(2);
4001 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4002 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4003 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4005 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::supported(), InitFeatures::supported());
4006 nodes[1].node.force_close_channel(&chan.2);
4007 check_closed_broadcast!(nodes[1], false);
4008 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4009 assert_eq!(node_txn.len(), 1);
4010 check_spends!(node_txn[0], chan.3);
4011 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
4013 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4014 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
4015 let spend_txn = check_spendable_outputs!(nodes[1], 1);
4016 assert_eq!(spend_txn.len(), 1);
4017 check_spends!(spend_txn[0], node_txn[0]);
4021 fn test_claim_on_remote_sizeable_push_msat() {
4022 // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4023 // to_remote output is encumbered by a P2WPKH
4024 let chanmon_cfgs = create_chanmon_cfgs(2);
4025 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4026 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4027 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4029 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::supported(), InitFeatures::supported());
4030 nodes[0].node.force_close_channel(&chan.2);
4031 check_closed_broadcast!(nodes[0], false);
4033 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4034 assert_eq!(node_txn.len(), 1);
4035 check_spends!(node_txn[0], chan.3);
4036 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
4038 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4039 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
4040 check_closed_broadcast!(nodes[1], false);
4041 let spend_txn = check_spendable_outputs!(nodes[1], 1);
4042 assert_eq!(spend_txn.len(), 2);
4043 assert_eq!(spend_txn[0], spend_txn[1]);
4044 check_spends!(spend_txn[0], node_txn[0]);
4048 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4049 // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4050 // to_remote output is encumbered by a P2WPKH
4052 let chanmon_cfgs = create_chanmon_cfgs(2);
4053 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4054 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4055 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4057 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::supported(), InitFeatures::supported());
4058 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4059 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();
4060 assert_eq!(revoked_local_txn[0].input.len(), 1);
4061 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4063 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4064 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4065 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4066 check_closed_broadcast!(nodes[1], false);
4068 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4069 let spend_txn = check_spendable_outputs!(nodes[1], 1);
4070 assert_eq!(spend_txn.len(), 3);
4071 assert_eq!(spend_txn[0], spend_txn[2]); // to_remote output on revoked remote commitment_tx
4072 check_spends!(spend_txn[0], revoked_local_txn[0]);
4073 check_spends!(spend_txn[1], node_txn[0]);
4077 fn test_static_spendable_outputs_preimage_tx() {
4078 let chanmon_cfgs = create_chanmon_cfgs(2);
4079 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4080 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4081 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4083 // Create some initial channels
4084 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4086 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4088 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();
4089 assert_eq!(commitment_tx[0].input.len(), 1);
4090 assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4092 // Settle A's commitment tx on B's chain
4093 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4094 assert!(nodes[1].node.claim_funds(payment_preimage, 3_000_000));
4095 check_added_monitors!(nodes[1], 1);
4096 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()] }, 1);
4097 let events = nodes[1].node.get_and_clear_pending_msg_events();
4099 MessageSendEvent::UpdateHTLCs { .. } => {},
4100 _ => panic!("Unexpected event"),
4103 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4104 _ => panic!("Unexepected event"),
4107 // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4108 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4109 assert_eq!(node_txn.len(), 3);
4110 check_spends!(node_txn[0], commitment_tx[0]);
4111 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4112 eprintln!("{:?}", node_txn[1]);
4113 check_spends!(node_txn[1], chan_1.3);
4114 check_spends!(node_txn[2], node_txn[1]);
4116 let spend_txn = check_spendable_outputs!(nodes[1], 1); // , 0, 0, 1, 1);
4117 assert_eq!(spend_txn.len(), 1);
4118 check_spends!(spend_txn[0], node_txn[0]);
4122 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
4123 let chanmon_cfgs = create_chanmon_cfgs(2);
4124 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4125 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4126 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4128 // Create some initial channels
4129 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4131 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4132 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();
4133 assert_eq!(revoked_local_txn[0].input.len(), 1);
4134 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4136 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4138 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4139 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4140 check_closed_broadcast!(nodes[1], false);
4142 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4143 assert_eq!(node_txn.len(), 2);
4144 assert_eq!(node_txn[0].input.len(), 2);
4145 check_spends!(node_txn[0], revoked_local_txn[0]);
4147 let spend_txn = check_spendable_outputs!(nodes[1], 1);
4148 assert_eq!(spend_txn.len(), 1);
4149 check_spends!(spend_txn[0], node_txn[0]);
4153 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
4154 let chanmon_cfgs = create_chanmon_cfgs(2);
4155 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4156 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4157 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4159 // Create some initial channels
4160 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4162 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4163 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();
4164 assert_eq!(revoked_local_txn[0].input.len(), 1);
4165 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4167 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4169 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4170 // A will generate HTLC-Timeout from revoked commitment tx
4171 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4172 check_closed_broadcast!(nodes[0], false);
4174 let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4175 assert_eq!(revoked_htlc_txn.len(), 3);
4176 assert_eq!(revoked_htlc_txn[0], revoked_htlc_txn[2]);
4177 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4178 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4179 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
4180 check_spends!(revoked_htlc_txn[1], chan_1.3);
4182 // B will generate justice tx from A's revoked commitment/HTLC tx
4183 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
4184 check_closed_broadcast!(nodes[1], false);
4186 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4187 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
4188 assert_eq!(node_txn[0].input.len(), 2);
4189 check_spends!(node_txn[0], revoked_local_txn[0]);
4190 check_spends!(node_txn[1], chan_1.3);
4191 assert_eq!(node_txn[2].input.len(), 1);
4192 check_spends!(node_txn[2], revoked_htlc_txn[0]);
4193 assert_eq!(node_txn[3].input.len(), 1);
4194 check_spends!(node_txn[3], revoked_local_txn[0]);
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(), 2);
4199 check_spends!(spend_txn[0], node_txn[0]);
4200 check_spends!(spend_txn[1], node_txn[2]);
4204 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
4205 let chanmon_cfgs = create_chanmon_cfgs(2);
4206 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4207 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4208 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4210 // Create some initial channels
4211 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4213 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4214 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();
4215 assert_eq!(revoked_local_txn[0].input.len(), 1);
4216 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4218 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4220 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4221 // B will generate HTLC-Success from revoked commitment tx
4222 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4223 check_closed_broadcast!(nodes[1], false);
4224 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4226 assert_eq!(revoked_htlc_txn.len(), 3);
4227 assert_eq!(revoked_htlc_txn[0], revoked_htlc_txn[2]);
4228 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4229 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4230 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
4232 // A will generate justice tx from B's revoked commitment/HTLC tx
4233 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
4234 check_closed_broadcast!(nodes[0], false);
4236 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4237 assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
4238 assert_eq!(node_txn[2].input.len(), 1);
4239 check_spends!(node_txn[2], revoked_htlc_txn[0]);
4241 // Check A's ChannelMonitor was able to generate the right spendable output descriptor
4242 let spend_txn = check_spendable_outputs!(nodes[0], 1);
4243 assert_eq!(spend_txn.len(), 5); // Duplicated SpendableOutput due to block rescan after revoked htlc output tracking
4244 assert_eq!(spend_txn[0], spend_txn[2]);
4245 check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
4246 check_spends!(spend_txn[1], node_txn[0]); // spending justice tx output from revoked local tx htlc received output
4247 check_spends!(spend_txn[3], node_txn[2]); // spending justice tx output on htlc success tx
4251 fn test_onchain_to_onchain_claim() {
4252 // Test that in case of channel closure, we detect the state of output thanks to
4253 // ChainWatchInterface and claim HTLC on downstream peer's remote commitment tx.
4254 // First, have C claim an HTLC against its own latest commitment transaction.
4255 // Then, broadcast these to B, which should update the monitor downstream on the A<->B
4257 // Finally, check that B will claim the HTLC output if A's latest commitment transaction
4260 let chanmon_cfgs = create_chanmon_cfgs(3);
4261 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4262 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4263 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4265 // Create some initial channels
4266 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4267 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
4269 // Rebalance the network a bit by relaying one payment through all the channels ...
4270 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
4271 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
4273 let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
4274 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
4275 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();
4276 check_spends!(commitment_tx[0], chan_2.3);
4277 nodes[2].node.claim_funds(payment_preimage, 3_000_000);
4278 check_added_monitors!(nodes[2], 1);
4279 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
4280 assert!(updates.update_add_htlcs.is_empty());
4281 assert!(updates.update_fail_htlcs.is_empty());
4282 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4283 assert!(updates.update_fail_malformed_htlcs.is_empty());
4285 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
4286 check_closed_broadcast!(nodes[2], false);
4288 let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
4289 assert_eq!(c_txn.len(), 4);
4290 assert_eq!(c_txn[0], c_txn[2]);
4291 assert_eq!(c_txn[0], c_txn[3]);
4292 assert_eq!(commitment_tx[0], c_txn[1]);
4293 check_spends!(c_txn[1], chan_2.3);
4294 check_spends!(c_txn[2], c_txn[1]);
4295 assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
4296 assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4297 assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
4298 assert_eq!(c_txn[0].lock_time, 0); // Success tx
4300 // 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
4301 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]}, 1);
4303 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4304 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-timeout tx
4305 assert_eq!(b_txn.len(), 3);
4306 check_spends!(b_txn[1], chan_2.3); // B local commitment tx, issued by ChannelManager
4307 check_spends!(b_txn[2], b_txn[1]); // HTLC-Timeout on B local commitment tx, issued by ChannelManager
4308 assert_eq!(b_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4309 assert!(b_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
4310 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
4311 check_spends!(b_txn[0], c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor, * 2 due to block rescan
4312 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4313 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
4314 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
4317 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
4318 check_added_monitors!(nodes[1], 1);
4319 match msg_events[0] {
4320 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4321 _ => panic!("Unexpected event"),
4323 match msg_events[1] {
4324 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, .. } } => {
4325 assert!(update_add_htlcs.is_empty());
4326 assert!(update_fail_htlcs.is_empty());
4327 assert_eq!(update_fulfill_htlcs.len(), 1);
4328 assert!(update_fail_malformed_htlcs.is_empty());
4329 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
4331 _ => panic!("Unexpected event"),
4333 // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
4334 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();
4335 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
4336 let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4337 // ChannelMonitor: HTLC-Success tx, ChannelManager: local commitment tx + HTLC-Success tx
4338 assert_eq!(b_txn.len(), 3);
4339 check_spends!(b_txn[1], chan_1.3);
4340 check_spends!(b_txn[2], b_txn[1]);
4341 check_spends!(b_txn[0], commitment_tx[0]);
4342 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4343 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
4344 assert_eq!(b_txn[0].lock_time, 0); // Success tx
4346 check_closed_broadcast!(nodes[1], false);
4350 fn test_duplicate_payment_hash_one_failure_one_success() {
4351 // Topology : A --> B --> C
4352 // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
4353 let chanmon_cfgs = create_chanmon_cfgs(3);
4354 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4355 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4356 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4358 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4359 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
4361 let (our_payment_preimage, duplicate_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
4362 *nodes[0].network_payment_count.borrow_mut() -= 1;
4363 assert_eq!(route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000).1, duplicate_payment_hash);
4365 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();
4366 assert_eq!(commitment_txn[0].input.len(), 1);
4367 check_spends!(commitment_txn[0], chan_2.3);
4369 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4370 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
4371 check_closed_broadcast!(nodes[1], false);
4373 let htlc_timeout_tx;
4374 { // Extract one of the two HTLC-Timeout transaction
4375 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4376 // ChannelMonitor: timeout tx * 2, ChannelManager: local commitment tx + HTLC-timeout * 2
4377 assert_eq!(node_txn.len(), 5);
4378 check_spends!(node_txn[0], commitment_txn[0]);
4379 assert_eq!(node_txn[0].input.len(), 1);
4380 check_spends!(node_txn[1], commitment_txn[0]);
4381 assert_eq!(node_txn[1].input.len(), 1);
4382 assert_ne!(node_txn[0].input[0], node_txn[1].input[0]);
4383 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4384 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4385 check_spends!(node_txn[2], chan_2.3);
4386 check_spends!(node_txn[3], node_txn[2]);
4387 check_spends!(node_txn[4], node_txn[2]);
4388 htlc_timeout_tx = node_txn[1].clone();
4391 nodes[2].node.claim_funds(our_payment_preimage, 900_000);
4392 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
4393 check_added_monitors!(nodes[2], 2);
4394 let events = nodes[2].node.get_and_clear_pending_msg_events();
4396 MessageSendEvent::UpdateHTLCs { .. } => {},
4397 _ => panic!("Unexpected event"),
4400 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4401 _ => panic!("Unexepected event"),
4403 let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
4404 assert_eq!(htlc_success_txn.len(), 7);
4405 check_spends!(htlc_success_txn[2], chan_2.3);
4406 check_spends!(htlc_success_txn[3], htlc_success_txn[2]);
4407 check_spends!(htlc_success_txn[4], htlc_success_txn[2]);
4408 assert_eq!(htlc_success_txn[0], htlc_success_txn[5]);
4409 assert_eq!(htlc_success_txn[0].input.len(), 1);
4410 assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4411 assert_eq!(htlc_success_txn[1], htlc_success_txn[4]);
4412 assert_eq!(htlc_success_txn[1].input.len(), 1);
4413 assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4414 assert_ne!(htlc_success_txn[0].input[0], htlc_success_txn[1].input[0]);
4415 check_spends!(htlc_success_txn[0], commitment_txn[0]);
4416 check_spends!(htlc_success_txn[1], commitment_txn[0]);
4418 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![htlc_timeout_tx] }, 200);
4419 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
4420 expect_pending_htlcs_forwardable!(nodes[1]);
4421 let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4422 assert!(htlc_updates.update_add_htlcs.is_empty());
4423 assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
4424 assert_eq!(htlc_updates.update_fail_htlcs[0].htlc_id, 1);
4425 assert!(htlc_updates.update_fulfill_htlcs.is_empty());
4426 assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
4427 check_added_monitors!(nodes[1], 1);
4429 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
4430 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4432 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
4433 let events = nodes[0].node.get_and_clear_pending_msg_events();
4434 assert_eq!(events.len(), 1);
4436 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. } } => {
4438 _ => { panic!("Unexpected event"); }
4441 let events = nodes[0].node.get_and_clear_pending_events();
4443 Event::PaymentFailed { ref payment_hash, .. } => {
4444 assert_eq!(*payment_hash, duplicate_payment_hash);
4446 _ => panic!("Unexpected event"),
4449 // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
4450 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![htlc_success_txn[0].clone()] }, 200);
4451 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4452 assert!(updates.update_add_htlcs.is_empty());
4453 assert!(updates.update_fail_htlcs.is_empty());
4454 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4455 assert_eq!(updates.update_fulfill_htlcs[0].htlc_id, 0);
4456 assert!(updates.update_fail_malformed_htlcs.is_empty());
4457 check_added_monitors!(nodes[1], 1);
4459 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
4460 commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
4462 let events = nodes[0].node.get_and_clear_pending_events();
4464 Event::PaymentSent { ref payment_preimage } => {
4465 assert_eq!(*payment_preimage, our_payment_preimage);
4467 _ => panic!("Unexpected event"),
4472 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
4473 let chanmon_cfgs = create_chanmon_cfgs(2);
4474 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4475 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4476 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4478 // Create some initial channels
4479 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4481 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
4482 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();
4483 assert_eq!(local_txn[0].input.len(), 1);
4484 check_spends!(local_txn[0], chan_1.3);
4486 // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
4487 nodes[1].node.claim_funds(payment_preimage, 9_000_000);
4488 check_added_monitors!(nodes[1], 1);
4489 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4490 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![local_txn[0].clone()] }, 1);
4491 let events = nodes[1].node.get_and_clear_pending_msg_events();
4493 MessageSendEvent::UpdateHTLCs { .. } => {},
4494 _ => panic!("Unexpected event"),
4497 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4498 _ => panic!("Unexepected event"),
4500 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4501 assert_eq!(node_txn[0].input.len(), 1);
4502 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4503 check_spends!(node_txn[0], local_txn[0]);
4505 // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
4506 let spend_txn = check_spendable_outputs!(nodes[1], 1);
4507 assert_eq!(spend_txn.len(), 2);
4508 check_spends!(spend_txn[0], node_txn[0]);
4509 check_spends!(spend_txn[1], node_txn[2]);
4512 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
4513 // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
4514 // unrevoked commitment transaction.
4515 // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
4516 // a remote RAA before they could be failed backwards (and combinations thereof).
4517 // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
4518 // use the same payment hashes.
4519 // Thus, we use a six-node network:
4524 // And test where C fails back to A/B when D announces its latest commitment transaction
4525 let chanmon_cfgs = create_chanmon_cfgs(6);
4526 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
4527 let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
4528 let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
4530 create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::supported(), InitFeatures::supported());
4531 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
4532 let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
4533 create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::supported(), InitFeatures::supported());
4534 create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::supported(), InitFeatures::supported());
4536 // Rebalance and check output sanity...
4537 send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000, 500_000);
4538 send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000, 500_000);
4539 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);
4541 let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
4543 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
4545 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
4546 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();
4548 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
4550 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
4552 let (_, payment_hash_3) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4554 let (_, payment_hash_4) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4555 let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4557 send_along_route_with_hash(&nodes[1], route.clone(), &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_3);
4559 send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_4);
4562 let (_, payment_hash_5) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4564 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();
4565 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
4568 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
4570 let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4571 send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_6);
4573 // Double-check that six of the new HTLC were added
4574 // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
4575 // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
4576 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);
4577 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);
4579 // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
4580 // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
4581 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1));
4582 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3));
4583 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5));
4584 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6));
4585 check_added_monitors!(nodes[4], 0);
4586 expect_pending_htlcs_forwardable!(nodes[4]);
4587 check_added_monitors!(nodes[4], 1);
4589 let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
4590 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
4591 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
4592 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
4593 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
4594 commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
4596 // Fail 3rd below-dust and 7th above-dust HTLCs
4597 assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2));
4598 assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4));
4599 check_added_monitors!(nodes[5], 0);
4600 expect_pending_htlcs_forwardable!(nodes[5]);
4601 check_added_monitors!(nodes[5], 1);
4603 let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
4604 nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
4605 nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
4606 commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
4608 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();
4610 expect_pending_htlcs_forwardable!(nodes[3]);
4611 check_added_monitors!(nodes[3], 1);
4612 let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
4613 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
4614 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
4615 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
4616 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
4617 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
4618 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
4619 if deliver_last_raa {
4620 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
4622 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
4625 // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
4626 // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
4627 // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
4628 // propagated back to A/B yet (and D has two unrevoked commitment transactions).
4630 // We now broadcast the latest commitment transaction, which *should* result in failures for
4631 // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
4632 // the non-broadcast above-dust HTLCs.
4634 // Alternatively, we may broadcast the previous commitment transaction, which should only
4635 // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
4636 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();
4638 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4639 if announce_latest {
4640 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![ds_last_commitment_tx[0].clone()]}, 1);
4642 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![ds_prev_commitment_tx[0].clone()]}, 1);
4644 connect_blocks(&nodes[2].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4645 check_closed_broadcast!(nodes[2], false);
4646 expect_pending_htlcs_forwardable!(nodes[2]);
4647 check_added_monitors!(nodes[2], 2);
4649 let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
4650 assert_eq!(cs_msgs.len(), 2);
4651 let mut a_done = false;
4652 for msg in cs_msgs {
4654 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
4655 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
4656 // should be failed-backwards here.
4657 let target = if *node_id == nodes[0].node.get_our_node_id() {
4658 // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
4659 for htlc in &updates.update_fail_htlcs {
4660 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 });
4662 assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
4667 // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
4668 for htlc in &updates.update_fail_htlcs {
4669 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
4671 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
4672 assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
4675 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
4676 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
4677 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
4678 if announce_latest {
4679 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
4680 if *node_id == nodes[0].node.get_our_node_id() {
4681 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
4684 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
4686 _ => panic!("Unexpected event"),
4690 let as_events = nodes[0].node.get_and_clear_pending_events();
4691 assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
4692 let mut as_failds = HashSet::new();
4693 for event in as_events.iter() {
4694 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
4695 assert!(as_failds.insert(*payment_hash));
4696 if *payment_hash != payment_hash_2 {
4697 assert_eq!(*rejected_by_dest, deliver_last_raa);
4699 assert!(!rejected_by_dest);
4701 } else { panic!("Unexpected event"); }
4703 assert!(as_failds.contains(&payment_hash_1));
4704 assert!(as_failds.contains(&payment_hash_2));
4705 if announce_latest {
4706 assert!(as_failds.contains(&payment_hash_3));
4707 assert!(as_failds.contains(&payment_hash_5));
4709 assert!(as_failds.contains(&payment_hash_6));
4711 let bs_events = nodes[1].node.get_and_clear_pending_events();
4712 assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
4713 let mut bs_failds = HashSet::new();
4714 for event in bs_events.iter() {
4715 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
4716 assert!(bs_failds.insert(*payment_hash));
4717 if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
4718 assert_eq!(*rejected_by_dest, deliver_last_raa);
4720 assert!(!rejected_by_dest);
4722 } else { panic!("Unexpected event"); }
4724 assert!(bs_failds.contains(&payment_hash_1));
4725 assert!(bs_failds.contains(&payment_hash_2));
4726 if announce_latest {
4727 assert!(bs_failds.contains(&payment_hash_4));
4729 assert!(bs_failds.contains(&payment_hash_5));
4731 // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
4732 // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
4733 // to unknown-preimage-etc, B should have gotten 2. Thus, in the
4734 // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
4735 // PaymentFailureNetworkUpdates.
4736 let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4737 assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
4738 let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
4739 assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
4740 for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
4742 &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
4743 _ => panic!("Unexpected event"),
4749 fn test_fail_backwards_latest_remote_announce_a() {
4750 do_test_fail_backwards_unrevoked_remote_announce(false, true);
4754 fn test_fail_backwards_latest_remote_announce_b() {
4755 do_test_fail_backwards_unrevoked_remote_announce(true, true);
4759 fn test_fail_backwards_previous_remote_announce() {
4760 do_test_fail_backwards_unrevoked_remote_announce(false, false);
4761 // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
4762 // tested for in test_commitment_revoked_fail_backward_exhaustive()
4766 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
4767 let chanmon_cfgs = create_chanmon_cfgs(2);
4768 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4769 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4770 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4772 // Create some initial channels
4773 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4775 route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
4776 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();
4777 assert_eq!(local_txn[0].input.len(), 1);
4778 check_spends!(local_txn[0], chan_1.3);
4780 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
4781 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4782 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![local_txn[0].clone()] }, 200);
4783 check_closed_broadcast!(nodes[0], false);
4785 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4786 assert_eq!(node_txn[0].input.len(), 1);
4787 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4788 check_spends!(node_txn[0], local_txn[0]);
4790 // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
4791 let spend_txn = check_spendable_outputs!(nodes[0], 1);
4792 assert_eq!(spend_txn.len(), 8);
4793 assert_eq!(spend_txn[0], spend_txn[2]);
4794 assert_eq!(spend_txn[0], spend_txn[4]);
4795 assert_eq!(spend_txn[0], spend_txn[6]);
4796 assert_eq!(spend_txn[1], spend_txn[3]);
4797 assert_eq!(spend_txn[1], spend_txn[5]);
4798 assert_eq!(spend_txn[1], spend_txn[7]);
4799 check_spends!(spend_txn[0], local_txn[0]);
4800 check_spends!(spend_txn[1], node_txn[0]);
4804 fn test_static_output_closing_tx() {
4805 let chanmon_cfgs = create_chanmon_cfgs(2);
4806 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4807 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4808 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4810 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4812 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
4813 let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
4815 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4816 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![closing_tx.clone()] }, 1);
4817 let spend_txn = check_spendable_outputs!(nodes[0], 2);
4818 assert_eq!(spend_txn.len(), 1);
4819 check_spends!(spend_txn[0], closing_tx);
4821 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![closing_tx.clone()] }, 1);
4822 let spend_txn = check_spendable_outputs!(nodes[1], 2);
4823 assert_eq!(spend_txn.len(), 1);
4824 check_spends!(spend_txn[0], closing_tx);
4827 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
4828 let chanmon_cfgs = create_chanmon_cfgs(2);
4829 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4830 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4831 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4832 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4834 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
4836 // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
4837 // present in B's local commitment transaction, but none of A's commitment transactions.
4838 assert!(nodes[1].node.claim_funds(our_payment_preimage, if use_dust { 50_000 } else { 3_000_000 }));
4839 check_added_monitors!(nodes[1], 1);
4841 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4842 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
4843 let events = nodes[0].node.get_and_clear_pending_events();
4844 assert_eq!(events.len(), 1);
4846 Event::PaymentSent { payment_preimage } => {
4847 assert_eq!(payment_preimage, our_payment_preimage);
4849 _ => panic!("Unexpected event"),
4852 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
4853 check_added_monitors!(nodes[0], 1);
4854 let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4855 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
4856 check_added_monitors!(nodes[1], 1);
4858 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4859 for i in 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + CHAN_CONFIRM_DEPTH + 1 {
4860 nodes[1].block_notifier.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
4861 header.prev_blockhash = header.bitcoin_hash();
4863 test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
4864 check_closed_broadcast!(nodes[1], false);
4867 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
4868 let chanmon_cfgs = create_chanmon_cfgs(2);
4869 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4870 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4871 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4872 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4874 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();
4875 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
4876 nodes[0].node.send_payment(route, payment_hash).unwrap();
4877 check_added_monitors!(nodes[0], 1);
4879 let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4881 // As far as A is concerned, the HTLC is now present only in the latest remote commitment
4882 // transaction, however it is not in A's latest local commitment, so we can just broadcast that
4883 // to "time out" the HTLC.
4885 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4887 for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
4888 nodes[0].block_notifier.block_connected(&Block { header, txdata: Vec::new()}, i);
4889 header.prev_blockhash = header.bitcoin_hash();
4891 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
4892 check_closed_broadcast!(nodes[0], false);
4895 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
4896 let chanmon_cfgs = create_chanmon_cfgs(3);
4897 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4898 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4899 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4900 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4902 // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
4903 // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
4904 // Also optionally test that we *don't* fail the channel in case the commitment transaction was
4905 // actually revoked.
4906 let htlc_value = if use_dust { 50000 } else { 3000000 };
4907 let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
4908 assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash));
4909 expect_pending_htlcs_forwardable!(nodes[1]);
4910 check_added_monitors!(nodes[1], 1);
4912 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4913 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
4914 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
4915 check_added_monitors!(nodes[0], 1);
4916 let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4917 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
4918 check_added_monitors!(nodes[1], 1);
4919 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
4920 check_added_monitors!(nodes[1], 1);
4921 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4923 if check_revoke_no_close {
4924 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
4925 check_added_monitors!(nodes[0], 1);
4928 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4929 for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
4930 nodes[0].block_notifier.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
4931 header.prev_blockhash = header.bitcoin_hash();
4933 if !check_revoke_no_close {
4934 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
4935 check_closed_broadcast!(nodes[0], false);
4937 let events = nodes[0].node.get_and_clear_pending_events();
4938 assert_eq!(events.len(), 1);
4940 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
4941 assert_eq!(payment_hash, our_payment_hash);
4942 assert!(rejected_by_dest);
4944 _ => panic!("Unexpected event"),
4949 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
4950 // There are only a few cases to test here:
4951 // * its not really normative behavior, but we test that below-dust HTLCs "included" in
4952 // broadcastable commitment transactions result in channel closure,
4953 // * its included in an unrevoked-but-previous remote commitment transaction,
4954 // * its included in the latest remote or local commitment transactions.
4955 // We test each of the three possible commitment transactions individually and use both dust and
4957 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
4958 // assume they are handled the same across all six cases, as both outbound and inbound failures are
4959 // tested for at least one of the cases in other tests.
4961 fn htlc_claim_single_commitment_only_a() {
4962 do_htlc_claim_local_commitment_only(true);
4963 do_htlc_claim_local_commitment_only(false);
4965 do_htlc_claim_current_remote_commitment_only(true);
4966 do_htlc_claim_current_remote_commitment_only(false);
4970 fn htlc_claim_single_commitment_only_b() {
4971 do_htlc_claim_previous_remote_commitment_only(true, false);
4972 do_htlc_claim_previous_remote_commitment_only(false, false);
4973 do_htlc_claim_previous_remote_commitment_only(true, true);
4974 do_htlc_claim_previous_remote_commitment_only(false, true);
4977 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>)
4978 where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
4981 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);
4985 // 0: node1 fails backward
4986 // 1: final node fails backward
4987 // 2: payment completed but the user rejects the payment
4988 // 3: final node fails backward (but tamper onion payloads from node0)
4989 // 100: trigger error in the intermediate node and tamper returning fail_htlc
4990 // 200: trigger error in the final node and tamper returning fail_htlc
4991 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>)
4992 where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
4993 F2: for <'a> FnMut(&'a mut msgs::UpdateFailHTLC),
4997 // reset block height
4998 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4999 for ix in 0..nodes.len() {
5000 nodes[ix].block_notifier.block_connected_checked(&header, 1, &[], &[]);
5003 macro_rules! expect_event {
5004 ($node: expr, $event_type: path) => {{
5005 let events = $node.node.get_and_clear_pending_events();
5006 assert_eq!(events.len(), 1);
5008 $event_type { .. } => {},
5009 _ => panic!("Unexpected event"),
5014 macro_rules! expect_htlc_forward {
5016 expect_event!($node, Event::PendingHTLCsForwardable);
5017 $node.node.process_pending_htlc_forwards();
5021 // 0 ~~> 2 send payment
5022 nodes[0].node.send_payment(route.clone(), payment_hash.clone()).unwrap();
5023 check_added_monitors!(nodes[0], 1);
5024 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5025 // temper update_add (0 => 1)
5026 let mut update_add_0 = update_0.update_add_htlcs[0].clone();
5027 if test_case == 0 || test_case == 3 || test_case == 100 {
5028 callback_msg(&mut update_add_0);
5031 // 0 => 1 update_add & CS
5032 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0);
5033 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
5035 let update_1_0 = match test_case {
5036 0|100 => { // intermediate node failure; fail backward to 0
5037 let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5038 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));
5041 1|2|3|200 => { // final node failure; forwarding to 2
5042 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
5044 if test_case != 200 {
5047 expect_htlc_forward!(&nodes[1]);
5049 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
5050 check_added_monitors!(&nodes[1], 1);
5051 assert_eq!(update_1.update_add_htlcs.len(), 1);
5052 // tamper update_add (1 => 2)
5053 let mut update_add_1 = update_1.update_add_htlcs[0].clone();
5054 if test_case != 3 && test_case != 200 {
5055 callback_msg(&mut update_add_1);
5059 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1);
5060 commitment_signed_dance!(nodes[2], nodes[1], update_1.commitment_signed, false, true);
5062 if test_case == 2 || test_case == 200 {
5063 expect_htlc_forward!(&nodes[2]);
5064 expect_event!(&nodes[2], Event::PaymentReceived);
5066 expect_pending_htlcs_forwardable!(nodes[2]);
5069 let update_2_1 = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5070 if test_case == 2 || test_case == 200 {
5071 check_added_monitors!(&nodes[2], 1);
5073 assert!(update_2_1.update_fail_htlcs.len() == 1);
5075 let mut fail_msg = update_2_1.update_fail_htlcs[0].clone();
5076 if test_case == 200 {
5077 callback_fail(&mut fail_msg);
5081 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &fail_msg);
5082 commitment_signed_dance!(nodes[1], nodes[2], update_2_1.commitment_signed, true);
5084 // backward fail on 1
5085 let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5086 assert!(update_1_0.update_fail_htlcs.len() == 1);
5089 _ => unreachable!(),
5092 // 1 => 0 commitment_signed_dance
5093 if update_1_0.update_fail_htlcs.len() > 0 {
5094 let mut fail_msg = update_1_0.update_fail_htlcs[0].clone();
5095 if test_case == 100 {
5096 callback_fail(&mut fail_msg);
5098 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
5100 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_1_0.update_fail_malformed_htlcs[0]);
5103 commitment_signed_dance!(nodes[0], nodes[1], update_1_0.commitment_signed, false, true);
5105 let events = nodes[0].node.get_and_clear_pending_events();
5106 assert_eq!(events.len(), 1);
5107 if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code } = &events[0] {
5108 assert_eq!(*rejected_by_dest, !expected_retryable);
5109 assert_eq!(*error_code, expected_error_code);
5111 panic!("Uexpected event");
5114 let events = nodes[0].node.get_and_clear_pending_msg_events();
5115 if expected_channel_update.is_some() {
5116 assert_eq!(events.len(), 1);
5118 MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
5120 &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {
5121 if let HTLCFailChannelUpdate::ChannelUpdateMessage { .. } = expected_channel_update.unwrap() {} else {
5122 panic!("channel_update not found!");
5125 &HTLCFailChannelUpdate::ChannelClosed { ref short_channel_id, ref is_permanent } => {
5126 if let HTLCFailChannelUpdate::ChannelClosed { short_channel_id: ref expected_short_channel_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
5127 assert!(*short_channel_id == *expected_short_channel_id);
5128 assert!(*is_permanent == *expected_is_permanent);
5130 panic!("Unexpected message event");
5133 &HTLCFailChannelUpdate::NodeFailure { ref node_id, ref is_permanent } => {
5134 if let HTLCFailChannelUpdate::NodeFailure { node_id: ref expected_node_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
5135 assert!(*node_id == *expected_node_id);
5136 assert!(*is_permanent == *expected_is_permanent);
5138 panic!("Unexpected message event");
5143 _ => panic!("Unexpected message event"),
5146 assert_eq!(events.len(), 0);
5150 impl msgs::ChannelUpdate {
5151 fn dummy() -> msgs::ChannelUpdate {
5152 use secp256k1::ffi::Signature as FFISignature;
5153 use secp256k1::Signature;
5154 msgs::ChannelUpdate {
5155 signature: Signature::from(FFISignature::new()),
5156 contents: msgs::UnsignedChannelUpdate {
5157 chain_hash: Sha256dHash::hash(&vec![0u8][..]),
5158 short_channel_id: 0,
5161 cltv_expiry_delta: 0,
5162 htlc_minimum_msat: 0,
5164 fee_proportional_millionths: 0,
5165 excess_data: vec![],
5171 struct BogusOnionHopData {
5174 impl BogusOnionHopData {
5175 fn new(orig: msgs::OnionHopData) -> Self {
5176 Self { data: orig.encode() }
5179 impl Writeable for BogusOnionHopData {
5180 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
5181 writer.write_all(&self.data[..])
5186 fn test_onion_failure() {
5187 use ln::msgs::ChannelUpdate;
5188 use ln::channelmanager::CLTV_FAR_FAR_AWAY;
5191 const BADONION: u16 = 0x8000;
5192 const PERM: u16 = 0x4000;
5193 const NODE: u16 = 0x2000;
5194 const UPDATE: u16 = 0x1000;
5196 let chanmon_cfgs = create_chanmon_cfgs(3);
5197 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5198 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5199 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5200 for node in nodes.iter() {
5201 *node.keys_manager.override_session_priv.lock().unwrap() = Some(SecretKey::from_slice(&[3; 32]).unwrap());
5203 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())];
5204 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
5205 let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV).unwrap();
5207 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 40000, 40_000);
5209 // intermediate node failure
5210 run_onion_failure_test("invalid_realm", 0, &nodes, &route, &payment_hash, |msg| {
5211 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5212 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5213 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5214 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
5215 let mut new_payloads = Vec::new();
5216 for payload in onion_payloads.drain(..) {
5217 new_payloads.push(BogusOnionHopData::new(payload));
5219 // break the first (non-final) hop payload by swapping the realm (0) byte for a byte
5220 // describing a length-1 TLV payload, which is obviously bogus.
5221 new_payloads[0].data[0] = 1;
5222 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
5223 }, ||{}, 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
5225 // final node failure
5226 run_onion_failure_test("invalid_realm", 3, &nodes, &route, &payment_hash, |msg| {
5227 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5228 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5229 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5230 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
5231 let mut new_payloads = Vec::new();
5232 for payload in onion_payloads.drain(..) {
5233 new_payloads.push(BogusOnionHopData::new(payload));
5235 // break the last-hop payload by swapping the realm (0) byte for a byte describing a
5236 // length-1 TLV payload, which is obviously bogus.
5237 new_payloads[1].data[0] = 1;
5238 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
5239 }, ||{}, false, Some(PERM|22), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
5241 // the following three with run_onion_failure_test_with_fail_intercept() test only the origin node
5242 // receiving simulated fail messages
5243 // intermediate node failure
5244 run_onion_failure_test_with_fail_intercept("temporary_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
5246 msg.amount_msat -= 1;
5248 // and tamper returning error message
5249 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5250 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5251 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], NODE|2, &[0;0]);
5252 }, ||{}, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: false}));
5254 // final node failure
5255 run_onion_failure_test_with_fail_intercept("temporary_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
5256 // and tamper returning error message
5257 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5258 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5259 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], NODE|2, &[0;0]);
5261 nodes[2].node.fail_htlc_backwards(&payment_hash);
5262 }, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: false}));
5264 // intermediate node failure
5265 run_onion_failure_test_with_fail_intercept("permanent_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
5266 msg.amount_msat -= 1;
5268 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5269 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5270 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|2, &[0;0]);
5271 }, ||{}, true, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: true}));
5273 // final node failure
5274 run_onion_failure_test_with_fail_intercept("permanent_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
5275 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5276 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5277 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|2, &[0;0]);
5279 nodes[2].node.fail_htlc_backwards(&payment_hash);
5280 }, false, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: true}));
5282 // intermediate node failure
5283 run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
5284 msg.amount_msat -= 1;
5286 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5287 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5288 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|3, &[0;0]);
5290 nodes[2].node.fail_htlc_backwards(&payment_hash);
5291 }, true, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: true}));
5293 // final node failure
5294 run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
5295 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5296 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5297 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|3, &[0;0]);
5299 nodes[2].node.fail_htlc_backwards(&payment_hash);
5300 }, false, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: true}));
5302 run_onion_failure_test("invalid_onion_version", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.version = 1; }, ||{}, true,
5303 Some(BADONION|PERM|4), None);
5305 run_onion_failure_test("invalid_onion_hmac", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.hmac = [3; 32]; }, ||{}, true,
5306 Some(BADONION|PERM|5), None);
5308 run_onion_failure_test("invalid_onion_key", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.public_key = Err(secp256k1::Error::InvalidPublicKey);}, ||{}, true,
5309 Some(BADONION|PERM|6), None);
5311 run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
5312 msg.amount_msat -= 1;
5314 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5315 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5316 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], UPDATE|7, &ChannelUpdate::dummy().encode_with_len()[..]);
5317 }, ||{}, true, Some(UPDATE|7), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5319 run_onion_failure_test_with_fail_intercept("permanent_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
5320 msg.amount_msat -= 1;
5322 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5323 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5324 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|8, &[0;0]);
5325 // short_channel_id from the processing node
5326 }, ||{}, true, Some(PERM|8), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
5328 run_onion_failure_test_with_fail_intercept("required_channel_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
5329 msg.amount_msat -= 1;
5331 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5332 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5333 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|9, &[0;0]);
5334 // short_channel_id from the processing node
5335 }, ||{}, true, Some(PERM|9), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
5337 let mut bogus_route = route.clone();
5338 bogus_route.hops[1].short_channel_id -= 1;
5339 run_onion_failure_test("unknown_next_peer", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(PERM|10),
5340 Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: bogus_route.hops[1].short_channel_id, is_permanent:true}));
5342 let amt_to_forward = nodes[1].node.channel_state.lock().unwrap().by_id.get(&channels[1].2).unwrap().get_their_htlc_minimum_msat() - 1;
5343 let mut bogus_route = route.clone();
5344 let route_len = bogus_route.hops.len();
5345 bogus_route.hops[route_len-1].fee_msat = amt_to_forward;
5346 run_onion_failure_test("amount_below_minimum", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(UPDATE|11), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5348 //TODO: with new config API, we will be able to generate both valid and
5349 //invalid channel_update cases.
5350 run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, |msg| {
5351 msg.amount_msat -= 1;
5352 }, || {}, true, Some(UPDATE|12), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
5354 run_onion_failure_test("incorrect_cltv_expiry", 0, &nodes, &route, &payment_hash, |msg| {
5355 // need to violate: cltv_expiry - cltv_expiry_delta >= outgoing_cltv_value
5356 msg.cltv_expiry -= 1;
5357 }, || {}, true, Some(UPDATE|13), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
5359 run_onion_failure_test("expiry_too_soon", 0, &nodes, &route, &payment_hash, |msg| {
5360 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
5361 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5363 nodes[1].block_notifier.block_connected_checked(&header, height, &[], &[]);
5364 }, ||{}, true, Some(UPDATE|14), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5366 run_onion_failure_test("unknown_payment_hash", 2, &nodes, &route, &payment_hash, |_| {}, || {
5367 nodes[2].node.fail_htlc_backwards(&payment_hash);
5368 }, false, Some(PERM|15), None);
5370 run_onion_failure_test("final_expiry_too_soon", 1, &nodes, &route, &payment_hash, |msg| {
5371 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
5372 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5374 nodes[2].block_notifier.block_connected_checked(&header, height, &[], &[]);
5375 }, || {}, true, Some(17), None);
5377 run_onion_failure_test("final_incorrect_cltv_expiry", 1, &nodes, &route, &payment_hash, |_| {}, || {
5378 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
5379 for f in pending_forwards.iter_mut() {
5381 &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
5382 forward_info.outgoing_cltv_value += 1,
5387 }, true, Some(18), None);
5389 run_onion_failure_test("final_incorrect_htlc_amount", 1, &nodes, &route, &payment_hash, |_| {}, || {
5390 // violate amt_to_forward > msg.amount_msat
5391 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
5392 for f in pending_forwards.iter_mut() {
5394 &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
5395 forward_info.amt_to_forward -= 1,
5400 }, true, Some(19), None);
5402 run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, |_| {}, || {
5403 // disconnect event to the channel between nodes[1] ~ nodes[2]
5404 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
5405 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5406 }, true, Some(UPDATE|20), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5407 reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
5409 run_onion_failure_test("expiry_too_far", 0, &nodes, &route, &payment_hash, |msg| {
5410 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5411 let mut route = route.clone();
5413 route.hops[1].cltv_expiry_delta += CLTV_FAR_FAR_AWAY + route.hops[0].cltv_expiry_delta + 1;
5414 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5415 let (onion_payloads, _, htlc_cltv) = onion_utils::build_onion_payloads(&route, height).unwrap();
5416 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
5417 msg.cltv_expiry = htlc_cltv;
5418 msg.onion_routing_packet = onion_packet;
5419 }, ||{}, true, Some(21), None);
5424 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
5425 let chanmon_cfgs = create_chanmon_cfgs(2);
5426 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5427 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5428 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5429 //Force duplicate channel ids
5430 for node in nodes.iter() {
5431 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
5434 // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
5435 let channel_value_satoshis=10000;
5436 let push_msat=10001;
5437 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
5438 let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5439 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::supported(), &node0_to_1_send_open_channel);
5441 //Create a second channel with a channel_id collision
5442 assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5446 fn bolt2_open_channel_sending_node_checks_part2() {
5447 let chanmon_cfgs = create_chanmon_cfgs(2);
5448 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5449 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5450 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5452 // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
5453 let channel_value_satoshis=2^24;
5454 let push_msat=10001;
5455 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5457 // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
5458 let channel_value_satoshis=10000;
5459 // Test when push_msat is equal to 1000 * funding_satoshis.
5460 let push_msat=1000*channel_value_satoshis+1;
5461 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5463 // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
5464 let channel_value_satoshis=10000;
5465 let push_msat=10001;
5466 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_ok()); //Create a valid channel
5467 let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5468 assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
5470 // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
5471 // 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
5472 assert!(node0_to_1_send_open_channel.channel_flags<=1);
5474 // 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.
5475 assert!(BREAKDOWN_TIMEOUT>0);
5476 assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
5478 // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
5479 let chain_hash=genesis_block(Network::Testnet).header.bitcoin_hash();
5480 assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
5482 // 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.
5483 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
5484 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
5485 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
5486 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_basepoint.serialize()).is_ok());
5487 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
5490 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
5491 // 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.
5492 //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.
5495 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
5496 //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
5497 let chanmon_cfgs = create_chanmon_cfgs(2);
5498 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5499 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5500 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5501 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5502 let mut route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5503 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5505 route.hops[0].fee_msat = 100;
5507 let err = nodes[0].node.send_payment(route, our_payment_hash);
5509 if let Err(APIError::ChannelUnavailable{err}) = err {
5510 assert_eq!(err, "Cannot send less than their minimum HTLC value");
5514 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5515 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
5519 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
5520 //BOLT2 Requirement: MUST offer amount_msat greater than 0.
5521 let chanmon_cfgs = create_chanmon_cfgs(2);
5522 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5523 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5524 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5525 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5526 let mut route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5527 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5529 route.hops[0].fee_msat = 0;
5531 let err = nodes[0].node.send_payment(route, our_payment_hash);
5533 if let Err(APIError::ChannelUnavailable{err}) = err {
5534 assert_eq!(err, "Cannot send 0-msat HTLC");
5538 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5539 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
5543 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
5544 //BOLT2 Requirement: MUST offer amount_msat greater than 0.
5545 let chanmon_cfgs = create_chanmon_cfgs(2);
5546 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5547 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5548 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5549 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5550 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5551 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5553 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5554 check_added_monitors!(nodes[0], 1);
5555 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5556 updates.update_add_htlcs[0].amount_msat = 0;
5558 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5559 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
5560 check_closed_broadcast!(nodes[1], true).unwrap();
5564 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
5565 //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
5566 //It is enforced when constructing a route.
5567 let chanmon_cfgs = create_chanmon_cfgs(2);
5568 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5569 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5570 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5571 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 0, InitFeatures::supported(), InitFeatures::supported());
5572 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000000, 500000001).unwrap();
5573 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5575 let err = nodes[0].node.send_payment(route, our_payment_hash);
5577 if let Err(APIError::RouteError{err}) = err {
5578 assert_eq!(err, "Channel CLTV overflowed?!");
5585 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
5586 //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.
5587 //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
5588 //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
5589 let chanmon_cfgs = create_chanmon_cfgs(2);
5590 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5591 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5592 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5593 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::supported(), InitFeatures::supported());
5594 let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().their_max_accepted_htlcs as u64;
5596 for i in 0..max_accepted_htlcs {
5597 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5598 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5599 let payment_event = {
5600 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5601 check_added_monitors!(nodes[0], 1);
5603 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5604 assert_eq!(events.len(), 1);
5605 if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
5606 assert_eq!(htlcs[0].htlc_id, i);
5610 SendEvent::from_event(events.remove(0))
5612 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
5613 check_added_monitors!(nodes[1], 0);
5614 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
5616 expect_pending_htlcs_forwardable!(nodes[1]);
5617 expect_payment_received!(nodes[1], our_payment_hash, 100000);
5619 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5620 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5621 let err = nodes[0].node.send_payment(route, our_payment_hash);
5623 if let Err(APIError::ChannelUnavailable{err}) = err {
5624 assert_eq!(err, "Cannot push more than their max accepted HTLCs");
5628 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5629 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
5633 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
5634 //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.
5635 let chanmon_cfgs = create_chanmon_cfgs(2);
5636 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5637 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5638 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5639 let channel_value = 100000;
5640 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::supported(), InitFeatures::supported());
5641 let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).their_max_htlc_value_in_flight_msat;
5643 send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight, max_in_flight);
5645 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], max_in_flight+1, TEST_FINAL_CLTV).unwrap();
5646 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5647 let err = nodes[0].node.send_payment(route, our_payment_hash);
5649 if let Err(APIError::ChannelUnavailable{err}) = err {
5650 assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight our peer will accept");
5654 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5655 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);
5657 send_payment(&nodes[0], &[&nodes[1]], max_in_flight, max_in_flight);
5660 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
5662 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
5663 //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
5664 let chanmon_cfgs = create_chanmon_cfgs(2);
5665 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5666 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5667 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5668 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5669 let htlc_minimum_msat: u64;
5671 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
5672 let channel = chan_lock.by_id.get(&chan.2).unwrap();
5673 htlc_minimum_msat = channel.get_our_htlc_minimum_msat();
5675 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], htlc_minimum_msat, TEST_FINAL_CLTV).unwrap();
5676 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5677 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5678 check_added_monitors!(nodes[0], 1);
5679 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5680 updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
5681 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5682 assert!(nodes[1].node.list_channels().is_empty());
5683 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5684 assert_eq!(err_msg.data, "Remote side tried to send less than our minimum HTLC value");
5688 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
5689 //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
5690 let chanmon_cfgs = create_chanmon_cfgs(2);
5691 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5692 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5693 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5694 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5696 let their_channel_reserve = get_channel_value_stat!(nodes[0], chan.2).channel_reserve_msat;
5698 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 5000000-their_channel_reserve, TEST_FINAL_CLTV).unwrap();
5699 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5700 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5701 check_added_monitors!(nodes[0], 1);
5702 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5704 updates.update_add_htlcs[0].amount_msat = 5000000-their_channel_reserve+1;
5705 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5707 assert!(nodes[1].node.list_channels().is_empty());
5708 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5709 assert_eq!(err_msg.data, "Remote HTLC add would put them over their reserve value");
5713 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
5714 //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
5715 //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
5716 let chanmon_cfgs = create_chanmon_cfgs(2);
5717 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5718 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5719 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5720 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5721 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 3999999, TEST_FINAL_CLTV).unwrap();
5722 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5724 let session_priv = SecretKey::from_slice(&{
5725 let mut session_key = [0; 32];
5726 let mut rng = thread_rng();
5727 rng.fill_bytes(&mut session_key);
5729 }).expect("RNG is bad!");
5731 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5732 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route, &session_priv).unwrap();
5733 let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
5734 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
5736 let mut msg = msgs::UpdateAddHTLC {
5740 payment_hash: our_payment_hash,
5741 cltv_expiry: htlc_cltv,
5742 onion_routing_packet: onion_packet.clone(),
5745 for i in 0..super::channel::OUR_MAX_HTLCS {
5746 msg.htlc_id = i as u64;
5747 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
5749 msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
5750 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
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 tried to push more than our max accepted HTLCs");
5758 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
5759 //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
5760 let chanmon_cfgs = create_chanmon_cfgs(2);
5761 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5762 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5763 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5764 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
5765 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5766 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5767 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5768 check_added_monitors!(nodes[0], 1);
5769 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5770 updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).their_max_htlc_value_in_flight_msat + 1;
5771 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5773 assert!(nodes[1].node.list_channels().is_empty());
5774 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5775 assert_eq!(err_msg.data,"Remote HTLC add would put them over our max HTLC value");
5779 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
5780 //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
5781 let chanmon_cfgs = create_chanmon_cfgs(2);
5782 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5783 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5784 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5785 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5786 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 3999999, TEST_FINAL_CLTV).unwrap();
5787 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5788 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5789 check_added_monitors!(nodes[0], 1);
5790 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5791 updates.update_add_htlcs[0].cltv_expiry = 500000000;
5792 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5794 assert!(nodes[1].node.list_channels().is_empty());
5795 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5796 assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
5800 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
5801 //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
5802 // We test this by first testing that that repeated HTLCs pass commitment signature checks
5803 // after disconnect and that non-sequential htlc_ids result in a channel failure.
5804 let chanmon_cfgs = create_chanmon_cfgs(2);
5805 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5806 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5807 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5808 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5809 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5810 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5811 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5812 check_added_monitors!(nodes[0], 1);
5813 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5814 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5816 //Disconnect and Reconnect
5817 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5818 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5819 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
5820 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
5821 assert_eq!(reestablish_1.len(), 1);
5822 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
5823 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
5824 assert_eq!(reestablish_2.len(), 1);
5825 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
5826 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
5827 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
5828 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
5831 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5832 assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
5833 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
5834 check_added_monitors!(nodes[1], 1);
5835 let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5837 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5839 assert!(nodes[1].node.list_channels().is_empty());
5840 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5841 assert_eq!(err_msg.data, "Remote skipped HTLC ID");
5845 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
5846 //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.
5848 let chanmon_cfgs = create_chanmon_cfgs(2);
5849 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5850 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5851 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5852 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5854 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5855 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5856 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5857 check_added_monitors!(nodes[0], 1);
5858 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5859 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5861 let update_msg = msgs::UpdateFulfillHTLC{
5864 payment_preimage: our_payment_preimage,
5867 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5869 assert!(nodes[0].node.list_channels().is_empty());
5870 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5871 assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
5875 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
5876 //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.
5878 let chanmon_cfgs = create_chanmon_cfgs(2);
5879 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5880 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5881 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5882 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5884 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5885 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5886 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5887 check_added_monitors!(nodes[0], 1);
5888 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5889 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5891 let update_msg = msgs::UpdateFailHTLC{
5894 reason: msgs::OnionErrorPacket { data: Vec::new()},
5897 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5899 assert!(nodes[0].node.list_channels().is_empty());
5900 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5901 assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
5905 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
5906 //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.
5908 let chanmon_cfgs = create_chanmon_cfgs(2);
5909 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5910 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5911 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5912 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5914 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5915 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5916 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5917 check_added_monitors!(nodes[0], 1);
5918 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5919 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5921 let update_msg = msgs::UpdateFailMalformedHTLC{
5924 sha256_of_onion: [1; 32],
5925 failure_code: 0x8000,
5928 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5930 assert!(nodes[0].node.list_channels().is_empty());
5931 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5932 assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
5936 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
5937 //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
5939 let chanmon_cfgs = create_chanmon_cfgs(2);
5940 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5941 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5942 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5943 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5945 let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
5947 nodes[1].node.claim_funds(our_payment_preimage, 100_000);
5948 check_added_monitors!(nodes[1], 1);
5950 let events = nodes[1].node.get_and_clear_pending_msg_events();
5951 assert_eq!(events.len(), 1);
5952 let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
5954 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, .. } } => {
5955 assert!(update_add_htlcs.is_empty());
5956 assert_eq!(update_fulfill_htlcs.len(), 1);
5957 assert!(update_fail_htlcs.is_empty());
5958 assert!(update_fail_malformed_htlcs.is_empty());
5959 assert!(update_fee.is_none());
5960 update_fulfill_htlcs[0].clone()
5962 _ => panic!("Unexpected event"),
5966 update_fulfill_msg.htlc_id = 1;
5968 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
5970 assert!(nodes[0].node.list_channels().is_empty());
5971 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5972 assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
5976 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
5977 //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.
5979 let chanmon_cfgs = create_chanmon_cfgs(2);
5980 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5981 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5982 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5983 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5985 let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
5987 nodes[1].node.claim_funds(our_payment_preimage, 100_000);
5988 check_added_monitors!(nodes[1], 1);
5990 let events = nodes[1].node.get_and_clear_pending_msg_events();
5991 assert_eq!(events.len(), 1);
5992 let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
5994 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, .. } } => {
5995 assert!(update_add_htlcs.is_empty());
5996 assert_eq!(update_fulfill_htlcs.len(), 1);
5997 assert!(update_fail_htlcs.is_empty());
5998 assert!(update_fail_malformed_htlcs.is_empty());
5999 assert!(update_fee.is_none());
6000 update_fulfill_htlcs[0].clone()
6002 _ => panic!("Unexpected event"),
6006 update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
6008 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6010 assert!(nodes[0].node.list_channels().is_empty());
6011 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6012 assert_eq!(err_msg.data, "Remote tried to fulfill HTLC with an incorrect preimage");
6017 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
6018 //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.
6020 let chanmon_cfgs = create_chanmon_cfgs(2);
6021 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6022 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6023 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6024 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
6025 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
6026 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6027 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
6028 check_added_monitors!(nodes[0], 1);
6030 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6031 updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6033 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6034 check_added_monitors!(nodes[1], 0);
6035 commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
6037 let events = nodes[1].node.get_and_clear_pending_msg_events();
6039 let mut update_msg: msgs::UpdateFailMalformedHTLC = {
6041 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, .. } } => {
6042 assert!(update_add_htlcs.is_empty());
6043 assert!(update_fulfill_htlcs.is_empty());
6044 assert!(update_fail_htlcs.is_empty());
6045 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6046 assert!(update_fee.is_none());
6047 update_fail_malformed_htlcs[0].clone()
6049 _ => panic!("Unexpected event"),
6052 update_msg.failure_code &= !0x8000;
6053 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6055 assert!(nodes[0].node.list_channels().is_empty());
6056 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6057 assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
6061 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
6062 //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
6063 // * 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.
6065 let chanmon_cfgs = create_chanmon_cfgs(3);
6066 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6067 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6068 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6069 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
6070 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
6072 let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
6073 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6076 let mut payment_event = {
6077 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
6078 check_added_monitors!(nodes[0], 1);
6079 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6080 assert_eq!(events.len(), 1);
6081 SendEvent::from_event(events.remove(0))
6083 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6084 check_added_monitors!(nodes[1], 0);
6085 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6086 expect_pending_htlcs_forwardable!(nodes[1]);
6087 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
6088 assert_eq!(events_2.len(), 1);
6089 check_added_monitors!(nodes[1], 1);
6090 payment_event = SendEvent::from_event(events_2.remove(0));
6091 assert_eq!(payment_event.msgs.len(), 1);
6094 payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6095 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
6096 check_added_monitors!(nodes[2], 0);
6097 commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
6099 let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
6100 assert_eq!(events_3.len(), 1);
6101 let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
6103 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 } } => {
6104 assert!(update_add_htlcs.is_empty());
6105 assert!(update_fulfill_htlcs.is_empty());
6106 assert!(update_fail_htlcs.is_empty());
6107 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6108 assert!(update_fee.is_none());
6109 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
6111 _ => panic!("Unexpected event"),
6115 nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
6117 check_added_monitors!(nodes[1], 0);
6118 commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
6119 expect_pending_htlcs_forwardable!(nodes[1]);
6120 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
6121 assert_eq!(events_4.len(), 1);
6123 //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
6125 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, .. } } => {
6126 assert!(update_add_htlcs.is_empty());
6127 assert!(update_fulfill_htlcs.is_empty());
6128 assert_eq!(update_fail_htlcs.len(), 1);
6129 assert!(update_fail_malformed_htlcs.is_empty());
6130 assert!(update_fee.is_none());
6132 _ => panic!("Unexpected event"),
6135 check_added_monitors!(nodes[1], 1);
6138 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
6139 // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
6140 // 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
6141 // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
6143 let chanmon_cfgs = create_chanmon_cfgs(2);
6144 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6145 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6146 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6147 let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6149 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6151 // We route 2 dust-HTLCs between A and B
6152 let (_, payment_hash_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6153 let (_, payment_hash_2) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6154 route_payment(&nodes[0], &[&nodes[1]], 1000000);
6156 // Cache one local commitment tx as previous
6157 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();
6159 // Fail one HTLC to prune it in the will-be-latest-local commitment tx
6160 assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2));
6161 check_added_monitors!(nodes[1], 0);
6162 expect_pending_htlcs_forwardable!(nodes[1]);
6163 check_added_monitors!(nodes[1], 1);
6165 let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6166 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
6167 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
6168 check_added_monitors!(nodes[0], 1);
6170 // Cache one local commitment tx as lastest
6171 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();
6173 let events = nodes[0].node.get_and_clear_pending_msg_events();
6175 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
6176 assert_eq!(node_id, nodes[1].node.get_our_node_id());
6178 _ => panic!("Unexpected event"),
6181 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
6182 assert_eq!(node_id, nodes[1].node.get_our_node_id());
6184 _ => panic!("Unexpected event"),
6187 assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
6188 // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
6189 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6191 if announce_latest {
6192 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_last_commitment_tx[0].clone()]}, 1);
6194 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_prev_commitment_tx[0].clone()]}, 1);
6197 let events = nodes[0].node.get_and_clear_pending_msg_events();
6198 assert_eq!(events.len(), 1);
6200 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
6201 _ => panic!("Unexpected event"),
6204 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6205 connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
6206 let events = nodes[0].node.get_and_clear_pending_events();
6207 // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
6208 assert_eq!(events.len(), 2);
6209 let mut first_failed = false;
6210 for event in events {
6212 Event::PaymentFailed { payment_hash, .. } => {
6213 if payment_hash == payment_hash_1 {
6214 assert!(!first_failed);
6215 first_failed = true;
6217 assert_eq!(payment_hash, payment_hash_2);
6220 _ => panic!("Unexpected event"),
6226 fn test_failure_delay_dust_htlc_local_commitment() {
6227 do_test_failure_delay_dust_htlc_local_commitment(true);
6228 do_test_failure_delay_dust_htlc_local_commitment(false);
6232 fn test_no_failure_dust_htlc_local_commitment() {
6233 // Transaction filters for failing back dust htlc based on local commitment txn infos has been
6234 // prone to error, we test here that a dummy transaction don't fail them.
6236 let chanmon_cfgs = create_chanmon_cfgs(2);
6237 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6238 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6239 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6240 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6243 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
6245 let as_dust_limit = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6246 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6248 // We route 2 dust-HTLCs between A and B
6249 let (preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6250 let (preimage_2, _) = route_payment(&nodes[1], &[&nodes[0]], as_dust_limit*1000);
6252 // Build a dummy invalid transaction trying to spend a commitment tx
6254 previous_output: BitcoinOutPoint { txid: chan.3.txid(), vout: 0 },
6255 script_sig: Script::new(),
6257 witness: Vec::new(),
6261 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
6265 let dummy_tx = Transaction {
6272 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6273 nodes[0].chan_monitor.simple_monitor.block_connected(&header, 1, &[&dummy_tx], &[1;1]);
6274 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6275 assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
6276 // We broadcast a few more block to check everything is all right
6277 connect_blocks(&nodes[0].block_notifier, 20, 1, true, header.bitcoin_hash());
6278 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6279 assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
6281 claim_payment(&nodes[0], &vec!(&nodes[1])[..], preimage_1, bs_dust_limit*1000);
6282 claim_payment(&nodes[1], &vec!(&nodes[0])[..], preimage_2, as_dust_limit*1000);
6285 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
6286 // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
6287 // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
6288 // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
6289 // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
6290 // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
6291 // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
6293 let chanmon_cfgs = create_chanmon_cfgs(3);
6294 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6295 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6296 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6297 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6299 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6301 let (_payment_preimage_1, dust_hash) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6302 let (_payment_preimage_2, non_dust_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
6304 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();
6305 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();
6307 // We revoked bs_commitment_tx
6309 let (payment_preimage_3, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
6310 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 1_000_000);
6313 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6314 let mut timeout_tx = Vec::new();
6316 // We fail dust-HTLC 1 by broadcast of local commitment tx
6317 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_commitment_tx[0].clone()]}, 1);
6318 let events = nodes[0].node.get_and_clear_pending_msg_events();
6319 assert_eq!(events.len(), 1);
6321 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
6322 _ => panic!("Unexpected event"),
6324 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6325 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
6326 let parent_hash = connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
6327 let events = nodes[0].node.get_and_clear_pending_events();
6328 assert_eq!(events.len(), 1);
6330 Event::PaymentFailed { payment_hash, .. } => {
6331 assert_eq!(payment_hash, dust_hash);
6333 _ => panic!("Unexpected event"),
6335 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
6336 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
6337 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6338 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6339 nodes[0].block_notifier.block_connected(&Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
6340 let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6341 connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
6342 let events = nodes[0].node.get_and_clear_pending_events();
6343 assert_eq!(events.len(), 1);
6345 Event::PaymentFailed { payment_hash, .. } => {
6346 assert_eq!(payment_hash, non_dust_hash);
6348 _ => panic!("Unexpected event"),
6351 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
6352 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![bs_commitment_tx[0].clone()]}, 1);
6353 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6354 let events = nodes[0].node.get_and_clear_pending_msg_events();
6355 assert_eq!(events.len(), 1);
6357 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
6358 _ => panic!("Unexpected event"),
6360 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
6361 let parent_hash = connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
6362 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6364 let events = nodes[0].node.get_and_clear_pending_events();
6365 assert_eq!(events.len(), 1);
6367 Event::PaymentFailed { payment_hash, .. } => {
6368 assert_eq!(payment_hash, dust_hash);
6370 _ => panic!("Unexpected event"),
6372 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
6373 // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
6374 nodes[0].block_notifier.block_connected(&Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
6375 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6376 let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6377 connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
6378 let events = nodes[0].node.get_and_clear_pending_events();
6379 assert_eq!(events.len(), 1);
6381 Event::PaymentFailed { payment_hash, .. } => {
6382 assert_eq!(payment_hash, non_dust_hash);
6384 _ => panic!("Unexpected event"),
6387 // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
6389 let events = nodes[0].node.get_and_clear_pending_events();
6390 assert_eq!(events.len(), 2);
6393 Event::PaymentFailed { payment_hash, .. } => {
6394 if payment_hash == dust_hash { first = true; }
6395 else { first = false; }
6397 _ => panic!("Unexpected event"),
6400 Event::PaymentFailed { payment_hash, .. } => {
6401 if first { assert_eq!(payment_hash, non_dust_hash); }
6402 else { assert_eq!(payment_hash, dust_hash); }
6404 _ => panic!("Unexpected event"),
6411 fn test_sweep_outbound_htlc_failure_update() {
6412 do_test_sweep_outbound_htlc_failure_update(false, true);
6413 do_test_sweep_outbound_htlc_failure_update(false, false);
6414 do_test_sweep_outbound_htlc_failure_update(true, false);
6418 fn test_upfront_shutdown_script() {
6419 // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
6420 // enforce it at shutdown message
6422 let mut config = UserConfig::default();
6423 config.channel_options.announced_channel = true;
6424 config.peer_channel_config_limits.force_announced_channel_preference = false;
6425 config.channel_options.commit_upfront_shutdown_pubkey = false;
6426 let user_cfgs = [None, Some(config), None];
6427 let chanmon_cfgs = create_chanmon_cfgs(3);
6428 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6429 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
6430 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6432 // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
6433 let flags = InitFeatures::supported();
6434 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
6435 nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6436 let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
6437 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6438 // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that we disconnect peer
6439 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
6440 let events = nodes[2].node.get_and_clear_pending_msg_events();
6441 assert_eq!(events.len(), 2);
6443 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
6444 _ => panic!("Unexpected event"),
6446 if let MessageSendEvent::HandleError { ref action, .. } = events[1] {
6448 &ErrorAction::SendErrorMessage { ref msg } => {
6449 assert_eq!(msg.data,"Got shutdown request with a scriptpubkey which did not match their previous scriptpubkey");
6451 _ => { assert!(false); }
6453 } else { assert!(false); }
6455 // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
6456 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
6457 nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6458 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
6459 // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
6460 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
6461 let events = nodes[2].node.get_and_clear_pending_msg_events();
6462 assert_eq!(events.len(), 1);
6464 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
6465 _ => panic!("Unexpected event"),
6468 // We test that if case of peer non-signaling we don't enforce committed script at channel opening
6469 let mut flags_no = InitFeatures::supported();
6470 flags_no.unset_upfront_shutdown_script();
6471 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
6472 nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6473 let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
6474 node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6475 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_1_shutdown);
6476 let events = nodes[1].node.get_and_clear_pending_msg_events();
6477 assert_eq!(events.len(), 1);
6479 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
6480 _ => panic!("Unexpected event"),
6483 // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
6484 // channel smoothly, opt-out is from channel initiator here
6485 let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
6486 nodes[1].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6487 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
6488 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6489 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
6490 let events = nodes[0].node.get_and_clear_pending_msg_events();
6491 assert_eq!(events.len(), 1);
6493 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6494 _ => panic!("Unexpected event"),
6497 //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
6498 //// channel smoothly
6499 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
6500 nodes[1].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6501 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
6502 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6503 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
6504 let events = nodes[0].node.get_and_clear_pending_msg_events();
6505 assert_eq!(events.len(), 2);
6507 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6508 _ => panic!("Unexpected event"),
6511 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6512 _ => panic!("Unexpected event"),
6517 fn test_user_configurable_csv_delay() {
6518 // We test our channel constructors yield errors when we pass them absurd csv delay
6520 let mut low_our_to_self_config = UserConfig::default();
6521 low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
6522 let mut high_their_to_self_config = UserConfig::default();
6523 high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
6524 let user_cfgs = [Some(high_their_to_self_config.clone()), None];
6525 let chanmon_cfgs = create_chanmon_cfgs(2);
6526 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6527 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
6528 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6530 // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
6531 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())));
6532 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) {
6534 APIError::APIMisuseError { err } => { assert_eq!(err, "Configured with an unreasonable our_to_self_delay putting user funds at risks"); },
6535 _ => panic!("Unexpected event"),
6537 } else { assert!(false) }
6539 // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
6540 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
6541 let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
6542 open_channel.to_self_delay = 200;
6543 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) {
6545 ChannelError::Close(err) => { assert_eq!(err, "Configured with an unreasonable our_to_self_delay putting user funds at risks"); },
6546 _ => panic!("Unexpected event"),
6548 } else { assert!(false); }
6550 // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
6551 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
6552 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()));
6553 let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
6554 accept_channel.to_self_delay = 200;
6555 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::supported(), &accept_channel);
6556 if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
6558 &ErrorAction::SendErrorMessage { ref msg } => {
6559 assert_eq!(msg.data,"They wanted our payments to be delayed by a needlessly long period");
6561 _ => { assert!(false); }
6563 } else { assert!(false); }
6565 // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
6566 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
6567 let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
6568 open_channel.to_self_delay = 200;
6569 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) {
6571 ChannelError::Close(err) => { assert_eq!(err, "They wanted our payments to be delayed by a needlessly long period"); },
6572 _ => panic!("Unexpected event"),
6574 } else { assert!(false); }
6578 fn test_data_loss_protect() {
6579 // We want to be sure that :
6580 // * we don't broadcast our Local Commitment Tx in case of fallen behind
6581 // * we close channel in case of detecting other being fallen behind
6582 // * we are able to claim our own outputs thanks to remote my_current_per_commitment_point
6588 let chanmon_cfgs = create_chanmon_cfgs(2);
6589 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6590 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6591 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6593 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
6595 // Cache node A state before any channel update
6596 let previous_node_state = nodes[0].node.encode();
6597 let mut previous_chan_monitor_state = test_utils::TestVecWriter(Vec::new());
6598 nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut previous_chan_monitor_state).unwrap();
6600 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
6601 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
6603 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6604 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6606 // Restore node A from previous state
6607 let logger: Arc<Logger> = Arc::new(test_utils::TestLogger::with_id(format!("node {}", 0)));
6608 let mut chan_monitor = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut ::std::io::Cursor::new(previous_chan_monitor_state.0), Arc::clone(&logger)).unwrap().1;
6609 let chain_monitor = Arc::new(ChainWatchInterfaceUtil::new(Network::Testnet, Arc::clone(&logger)));
6610 tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())};
6611 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
6612 keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::clone(&logger));
6613 monitor = test_utils::TestChannelMonitor::new(chain_monitor.clone(), &tx_broadcaster, logger.clone(), &fee_estimator);
6615 let mut channel_monitors = HashMap::new();
6616 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chan_monitor);
6617 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>)>::read(&mut ::std::io::Cursor::new(previous_node_state), ChannelManagerReadArgs {
6618 keys_manager: &keys_manager,
6619 fee_estimator: &fee_estimator,
6621 logger: Arc::clone(&logger),
6622 tx_broadcaster: &tx_broadcaster,
6623 default_config: UserConfig::default(),
6624 channel_monitors: &mut channel_monitors,
6627 nodes[0].node = &node_state_0;
6628 assert!(monitor.add_monitor(OutPoint { txid: chan.3.txid(), index: 0 }, chan_monitor).is_ok());
6629 nodes[0].chan_monitor = &monitor;
6630 nodes[0].chain_monitor = chain_monitor;
6632 nodes[0].block_notifier = BlockNotifier::new(nodes[0].chain_monitor.clone());
6633 nodes[0].block_notifier.register_listener(&nodes[0].chan_monitor.simple_monitor);
6634 nodes[0].block_notifier.register_listener(nodes[0].node);
6636 check_added_monitors!(nodes[0], 1);
6638 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6639 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6641 let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6643 // Check we update monitor following learning of per_commitment_point from B
6644 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
6645 check_added_monitors!(nodes[0], 1);
6648 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
6649 assert_eq!(node_txn.len(), 0);
6652 let mut reestablish_1 = Vec::with_capacity(1);
6653 for msg in nodes[0].node.get_and_clear_pending_msg_events() {
6654 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
6655 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
6656 reestablish_1.push(msg.clone());
6657 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
6658 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
6660 &ErrorAction::SendErrorMessage { ref msg } => {
6661 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");
6663 _ => panic!("Unexpected event!"),
6666 panic!("Unexpected event")
6670 // Check we close channel detecting A is fallen-behind
6671 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6672 let events = nodes[1].node.get_and_clear_pending_msg_events();
6673 assert_eq!(events.len(), 2);
6675 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
6676 _ => panic!("Unexpected event"),
6679 MessageSendEvent::HandleError { ref action, .. } => {
6681 &ErrorAction::SendErrorMessage { ref msg } => {
6682 assert_eq!(msg.data, "Peer attempted to reestablish channel with a very old local commitment transaction"); },
6683 _ => panic!("Unexpected event!"),
6686 _ => panic!("Unexpected event"),
6689 // Check A is able to claim to_remote output
6690 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
6691 assert_eq!(node_txn.len(), 1);
6692 check_spends!(node_txn[0], chan.3);
6693 assert_eq!(node_txn[0].output.len(), 2);
6694 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
6695 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()]}, 1);
6696 let spend_txn = check_spendable_outputs!(nodes[0], 1);
6697 assert_eq!(spend_txn.len(), 1);
6698 check_spends!(spend_txn[0], node_txn[0]);
6702 fn test_check_htlc_underpaying() {
6703 // Send payment through A -> B but A is maliciously
6704 // sending a probe payment (i.e less than expected value0
6705 // to B, B should refuse payment.
6707 let chanmon_cfgs = create_chanmon_cfgs(2);
6708 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6709 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6710 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6712 // Create some initial channels
6713 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6715 let (payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 10_000);
6717 // Node 3 is expecting payment of 100_000 but receive 10_000,
6718 // fail htlc like we didn't know the preimage.
6719 nodes[1].node.claim_funds(payment_preimage, 100_000);
6720 nodes[1].node.process_pending_htlc_forwards();
6722 let events = nodes[1].node.get_and_clear_pending_msg_events();
6723 assert_eq!(events.len(), 1);
6724 let (update_fail_htlc, commitment_signed) = match events[0] {
6725 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 } } => {
6726 assert!(update_add_htlcs.is_empty());
6727 assert!(update_fulfill_htlcs.is_empty());
6728 assert_eq!(update_fail_htlcs.len(), 1);
6729 assert!(update_fail_malformed_htlcs.is_empty());
6730 assert!(update_fee.is_none());
6731 (update_fail_htlcs[0].clone(), commitment_signed)
6733 _ => panic!("Unexpected event"),
6735 check_added_monitors!(nodes[1], 1);
6737 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
6738 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
6740 let events = nodes[0].node.get_and_clear_pending_events();
6741 assert_eq!(events.len(), 1);
6742 if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code } = &events[0] {
6743 assert_eq!(*rejected_by_dest, true);
6744 assert_eq!(error_code.unwrap(), 0x4000|15);
6746 panic!("Unexpected event");
6748 nodes[1].node.get_and_clear_pending_events();
6752 fn test_announce_disable_channels() {
6753 // Create 2 channels between A and B. Disconnect B. Call timer_chan_freshness_every_min and check for generated
6754 // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
6756 let chanmon_cfgs = create_chanmon_cfgs(2);
6757 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6758 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6759 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6761 let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
6762 let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
6763 let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
6766 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6767 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6769 nodes[0].node.timer_chan_freshness_every_min(); // dirty -> stagged
6770 nodes[0].node.timer_chan_freshness_every_min(); // staged -> fresh
6771 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
6772 assert_eq!(msg_events.len(), 3);
6773 for e in msg_events {
6775 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
6776 let short_id = msg.contents.short_channel_id;
6777 // Check generated channel_update match list in PendingChannelUpdate
6778 if short_id != short_id_1 && short_id != short_id_2 && short_id != short_id_3 {
6779 panic!("Generated ChannelUpdate for wrong chan!");
6782 _ => panic!("Unexpected event"),
6786 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6787 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6788 assert_eq!(reestablish_1.len(), 3);
6789 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6790 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6791 assert_eq!(reestablish_2.len(), 3);
6793 // Reestablish chan_1
6794 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6795 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6796 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6797 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6798 // Reestablish chan_2
6799 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
6800 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6801 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
6802 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6803 // Reestablish chan_3
6804 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
6805 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6806 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
6807 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6809 nodes[0].node.timer_chan_freshness_every_min();
6810 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6814 fn test_bump_penalty_txn_on_revoked_commitment() {
6815 // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
6816 // we're able to claim outputs on revoked commitment transaction before timelocks expiration
6818 let chanmon_cfgs = create_chanmon_cfgs(2);
6819 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6820 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6821 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6823 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
6824 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
6825 let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 3000000, 30).unwrap();
6826 send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
6828 let revoked_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
6829 // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
6830 assert_eq!(revoked_txn[0].output.len(), 4);
6831 assert_eq!(revoked_txn[0].input.len(), 1);
6832 assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
6833 let revoked_txid = revoked_txn[0].txid();
6835 let mut penalty_sum = 0;
6836 for outp in revoked_txn[0].output.iter() {
6837 if outp.script_pubkey.is_v0_p2wsh() {
6838 penalty_sum += outp.value;
6842 // Connect blocks to change height_timer range to see if we use right soonest_timelock
6843 let header_114 = connect_blocks(&nodes[1].block_notifier, 114, 0, false, Default::default());
6845 // Actually revoke tx by claiming a HTLC
6846 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
6847 let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6848 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_txn[0].clone()] }, 115);
6850 // One or more justice tx should have been broadcast, check it
6854 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6855 assert_eq!(node_txn.len(), 3); // justice tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout (broadcasted from ChannelManager)
6856 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
6857 assert_eq!(node_txn[0].output.len(), 1);
6858 check_spends!(node_txn[0], revoked_txn[0]);
6859 let fee_1 = penalty_sum - node_txn[0].output[0].value;
6860 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
6861 penalty_1 = node_txn[0].txid();
6865 // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
6866 let header = connect_blocks(&nodes[1].block_notifier, 3, 115, true, header.bitcoin_hash());
6867 let mut penalty_2 = penalty_1;
6868 let mut feerate_2 = 0;
6870 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6871 assert_eq!(node_txn.len(), 1);
6872 if node_txn[0].input[0].previous_output.txid == revoked_txid {
6873 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
6874 assert_eq!(node_txn[0].output.len(), 1);
6875 check_spends!(node_txn[0], revoked_txn[0]);
6876 penalty_2 = node_txn[0].txid();
6877 // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
6878 assert_ne!(penalty_2, penalty_1);
6879 let fee_2 = penalty_sum - node_txn[0].output[0].value;
6880 feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
6881 // Verify 25% bump heuristic
6882 assert!(feerate_2 * 100 >= feerate_1 * 125);
6886 assert_ne!(feerate_2, 0);
6888 // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
6889 connect_blocks(&nodes[1].block_notifier, 3, 118, true, header);
6891 let mut feerate_3 = 0;
6893 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6894 assert_eq!(node_txn.len(), 1);
6895 if node_txn[0].input[0].previous_output.txid == revoked_txid {
6896 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
6897 assert_eq!(node_txn[0].output.len(), 1);
6898 check_spends!(node_txn[0], revoked_txn[0]);
6899 penalty_3 = node_txn[0].txid();
6900 // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
6901 assert_ne!(penalty_3, penalty_2);
6902 let fee_3 = penalty_sum - node_txn[0].output[0].value;
6903 feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
6904 // Verify 25% bump heuristic
6905 assert!(feerate_3 * 100 >= feerate_2 * 125);
6909 assert_ne!(feerate_3, 0);
6911 nodes[1].node.get_and_clear_pending_events();
6912 nodes[1].node.get_and_clear_pending_msg_events();
6916 fn test_bump_penalty_txn_on_revoked_htlcs() {
6917 // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
6918 // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
6920 let chanmon_cfgs = create_chanmon_cfgs(2);
6921 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6922 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6923 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6925 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
6926 // Lock HTLC in both directions
6927 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3_000_000).0;
6928 route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
6930 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();
6931 assert_eq!(revoked_local_txn[0].input.len(), 1);
6932 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
6934 // Revoke local commitment tx
6935 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
6937 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6938 // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
6939 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
6940 check_closed_broadcast!(nodes[1], false);
6942 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6943 assert_eq!(revoked_htlc_txn.len(), 6);
6944 if revoked_htlc_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
6945 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
6946 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
6947 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
6948 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
6949 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
6950 } else if revoked_htlc_txn[1].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
6951 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
6952 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
6953 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
6954 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
6955 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
6958 // Broadcast set of revoked txn on A
6959 let header_128 = connect_blocks(&nodes[0].block_notifier, 128, 0, true, header.bitcoin_hash());
6960 let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6961 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);
6966 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6967 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
6968 // Verify claim tx are spending revoked HTLC txn
6969 assert_eq!(node_txn[4].input.len(), 2);
6970 assert_eq!(node_txn[4].output.len(), 1);
6971 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[1]);
6972 first = node_txn[4].txid();
6973 // Store both feerates for later comparison
6974 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[4].output[0].value;
6975 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
6976 penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
6980 // Connect three more block to see if bumped penalty are issued for HTLC txn
6981 let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6982 nodes[0].block_notifier.block_connected(&Block { header: header_130, txdata: penalty_txn }, 130);
6984 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6985 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
6987 check_spends!(node_txn[0], revoked_local_txn[0]);
6988 check_spends!(node_txn[1], revoked_local_txn[0]);
6993 // Few more blocks to confirm penalty txn
6994 let header_135 = connect_blocks(&nodes[0].block_notifier, 5, 130, true, header_130.bitcoin_hash());
6995 assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
6996 let header_144 = connect_blocks(&nodes[0].block_notifier, 9, 135, true, header_135);
6998 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6999 assert_eq!(node_txn.len(), 1);
7001 assert_eq!(node_txn[0].input.len(), 2);
7002 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7003 // Verify bumped tx is different and 25% bump heuristic
7004 assert_ne!(first, node_txn[0].txid());
7005 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[0].output[0].value;
7006 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7007 assert!(feerate_2 * 100 > feerate_1 * 125);
7008 let txn = vec![node_txn[0].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 // We verify than no new transaction has been broadcast because previously
7019 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
7020 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
7021 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
7022 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
7023 // up bumped justice generation.
7024 assert_eq!(node_txn.len(), 0);
7027 check_closed_broadcast!(nodes[0], false);
7031 fn test_bump_penalty_txn_on_remote_commitment() {
7032 // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
7033 // we're able to claim outputs on remote commitment transaction before timelocks expiration
7036 // Provide preimage for one
7037 // Check aggregation
7039 let chanmon_cfgs = create_chanmon_cfgs(2);
7040 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7041 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7042 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7044 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
7045 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7046 route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
7048 // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7049 let remote_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
7050 assert_eq!(remote_txn[0].output.len(), 4);
7051 assert_eq!(remote_txn[0].input.len(), 1);
7052 assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
7054 // Claim a HTLC without revocation (provide B monitor with preimage)
7055 nodes[1].node.claim_funds(payment_preimage, 3_000_000);
7056 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7057 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
7058 check_added_monitors!(nodes[1], 1);
7060 // One or more claim tx should have been broadcast, check it
7063 let feerate_timeout;
7064 let feerate_preimage;
7066 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7067 assert_eq!(node_txn.len(), 5); // 2 * claim tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout + local HTLC-success (broadcasted from ChannelManager)
7068 assert_eq!(node_txn[0].input.len(), 1);
7069 assert_eq!(node_txn[1].input.len(), 1);
7070 check_spends!(node_txn[0], remote_txn[0]);
7071 check_spends!(node_txn[1], remote_txn[0]);
7072 check_spends!(node_txn[2], chan.3);
7073 check_spends!(node_txn[3], node_txn[2]);
7074 check_spends!(node_txn[4], node_txn[2]);
7075 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7076 timeout = node_txn[0].txid();
7077 let index = node_txn[0].input[0].previous_output.vout;
7078 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7079 feerate_timeout = fee * 1000 / node_txn[0].get_weight() as u64;
7081 preimage = node_txn[1].txid();
7082 let index = node_txn[1].input[0].previous_output.vout;
7083 let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7084 feerate_preimage = fee * 1000 / node_txn[1].get_weight() as u64;
7086 timeout = node_txn[1].txid();
7087 let index = node_txn[1].input[0].previous_output.vout;
7088 let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7089 feerate_timeout = fee * 1000 / node_txn[1].get_weight() as u64;
7091 preimage = node_txn[0].txid();
7092 let index = node_txn[0].input[0].previous_output.vout;
7093 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7094 feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
7098 assert_ne!(feerate_timeout, 0);
7099 assert_ne!(feerate_preimage, 0);
7101 // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
7102 connect_blocks(&nodes[1].block_notifier, 15, 1, true, header.bitcoin_hash());
7104 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7105 assert_eq!(node_txn.len(), 2);
7106 assert_eq!(node_txn[0].input.len(), 1);
7107 assert_eq!(node_txn[1].input.len(), 1);
7108 check_spends!(node_txn[0], remote_txn[0]);
7109 check_spends!(node_txn[1], remote_txn[0]);
7110 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7111 let index = node_txn[0].input[0].previous_output.vout;
7112 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7113 let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
7114 assert!(new_feerate * 100 > feerate_timeout * 125);
7115 assert_ne!(timeout, node_txn[0].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_preimage * 125);
7121 assert_ne!(preimage, node_txn[1].txid());
7123 let index = node_txn[1].input[0].previous_output.vout;
7124 let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7125 let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
7126 assert!(new_feerate * 100 > feerate_timeout * 125);
7127 assert_ne!(timeout, node_txn[1].txid());
7129 let index = node_txn[0].input[0].previous_output.vout;
7130 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7131 let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
7132 assert!(new_feerate * 100 > feerate_preimage * 125);
7133 assert_ne!(preimage, node_txn[0].txid());
7138 nodes[1].node.get_and_clear_pending_events();
7139 nodes[1].node.get_and_clear_pending_msg_events();
7143 fn test_set_outpoints_partial_claiming() {
7144 // - remote party claim tx, new bump tx
7145 // - disconnect remote claiming tx, new bump
7146 // - disconnect tx, see no tx anymore
7147 let chanmon_cfgs = create_chanmon_cfgs(2);
7148 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7149 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7150 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7152 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
7153 let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7154 let payment_preimage_2 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7156 // Remote commitment txn with 4 outputs: to_local, to_remote, 2 outgoing HTLC
7157 let remote_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
7158 assert_eq!(remote_txn.len(), 3);
7159 assert_eq!(remote_txn[0].output.len(), 4);
7160 assert_eq!(remote_txn[0].input.len(), 1);
7161 assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
7162 check_spends!(remote_txn[1], remote_txn[0]);
7163 check_spends!(remote_txn[2], remote_txn[0]);
7165 // Connect blocks on node A to advance height towards TEST_FINAL_CLTV
7166 let prev_header_100 = connect_blocks(&nodes[1].block_notifier, 100, 0, false, Default::default());
7167 // Provide node A with both preimage
7168 nodes[0].node.claim_funds(payment_preimage_1, 3_000_000);
7169 nodes[0].node.claim_funds(payment_preimage_2, 3_000_000);
7170 check_added_monitors!(nodes[0], 2);
7171 nodes[0].node.get_and_clear_pending_events();
7172 nodes[0].node.get_and_clear_pending_msg_events();
7174 // Connect blocks on node A commitment transaction
7175 let header = BlockHeader { version: 0x20000000, prev_blockhash: prev_header_100, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7176 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 101);
7177 // Verify node A broadcast tx claiming both HTLCs
7179 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7180 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-Success*2
7181 assert_eq!(node_txn.len(), 4);
7182 check_spends!(node_txn[0], remote_txn[0]);
7183 check_spends!(node_txn[1], chan.3);
7184 check_spends!(node_txn[2], node_txn[1]);
7185 check_spends!(node_txn[3], node_txn[1]);
7186 assert_eq!(node_txn[0].input.len(), 2);
7189 nodes[0].node.get_and_clear_pending_msg_events();
7191 // Connect blocks on node B
7192 connect_blocks(&nodes[1].block_notifier, 135, 0, false, Default::default());
7193 // Verify node B broadcast 2 HTLC-timeout txn
7194 let partial_claim_tx = {
7195 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7196 assert_eq!(node_txn.len(), 3);
7197 check_spends!(node_txn[1], node_txn[0]);
7198 check_spends!(node_txn[2], node_txn[0]);
7199 assert_eq!(node_txn[1].input.len(), 1);
7200 assert_eq!(node_txn[2].input.len(), 1);
7203 nodes[1].node.get_and_clear_pending_msg_events();
7205 // Broadcast partial claim on node A, should regenerate a claiming tx with HTLC dropped
7206 let header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7207 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![partial_claim_tx.clone()] }, 102);
7209 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7210 assert_eq!(node_txn.len(), 1);
7211 check_spends!(node_txn[0], remote_txn[0]);
7212 assert_eq!(node_txn[0].input.len(), 1); //dropped HTLC
7215 nodes[0].node.get_and_clear_pending_msg_events();
7217 // Disconnect last block on node A, should regenerate a claiming tx with HTLC dropped
7218 nodes[0].block_notifier.block_disconnected(&header, 102);
7220 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7221 assert_eq!(node_txn.len(), 1);
7222 check_spends!(node_txn[0], remote_txn[0]);
7223 assert_eq!(node_txn[0].input.len(), 2); //resurrected HTLC
7227 //// Disconnect one more block and then reconnect multiple no transaction should be generated
7228 nodes[0].block_notifier.block_disconnected(&header, 101);
7229 connect_blocks(&nodes[1].block_notifier, 15, 101, false, prev_header_100);
7231 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7232 assert_eq!(node_txn.len(), 0);
7238 fn test_counterparty_raa_skip_no_crash() {
7239 // Previously, if our counterparty sent two RAAs in a row without us having provided a
7240 // commitment transaction, we would have happily carried on and provided them the next
7241 // commitment transaction based on one RAA forward. This would probably eventually have led to
7242 // channel closure, but it would not have resulted in funds loss. Still, our
7243 // EnforcingChannelKeys would have paniced as it doesn't like jumps into the future. Here, we
7244 // check simply that the channel is closed in response to such an RAA, but don't check whether
7245 // we decide to punish our counterparty for revoking their funds (as we don't currently
7247 let chanmon_cfgs = create_chanmon_cfgs(2);
7248 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7249 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7250 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7251 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).2;
7253 let commitment_seed = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&channel_id).unwrap().local_keys.commitment_seed().clone();
7254 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
7255 let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
7256 &SecretKey::from_slice(&chan_utils::build_commitment_secret(&commitment_seed, INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
7257 let per_commitment_secret = chan_utils::build_commitment_secret(&commitment_seed, INITIAL_COMMITMENT_NUMBER);
7259 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
7260 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
7261 assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
7265 fn test_bump_txn_sanitize_tracking_maps() {
7266 // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
7267 // verify we clean then right after expiration of ANTI_REORG_DELAY.
7269 let chanmon_cfgs = create_chanmon_cfgs(2);
7270 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7271 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7272 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7274 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
7275 // Lock HTLC in both directions
7276 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
7277 route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
7279 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();
7280 assert_eq!(revoked_local_txn[0].input.len(), 1);
7281 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7283 // Revoke local commitment tx
7284 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 9_000_000);
7286 // Broadcast set of revoked txn on A
7287 let header_128 = connect_blocks(&nodes[0].block_notifier, 128, 0, false, Default::default());
7288 let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7289 nodes[0].block_notifier.block_connected(&Block { header: header_129, txdata: vec![revoked_local_txn[0].clone()] }, 129);
7290 check_closed_broadcast!(nodes[0], false);
7292 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7293 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
7294 check_spends!(node_txn[0], revoked_local_txn[0]);
7295 check_spends!(node_txn[1], revoked_local_txn[0]);
7296 check_spends!(node_txn[2], revoked_local_txn[0]);
7297 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
7301 let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7302 nodes[0].block_notifier.block_connected(&Block { header: header_130, txdata: penalty_txn }, 130);
7303 connect_blocks(&nodes[0].block_notifier, 5, 130, false, header_130.bitcoin_hash());
7305 let monitors = nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap();
7306 if let Some(monitor) = monitors.get(&OutPoint::new(chan.3.txid(), 0)) {
7307 assert!(monitor.onchain_tx_handler.pending_claim_requests.is_empty());
7308 assert!(monitor.onchain_tx_handler.claimable_outpoints.is_empty());
7314 fn test_override_channel_config() {
7315 let chanmon_cfgs = create_chanmon_cfgs(2);
7316 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7317 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7318 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7320 // Node0 initiates a channel to node1 using the override config.
7321 let mut override_config = UserConfig::default();
7322 override_config.own_channel_config.our_to_self_delay = 200;
7324 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
7326 // Assert the channel created by node0 is using the override config.
7327 let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7328 assert_eq!(res.channel_flags, 0);
7329 assert_eq!(res.to_self_delay, 200);
7333 fn test_override_0msat_htlc_minimum() {
7334 let mut zero_config = UserConfig::default();
7335 zero_config.own_channel_config.our_htlc_minimum_msat = 0;
7336 let chanmon_cfgs = create_chanmon_cfgs(2);
7337 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7338 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
7339 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7341 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
7342 let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7343 assert_eq!(res.htlc_minimum_msat, 1);
7345 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::supported(), &res);
7346 let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7347 assert_eq!(res.htlc_minimum_msat, 1);