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;
8 use chain::chaininterface::{ChainListener, ChainWatchInterfaceUtil, BlockNotifier};
9 use ln::channel::{COMMITMENT_TX_BASE_WEIGHT, COMMITMENT_TX_WEIGHT_PER_HTLC};
10 use ln::channelmanager::{ChannelManager,ChannelManagerReadArgs,HTLCForwardInfo,RAACommitmentOrder, PaymentPreimage, PaymentHash, PaymentSecret, PaymentSendFailure, BREAKDOWN_TIMEOUT};
11 use ln::channelmonitor::{ChannelMonitor, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ManyChannelMonitor, ANTI_REORG_DELAY};
12 use ln::channelmonitor;
13 use ln::channel::{Channel, ChannelError};
14 use ln::{chan_utils, onion_utils};
15 use routing::router::{Route, RouteHop, get_route};
16 use ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
18 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler,HTLCFailChannelUpdate, ErrorAction};
19 use util::enforcing_trait_impls::EnforcingChannelKeys;
20 use util::{byte_utils, test_utils};
21 use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
22 use util::errors::APIError;
23 use util::ser::{Writeable, Writer, ReadableArgs, Readable};
24 use util::config::UserConfig;
26 use bitcoin::util::hash::BitcoinHash;
27 use bitcoin::hashes::sha256d::Hash as Sha256dHash;
28 use bitcoin::hash_types::{Txid, BlockHash};
29 use bitcoin::util::bip143;
30 use bitcoin::util::address::Address;
31 use bitcoin::util::bip32::{ChildNumber, ExtendedPubKey, ExtendedPrivKey};
32 use bitcoin::blockdata::block::{Block, BlockHeader};
33 use bitcoin::blockdata::transaction::{Transaction, TxOut, TxIn, SigHashType, OutPoint as BitcoinOutPoint};
34 use bitcoin::blockdata::script::{Builder, Script};
35 use bitcoin::blockdata::opcodes;
36 use bitcoin::blockdata::constants::genesis_block;
37 use bitcoin::network::constants::Network;
39 use bitcoin::hashes::sha256::Hash as Sha256;
40 use bitcoin::hashes::Hash;
42 use bitcoin::secp256k1::{Secp256k1, Message};
43 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
45 use std::collections::{BTreeSet, HashMap, HashSet};
46 use std::default::Default;
47 use std::sync::{Arc, Mutex};
48 use std::sync::atomic::Ordering;
51 use rand::{thread_rng, Rng};
53 use ln::functional_test_utils::*;
56 fn test_insane_channel_opens() {
57 // Stand up a network of 2 nodes
58 let chanmon_cfgs = create_chanmon_cfgs(2);
59 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
60 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
61 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
63 // Instantiate channel parameters where we push the maximum msats given our
65 let channel_value_sat = 31337; // same as funding satoshis
66 let channel_reserve_satoshis = Channel::<EnforcingChannelKeys>::get_remote_channel_reserve_satoshis(channel_value_sat);
67 let push_msat = (channel_value_sat - channel_reserve_satoshis) * 1000;
69 // Have node0 initiate a channel to node1 with aforementioned parameters
70 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_sat, push_msat, 42, None).unwrap();
72 // Extract the channel open message from node0 to node1
73 let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
75 // Test helper that asserts we get the correct error string given a mutator
76 // that supposedly makes the channel open message insane
77 let insane_open_helper = |expected_error_str: &str, message_mutator: fn(msgs::OpenChannel) -> msgs::OpenChannel| {
78 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &message_mutator(open_channel_message.clone()));
79 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
80 assert_eq!(msg_events.len(), 1);
81 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
83 &ErrorAction::SendErrorMessage { .. } => {
84 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), expected_error_str.to_string(), 1);
86 _ => panic!("unexpected event!"),
88 } else { assert!(false); }
91 use ln::channel::MAX_FUNDING_SATOSHIS;
92 use ln::channelmanager::MAX_LOCAL_BREAKDOWN_TIMEOUT;
94 // Test all mutations that would make the channel open message insane
95 insane_open_helper("funding value > 2^24", |mut msg| { msg.funding_satoshis = MAX_FUNDING_SATOSHIS; msg });
97 insane_open_helper("Bogus channel_reserve_satoshis", |mut msg| { msg.channel_reserve_satoshis = msg.funding_satoshis + 1; msg });
99 insane_open_helper("push_msat larger than funding value", |mut msg| { msg.push_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 + 1; msg });
101 insane_open_helper("Peer never wants payout outputs?", |mut msg| { msg.dust_limit_satoshis = msg.funding_satoshis + 1 ; msg });
103 insane_open_helper("Bogus; channel reserve is less than dust limit", |mut msg| { msg.dust_limit_satoshis = msg.channel_reserve_satoshis + 1; msg });
105 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 });
107 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 });
109 insane_open_helper("0 max_accpted_htlcs makes for a useless channel", |mut msg| { msg.max_accepted_htlcs = 0; msg });
111 insane_open_helper("max_accpted_htlcs > 483", |mut msg| { msg.max_accepted_htlcs = 484; msg });
115 fn test_async_inbound_update_fee() {
116 let chanmon_cfgs = create_chanmon_cfgs(2);
117 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
118 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
119 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
120 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
121 let logger = test_utils::TestLogger::new();
122 let channel_id = chan.2;
125 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
129 // send (1) commitment_signed -.
130 // <- update_add_htlc/commitment_signed
131 // send (2) RAA (awaiting remote revoke) -.
132 // (1) commitment_signed is delivered ->
133 // .- send (3) RAA (awaiting remote revoke)
134 // (2) RAA is delivered ->
135 // .- send (4) commitment_signed
136 // <- (3) RAA is delivered
137 // send (5) commitment_signed -.
138 // <- (4) commitment_signed is delivered
140 // (5) commitment_signed is delivered ->
142 // (6) RAA is delivered ->
144 // First nodes[0] generates an update_fee
145 nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
146 check_added_monitors!(nodes[0], 1);
148 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
149 assert_eq!(events_0.len(), 1);
150 let (update_msg, commitment_signed) = match events_0[0] { // (1)
151 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
152 (update_fee.as_ref(), commitment_signed)
154 _ => panic!("Unexpected event"),
157 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
159 // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
160 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
161 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
162 nodes[1].node.send_payment(&get_route(&nodes[1].node.get_our_node_id(), net_graph_msg_handler, &nodes[0].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV, &logger).unwrap(), our_payment_hash, &None).unwrap();
163 check_added_monitors!(nodes[1], 1);
165 let payment_event = {
166 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
167 assert_eq!(events_1.len(), 1);
168 SendEvent::from_event(events_1.remove(0))
170 assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
171 assert_eq!(payment_event.msgs.len(), 1);
173 // ...now when the messages get delivered everyone should be happy
174 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
175 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
176 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
177 // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
178 check_added_monitors!(nodes[0], 1);
180 // deliver(1), generate (3):
181 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
182 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
183 // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
184 check_added_monitors!(nodes[1], 1);
186 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack); // deliver (2)
187 let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
188 assert!(bs_update.update_add_htlcs.is_empty()); // (4)
189 assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
190 assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
191 assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
192 assert!(bs_update.update_fee.is_none()); // (4)
193 check_added_monitors!(nodes[1], 1);
195 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack); // deliver (3)
196 let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
197 assert!(as_update.update_add_htlcs.is_empty()); // (5)
198 assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
199 assert!(as_update.update_fail_htlcs.is_empty()); // (5)
200 assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
201 assert!(as_update.update_fee.is_none()); // (5)
202 check_added_monitors!(nodes[0], 1);
204 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed); // deliver (4)
205 let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
206 // only (6) so get_event_msg's assert(len == 1) passes
207 check_added_monitors!(nodes[0], 1);
209 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed); // deliver (5)
210 let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
211 check_added_monitors!(nodes[1], 1);
213 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
214 check_added_monitors!(nodes[0], 1);
216 let events_2 = nodes[0].node.get_and_clear_pending_events();
217 assert_eq!(events_2.len(), 1);
219 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
220 _ => panic!("Unexpected event"),
223 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke); // deliver (6)
224 check_added_monitors!(nodes[1], 1);
228 fn test_update_fee_unordered_raa() {
229 // Just the intro to the previous test followed by an out-of-order RAA (which caused a
230 // crash in an earlier version of the update_fee patch)
231 let chanmon_cfgs = create_chanmon_cfgs(2);
232 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
233 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
234 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
235 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
236 let channel_id = chan.2;
237 let logger = test_utils::TestLogger::new();
240 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
242 // First nodes[0] generates an update_fee
243 nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
244 check_added_monitors!(nodes[0], 1);
246 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
247 assert_eq!(events_0.len(), 1);
248 let update_msg = match events_0[0] { // (1)
249 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
252 _ => panic!("Unexpected event"),
255 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
257 // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
258 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
259 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
260 nodes[1].node.send_payment(&get_route(&nodes[1].node.get_our_node_id(), net_graph_msg_handler, &nodes[0].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV, &logger).unwrap(), our_payment_hash, &None).unwrap();
261 check_added_monitors!(nodes[1], 1);
263 let payment_event = {
264 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
265 assert_eq!(events_1.len(), 1);
266 SendEvent::from_event(events_1.remove(0))
268 assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
269 assert_eq!(payment_event.msgs.len(), 1);
271 // ...now when the messages get delivered everyone should be happy
272 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
273 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
274 let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
275 // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
276 check_added_monitors!(nodes[0], 1);
278 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg); // deliver (2)
279 check_added_monitors!(nodes[1], 1);
281 // We can't continue, sadly, because our (1) now has a bogus signature
285 fn test_multi_flight_update_fee() {
286 let chanmon_cfgs = create_chanmon_cfgs(2);
287 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
288 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
289 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
290 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
291 let channel_id = chan.2;
294 // update_fee/commitment_signed ->
295 // .- send (1) RAA and (2) commitment_signed
296 // update_fee (never committed) ->
298 // We have to manually generate the above update_fee, it is allowed by the protocol but we
299 // don't track which updates correspond to which revoke_and_ack responses so we're in
300 // AwaitingRAA mode and will not generate the update_fee yet.
301 // <- (1) RAA delivered
302 // (3) is generated and send (4) CS -.
303 // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
304 // know the per_commitment_point to use for it.
305 // <- (2) commitment_signed delivered
307 // B should send no response here
308 // (4) commitment_signed delivered ->
309 // <- RAA/commitment_signed delivered
312 // First nodes[0] generates an update_fee
313 let initial_feerate = get_feerate!(nodes[0], channel_id);
314 nodes[0].node.update_fee(channel_id, initial_feerate + 20).unwrap();
315 check_added_monitors!(nodes[0], 1);
317 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
318 assert_eq!(events_0.len(), 1);
319 let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
320 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
321 (update_fee.as_ref().unwrap(), commitment_signed)
323 _ => panic!("Unexpected event"),
326 // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
327 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1);
328 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1);
329 let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
330 check_added_monitors!(nodes[1], 1);
332 // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
334 nodes[0].node.update_fee(channel_id, initial_feerate + 40).unwrap();
335 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
336 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
338 // Create the (3) update_fee message that nodes[0] will generate before it does...
339 let mut update_msg_2 = msgs::UpdateFee {
340 channel_id: update_msg_1.channel_id.clone(),
341 feerate_per_kw: (initial_feerate + 30) as u32,
344 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
346 update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
348 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
350 // Deliver (1), generating (3) and (4)
351 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg);
352 let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
353 check_added_monitors!(nodes[0], 1);
354 assert!(as_second_update.update_add_htlcs.is_empty());
355 assert!(as_second_update.update_fulfill_htlcs.is_empty());
356 assert!(as_second_update.update_fail_htlcs.is_empty());
357 assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
358 // Check that the update_fee newly generated matches what we delivered:
359 assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
360 assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
362 // Deliver (2) commitment_signed
363 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
364 let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
365 check_added_monitors!(nodes[0], 1);
366 // No commitment_signed so get_event_msg's assert(len == 1) passes
368 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg);
369 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
370 check_added_monitors!(nodes[1], 1);
373 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
374 let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
375 check_added_monitors!(nodes[1], 1);
377 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
378 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
379 check_added_monitors!(nodes[0], 1);
381 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment);
382 let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
383 // No commitment_signed so get_event_msg's assert(len == 1) passes
384 check_added_monitors!(nodes[0], 1);
386 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke);
387 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
388 check_added_monitors!(nodes[1], 1);
392 fn test_1_conf_open() {
393 // Previously, if the minium_depth config was set to 1, we'd never send a funding_locked. This
394 // tests that we properly send one in that case.
395 let mut alice_config = UserConfig::default();
396 alice_config.own_channel_config.minimum_depth = 1;
397 alice_config.channel_options.announced_channel = true;
398 alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
399 let mut bob_config = UserConfig::default();
400 bob_config.own_channel_config.minimum_depth = 1;
401 bob_config.channel_options.announced_channel = true;
402 bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
403 let chanmon_cfgs = create_chanmon_cfgs(2);
404 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
405 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(alice_config), Some(bob_config)]);
406 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
408 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
409 assert!(nodes[0].chain_monitor.does_match_tx(&tx));
410 assert!(nodes[1].chain_monitor.does_match_tx(&tx));
412 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
413 nodes[1].block_notifier.block_connected_checked(&header, 1, &[&tx; 1], &[tx.version; 1]);
414 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()));
416 nodes[0].block_notifier.block_connected_checked(&header, 1, &[&tx; 1], &[tx.version; 1]);
417 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
418 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
421 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
422 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
423 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
427 fn do_test_sanity_on_in_flight_opens(steps: u8) {
428 // Previously, we had issues deserializing channels when we hadn't connected the first block
429 // after creation. To catch that and similar issues, we lean on the Node::drop impl to test
430 // serialization round-trips and simply do steps towards opening a channel and then drop the
433 let chanmon_cfgs = create_chanmon_cfgs(2);
434 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
435 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
436 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
438 if steps & 0b1000_0000 != 0{
439 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
440 nodes[0].block_notifier.block_connected_checked(&header, 1, &Vec::new(), &[0; 0]);
441 nodes[1].block_notifier.block_connected_checked(&header, 1, &Vec::new(), &[0; 0]);
444 if steps & 0x0f == 0 { return; }
445 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
446 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
448 if steps & 0x0f == 1 { return; }
449 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
450 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
452 if steps & 0x0f == 2 { return; }
453 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
455 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
457 if steps & 0x0f == 3 { return; }
458 nodes[0].node.funding_transaction_generated(&temporary_channel_id, funding_output);
459 check_added_monitors!(nodes[0], 0);
460 let funding_created = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
462 if steps & 0x0f == 4 { return; }
463 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
465 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
466 assert_eq!(added_monitors.len(), 1);
467 assert_eq!(added_monitors[0].0, funding_output);
468 added_monitors.clear();
470 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
472 if steps & 0x0f == 5 { return; }
473 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
475 let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
476 assert_eq!(added_monitors.len(), 1);
477 assert_eq!(added_monitors[0].0, funding_output);
478 added_monitors.clear();
481 let events_4 = nodes[0].node.get_and_clear_pending_events();
482 assert_eq!(events_4.len(), 1);
484 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
485 assert_eq!(user_channel_id, 42);
486 assert_eq!(*funding_txo, funding_output);
488 _ => panic!("Unexpected event"),
491 if steps & 0x0f == 6 { return; }
492 create_chan_between_nodes_with_value_confirm_first(&nodes[0], &nodes[1], &tx);
494 if steps & 0x0f == 7 { return; }
495 confirm_transaction(&nodes[0].block_notifier, &nodes[0].chain_monitor, &tx, tx.version);
496 create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
500 fn test_sanity_on_in_flight_opens() {
501 do_test_sanity_on_in_flight_opens(0);
502 do_test_sanity_on_in_flight_opens(0 | 0b1000_0000);
503 do_test_sanity_on_in_flight_opens(1);
504 do_test_sanity_on_in_flight_opens(1 | 0b1000_0000);
505 do_test_sanity_on_in_flight_opens(2);
506 do_test_sanity_on_in_flight_opens(2 | 0b1000_0000);
507 do_test_sanity_on_in_flight_opens(3);
508 do_test_sanity_on_in_flight_opens(3 | 0b1000_0000);
509 do_test_sanity_on_in_flight_opens(4);
510 do_test_sanity_on_in_flight_opens(4 | 0b1000_0000);
511 do_test_sanity_on_in_flight_opens(5);
512 do_test_sanity_on_in_flight_opens(5 | 0b1000_0000);
513 do_test_sanity_on_in_flight_opens(6);
514 do_test_sanity_on_in_flight_opens(6 | 0b1000_0000);
515 do_test_sanity_on_in_flight_opens(7);
516 do_test_sanity_on_in_flight_opens(7 | 0b1000_0000);
517 do_test_sanity_on_in_flight_opens(8);
518 do_test_sanity_on_in_flight_opens(8 | 0b1000_0000);
522 fn test_update_fee_vanilla() {
523 let chanmon_cfgs = create_chanmon_cfgs(2);
524 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
525 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
526 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
527 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
528 let channel_id = chan.2;
530 let feerate = get_feerate!(nodes[0], channel_id);
531 nodes[0].node.update_fee(channel_id, feerate+25).unwrap();
532 check_added_monitors!(nodes[0], 1);
534 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
535 assert_eq!(events_0.len(), 1);
536 let (update_msg, commitment_signed) = match events_0[0] {
537 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 } } => {
538 (update_fee.as_ref(), commitment_signed)
540 _ => panic!("Unexpected event"),
542 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
544 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
545 let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
546 check_added_monitors!(nodes[1], 1);
548 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
549 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
550 check_added_monitors!(nodes[0], 1);
552 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
553 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
554 // No commitment_signed so get_event_msg's assert(len == 1) passes
555 check_added_monitors!(nodes[0], 1);
557 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
558 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
559 check_added_monitors!(nodes[1], 1);
563 fn test_update_fee_that_funder_cannot_afford() {
564 let chanmon_cfgs = create_chanmon_cfgs(2);
565 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
566 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
567 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
568 let channel_value = 1888;
569 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000, InitFeatures::known(), InitFeatures::known());
570 let channel_id = chan.2;
573 nodes[0].node.update_fee(channel_id, feerate).unwrap();
574 check_added_monitors!(nodes[0], 1);
575 let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
577 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap());
579 commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
581 //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
582 //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
584 let commitment_tx = get_local_commitment_txn!(nodes[1], channel_id)[0].clone();
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 = commitment_tx.output.len() - 2;
588 let total_fee: u64 = feerate as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
589 let mut actual_fee = commitment_tx.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);
608 check_added_monitors!(nodes[1], 1);
609 check_closed_broadcast!(nodes[1], true);
613 fn test_update_fee_with_fundee_update_add_htlc() {
614 let chanmon_cfgs = create_chanmon_cfgs(2);
615 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
616 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
617 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
618 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
619 let channel_id = chan.2;
620 let logger = test_utils::TestLogger::new();
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 (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[1]);
643 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
644 let route = get_route(&nodes[1].node.get_our_node_id(), net_graph_msg_handler, &nodes[0].node.get_our_node_id(), None, &Vec::new(), 800000, TEST_FINAL_CLTV, &logger).unwrap();
646 // nothing happens since node[1] is in AwaitingRemoteRevoke
647 nodes[1].node.send_payment(&route, our_payment_hash, &None).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::known(), InitFeatures::known());
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::known(), InitFeatures::known());
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 { txid: tx.txid(), index: 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::known(), InitFeatures::known());
850 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
851 let logger = test_utils::TestLogger::new();
853 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
855 nodes[0].node.close_channel(&chan_1.2).unwrap();
856 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
857 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
858 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
859 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
861 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
862 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
864 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
866 let net_graph_msg_handler0 = &nodes[0].net_graph_msg_handler;
867 let net_graph_msg_handler1 = &nodes[1].net_graph_msg_handler;
868 let route_1 = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler0, &nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
869 let route_2 = get_route(&nodes[1].node.get_our_node_id(), net_graph_msg_handler1, &nodes[0].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
870 unwrap_send_err!(nodes[0].node.send_payment(&route_1, payment_hash, &None), true, APIError::ChannelUnavailable {..}, {});
871 unwrap_send_err!(nodes[1].node.send_payment(&route_2, payment_hash, &None), true, APIError::ChannelUnavailable {..}, {});
873 assert!(nodes[2].node.claim_funds(our_payment_preimage, &None, 100_000));
874 check_added_monitors!(nodes[2], 1);
875 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
876 assert!(updates.update_add_htlcs.is_empty());
877 assert!(updates.update_fail_htlcs.is_empty());
878 assert!(updates.update_fail_malformed_htlcs.is_empty());
879 assert!(updates.update_fee.is_none());
880 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
881 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
882 check_added_monitors!(nodes[1], 1);
883 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
884 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
886 assert!(updates_2.update_add_htlcs.is_empty());
887 assert!(updates_2.update_fail_htlcs.is_empty());
888 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
889 assert!(updates_2.update_fee.is_none());
890 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
891 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
892 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
894 let events = nodes[0].node.get_and_clear_pending_events();
895 assert_eq!(events.len(), 1);
897 Event::PaymentSent { ref payment_preimage } => {
898 assert_eq!(our_payment_preimage, *payment_preimage);
900 _ => panic!("Unexpected event"),
903 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
904 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
905 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
906 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
907 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
908 assert!(node_0_none.is_none());
910 assert!(nodes[0].node.list_channels().is_empty());
912 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
913 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
914 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
915 assert!(nodes[1].node.list_channels().is_empty());
916 assert!(nodes[2].node.list_channels().is_empty());
920 fn htlc_fail_async_shutdown() {
921 // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
922 let chanmon_cfgs = create_chanmon_cfgs(3);
923 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
924 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
925 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
926 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
927 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
928 let logger = test_utils::TestLogger::new();
930 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
931 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
932 let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[2].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
933 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
934 check_added_monitors!(nodes[0], 1);
935 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
936 assert_eq!(updates.update_add_htlcs.len(), 1);
937 assert!(updates.update_fulfill_htlcs.is_empty());
938 assert!(updates.update_fail_htlcs.is_empty());
939 assert!(updates.update_fail_malformed_htlcs.is_empty());
940 assert!(updates.update_fee.is_none());
942 nodes[1].node.close_channel(&chan_1.2).unwrap();
943 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
944 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
945 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
947 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
948 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
949 check_added_monitors!(nodes[1], 1);
950 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
951 commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
953 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
954 assert!(updates_2.update_add_htlcs.is_empty());
955 assert!(updates_2.update_fulfill_htlcs.is_empty());
956 assert_eq!(updates_2.update_fail_htlcs.len(), 1);
957 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
958 assert!(updates_2.update_fee.is_none());
960 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
961 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
963 expect_payment_failed!(nodes[0], our_payment_hash, false);
965 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
966 assert_eq!(msg_events.len(), 2);
967 let node_0_closing_signed = match msg_events[0] {
968 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
969 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
972 _ => panic!("Unexpected event"),
974 match msg_events[1] {
975 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
976 assert_eq!(msg.contents.short_channel_id, chan_1.0.contents.short_channel_id);
978 _ => panic!("Unexpected event"),
981 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
982 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
983 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
984 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
985 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
986 assert!(node_0_none.is_none());
988 assert!(nodes[0].node.list_channels().is_empty());
990 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
991 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
992 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
993 assert!(nodes[1].node.list_channels().is_empty());
994 assert!(nodes[2].node.list_channels().is_empty());
997 fn do_test_shutdown_rebroadcast(recv_count: u8) {
998 // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
999 // messages delivered prior to disconnect
1000 let chanmon_cfgs = create_chanmon_cfgs(3);
1001 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1002 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1003 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1004 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1005 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1007 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
1009 nodes[1].node.close_channel(&chan_1.2).unwrap();
1010 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1012 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
1013 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1015 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
1019 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1020 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1022 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1023 let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1024 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1025 let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1027 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
1028 let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1029 assert!(node_1_shutdown == node_1_2nd_shutdown);
1031 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
1032 let node_0_2nd_shutdown = if recv_count > 0 {
1033 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1034 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
1037 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1038 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
1039 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
1041 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_2nd_shutdown);
1043 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1044 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1046 assert!(nodes[2].node.claim_funds(our_payment_preimage, &None, 100_000));
1047 check_added_monitors!(nodes[2], 1);
1048 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1049 assert!(updates.update_add_htlcs.is_empty());
1050 assert!(updates.update_fail_htlcs.is_empty());
1051 assert!(updates.update_fail_malformed_htlcs.is_empty());
1052 assert!(updates.update_fee.is_none());
1053 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1054 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1055 check_added_monitors!(nodes[1], 1);
1056 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1057 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1059 assert!(updates_2.update_add_htlcs.is_empty());
1060 assert!(updates_2.update_fail_htlcs.is_empty());
1061 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
1062 assert!(updates_2.update_fee.is_none());
1063 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
1064 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
1065 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
1067 let events = nodes[0].node.get_and_clear_pending_events();
1068 assert_eq!(events.len(), 1);
1070 Event::PaymentSent { ref payment_preimage } => {
1071 assert_eq!(our_payment_preimage, *payment_preimage);
1073 _ => panic!("Unexpected event"),
1076 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1078 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1079 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1080 assert!(node_1_closing_signed.is_some());
1083 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1084 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1086 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1087 let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1088 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1089 if recv_count == 0 {
1090 // If all closing_signeds weren't delivered we can just resume where we left off...
1091 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1093 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
1094 let node_0_3rd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1095 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
1097 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1098 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1099 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
1101 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_3rd_shutdown);
1102 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1104 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_3rd_shutdown);
1105 let node_0_2nd_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1106 assert!(node_0_closing_signed == node_0_2nd_closing_signed);
1108 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
1109 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1110 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
1111 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1112 assert!(node_0_none.is_none());
1114 // If one node, however, received + responded with an identical closing_signed we end
1115 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
1116 // There isn't really anything better we can do simply, but in the future we might
1117 // explore storing a set of recently-closed channels that got disconnected during
1118 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
1119 // give our counterparty enough time to (potentially) broadcast a cooperative closing
1121 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1123 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1124 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
1125 assert_eq!(msg_events.len(), 1);
1126 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
1128 &ErrorAction::SendErrorMessage { ref msg } => {
1129 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msg);
1130 assert_eq!(msg.channel_id, chan_1.2);
1132 _ => panic!("Unexpected event!"),
1134 } else { panic!("Needed SendErrorMessage close"); }
1136 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
1137 // checks it, but in this case nodes[0] didn't ever get a chance to receive a
1138 // closing_signed so we do it ourselves
1139 check_closed_broadcast!(nodes[0], false);
1140 check_added_monitors!(nodes[0], 1);
1143 assert!(nodes[0].node.list_channels().is_empty());
1145 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1146 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1147 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1148 assert!(nodes[1].node.list_channels().is_empty());
1149 assert!(nodes[2].node.list_channels().is_empty());
1153 fn test_shutdown_rebroadcast() {
1154 do_test_shutdown_rebroadcast(0);
1155 do_test_shutdown_rebroadcast(1);
1156 do_test_shutdown_rebroadcast(2);
1160 fn fake_network_test() {
1161 // Simple test which builds a network of ChannelManagers, connects them to each other, and
1162 // tests that payments get routed and transactions broadcast in semi-reasonable ways.
1163 let chanmon_cfgs = create_chanmon_cfgs(4);
1164 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1165 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1166 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1168 // Create some initial channels
1169 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1170 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1171 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1173 // Rebalance the network a bit by relaying one payment through all the channels...
1174 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1175 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1176 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1177 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1179 // Send some more payments
1180 send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000, 1_000_000);
1181 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000, 1_000_000);
1182 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000, 1_000_000);
1184 // Test failure packets
1185 let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
1186 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
1188 // Add a new channel that skips 3
1189 let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1191 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000, 1_000_000);
1192 send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000, 1_000_000);
1193 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1194 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1195 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_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);
1199 // Do some rebalance loop payments, simultaneously
1200 let mut hops = Vec::with_capacity(3);
1201 hops.push(RouteHop {
1202 pubkey: nodes[2].node.get_our_node_id(),
1203 node_features: NodeFeatures::empty(),
1204 short_channel_id: chan_2.0.contents.short_channel_id,
1205 channel_features: ChannelFeatures::empty(),
1207 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
1209 hops.push(RouteHop {
1210 pubkey: nodes[3].node.get_our_node_id(),
1211 node_features: NodeFeatures::empty(),
1212 short_channel_id: chan_3.0.contents.short_channel_id,
1213 channel_features: ChannelFeatures::empty(),
1215 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
1217 hops.push(RouteHop {
1218 pubkey: nodes[1].node.get_our_node_id(),
1219 node_features: NodeFeatures::empty(),
1220 short_channel_id: chan_4.0.contents.short_channel_id,
1221 channel_features: ChannelFeatures::empty(),
1223 cltv_expiry_delta: TEST_FINAL_CLTV,
1225 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;
1226 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;
1227 let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
1229 let mut hops = Vec::with_capacity(3);
1230 hops.push(RouteHop {
1231 pubkey: nodes[3].node.get_our_node_id(),
1232 node_features: NodeFeatures::empty(),
1233 short_channel_id: chan_4.0.contents.short_channel_id,
1234 channel_features: ChannelFeatures::empty(),
1236 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
1238 hops.push(RouteHop {
1239 pubkey: nodes[2].node.get_our_node_id(),
1240 node_features: NodeFeatures::empty(),
1241 short_channel_id: chan_3.0.contents.short_channel_id,
1242 channel_features: ChannelFeatures::empty(),
1244 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
1246 hops.push(RouteHop {
1247 pubkey: nodes[1].node.get_our_node_id(),
1248 node_features: NodeFeatures::empty(),
1249 short_channel_id: chan_2.0.contents.short_channel_id,
1250 channel_features: ChannelFeatures::empty(),
1252 cltv_expiry_delta: TEST_FINAL_CLTV,
1254 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;
1255 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;
1256 let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1258 // Claim the rebalances...
1259 fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1260 claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1, 1_000_000);
1262 // Add a duplicate new channel from 2 to 4
1263 let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1265 // Send some payments across both channels
1266 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1267 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1268 let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1271 route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
1272 let events = nodes[0].node.get_and_clear_pending_msg_events();
1273 assert_eq!(events.len(), 0);
1274 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);
1276 //TODO: Test that routes work again here as we've been notified that the channel is full
1278 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3, 3_000_000);
1279 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4, 3_000_000);
1280 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5, 3_000_000);
1282 // Close down the channels...
1283 close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1284 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1285 close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1286 close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1287 close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
1291 fn holding_cell_htlc_counting() {
1292 // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1293 // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1294 // commitment dance rounds.
1295 let chanmon_cfgs = create_chanmon_cfgs(3);
1296 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1297 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1298 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1299 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1300 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1301 let logger = test_utils::TestLogger::new();
1303 let mut payments = Vec::new();
1304 for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1305 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1306 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1307 let route = get_route(&nodes[1].node.get_our_node_id(), net_graph_msg_handler, &nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1308 nodes[1].node.send_payment(&route, payment_hash, &None).unwrap();
1309 payments.push((payment_preimage, payment_hash));
1311 check_added_monitors!(nodes[1], 1);
1313 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1314 assert_eq!(events.len(), 1);
1315 let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1316 assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1318 // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1319 // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1321 let (_, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
1323 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1324 let route = get_route(&nodes[1].node.get_our_node_id(), net_graph_msg_handler, &nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1325 unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash_1, &None), true, APIError::ChannelUnavailable { err },
1326 assert_eq!(err, "Cannot push more than their max accepted HTLCs"));
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);
1331 // This should also be true if we try to forward a payment.
1332 let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
1334 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1335 let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1336 nodes[0].node.send_payment(&route, payment_hash_2, &None).unwrap();
1337 check_added_monitors!(nodes[0], 1);
1340 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1341 assert_eq!(events.len(), 1);
1342 let payment_event = SendEvent::from_event(events.pop().unwrap());
1343 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1345 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1346 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1347 // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1348 // fails), the second will process the resulting failure and fail the HTLC backward.
1349 expect_pending_htlcs_forwardable!(nodes[1]);
1350 expect_pending_htlcs_forwardable!(nodes[1]);
1351 check_added_monitors!(nodes[1], 1);
1353 let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1354 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1355 commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1357 let events = nodes[0].node.get_and_clear_pending_msg_events();
1358 assert_eq!(events.len(), 1);
1360 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
1361 assert_eq!(msg.contents.short_channel_id, chan_2.0.contents.short_channel_id);
1363 _ => panic!("Unexpected event"),
1366 expect_payment_failed!(nodes[0], payment_hash_2, false);
1368 // Now forward all the pending HTLCs and claim them back
1369 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1370 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1371 check_added_monitors!(nodes[2], 1);
1373 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1374 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1375 check_added_monitors!(nodes[1], 1);
1376 let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1378 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1379 check_added_monitors!(nodes[1], 1);
1380 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1382 for ref update in as_updates.update_add_htlcs.iter() {
1383 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1385 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1386 check_added_monitors!(nodes[2], 1);
1387 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1388 check_added_monitors!(nodes[2], 1);
1389 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1391 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1392 check_added_monitors!(nodes[1], 1);
1393 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1394 check_added_monitors!(nodes[1], 1);
1395 let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1397 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1398 check_added_monitors!(nodes[2], 1);
1400 expect_pending_htlcs_forwardable!(nodes[2]);
1402 let events = nodes[2].node.get_and_clear_pending_events();
1403 assert_eq!(events.len(), payments.len());
1404 for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1406 &Event::PaymentReceived { ref payment_hash, .. } => {
1407 assert_eq!(*payment_hash, *hash);
1409 _ => panic!("Unexpected event"),
1413 for (preimage, _) in payments.drain(..) {
1414 claim_payment(&nodes[1], &[&nodes[2]], preimage, 100_000);
1417 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000, 1_000_000);
1421 fn duplicate_htlc_test() {
1422 // Test that we accept duplicate payment_hash HTLCs across the network and that
1423 // claiming/failing them are all separate and don't affect each other
1424 let chanmon_cfgs = create_chanmon_cfgs(6);
1425 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1426 let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1427 let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1429 // Create some initial channels to route via 3 to 4/5 from 0/1/2
1430 create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
1431 create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1432 create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1433 create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
1434 create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
1436 let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1438 *nodes[0].network_payment_count.borrow_mut() -= 1;
1439 assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1441 *nodes[0].network_payment_count.borrow_mut() -= 1;
1442 assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1444 claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage, 1_000_000);
1445 fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1446 claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage, 1_000_000);
1450 fn test_duplicate_htlc_different_direction_onchain() {
1451 // Test that ChannelMonitor doesn't generate 2 preimage txn
1452 // when we have 2 HTLCs with same preimage that go across a node
1453 // in opposite directions.
1454 let chanmon_cfgs = create_chanmon_cfgs(2);
1455 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1456 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1457 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1459 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1460 let logger = test_utils::TestLogger::new();
1463 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
1465 let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1467 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1468 let route = get_route(&nodes[1].node.get_our_node_id(), net_graph_msg_handler, &nodes[0].node.get_our_node_id(), None, &Vec::new(), 800_000, TEST_FINAL_CLTV, &logger).unwrap();
1469 send_along_route_with_hash(&nodes[1], route, &vec!(&nodes[0])[..], 800_000, payment_hash);
1471 // Provide preimage to node 0 by claiming payment
1472 nodes[0].node.claim_funds(payment_preimage, &None, 800_000);
1473 check_added_monitors!(nodes[0], 1);
1475 // Broadcast node 1 commitment txn
1476 let remote_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
1478 assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1479 let mut has_both_htlcs = 0; // check htlcs match ones committed
1480 for outp in remote_txn[0].output.iter() {
1481 if outp.value == 800_000 / 1000 {
1482 has_both_htlcs += 1;
1483 } else if outp.value == 900_000 / 1000 {
1484 has_both_htlcs += 1;
1487 assert_eq!(has_both_htlcs, 2);
1489 let header = BlockHeader { version: 0x2000_0000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1490 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
1491 check_added_monitors!(nodes[0], 1);
1493 // Check we only broadcast 1 timeout tx
1494 let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1495 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()) };
1496 assert_eq!(claim_txn.len(), 5);
1497 check_spends!(claim_txn[2], chan_1.3);
1498 check_spends!(claim_txn[3], claim_txn[2]);
1499 assert_eq!(htlc_pair.0.input.len(), 1);
1500 assert_eq!(htlc_pair.0.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1501 check_spends!(htlc_pair.0, remote_txn[0]);
1502 assert_eq!(htlc_pair.1.input.len(), 1);
1503 assert_eq!(htlc_pair.1.input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1504 check_spends!(htlc_pair.1, remote_txn[0]);
1506 let events = nodes[0].node.get_and_clear_pending_msg_events();
1507 assert_eq!(events.len(), 2);
1510 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1511 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, .. } } => {
1512 assert!(update_add_htlcs.is_empty());
1513 assert!(update_fail_htlcs.is_empty());
1514 assert_eq!(update_fulfill_htlcs.len(), 1);
1515 assert!(update_fail_malformed_htlcs.is_empty());
1516 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1518 _ => panic!("Unexpected event"),
1524 fn test_basic_channel_reserve() {
1525 let chanmon_cfgs = create_chanmon_cfgs(2);
1526 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1527 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1528 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1529 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1530 let logger = test_utils::TestLogger::new();
1532 let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1533 let channel_reserve = chan_stat.channel_reserve_msat;
1535 // The 2* and +1 are for the fee spike reserve.
1536 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
1537 let commit_tx_fee = 2 * commit_tx_fee_msat(get_feerate!(nodes[0], chan.2), 1 + 1);
1538 let max_can_send = 5000000 - channel_reserve - commit_tx_fee;
1539 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1540 let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes.last().unwrap().node.get_our_node_id(), None, &Vec::new(), max_can_send + 1, TEST_FINAL_CLTV, &logger).unwrap();
1541 let err = nodes[0].node.send_payment(&route, our_payment_hash, &None).err().unwrap();
1543 PaymentSendFailure::AllFailedRetrySafe(ref fails) => {
1545 APIError::ChannelUnavailable{err} =>
1546 assert_eq!(err, "Cannot send value that would put us under local channel reserve value"),
1547 _ => panic!("Unexpected error variant"),
1550 _ => panic!("Unexpected error variant"),
1552 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1553 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us under local channel reserve value".to_string(), 1);
1555 send_payment(&nodes[0], &vec![&nodes[1]], max_can_send, max_can_send);
1559 fn test_chan_reserve_violation_outbound_htlc_inbound_chan() {
1560 let mut chanmon_cfgs = create_chanmon_cfgs(2);
1561 // Set the fee rate for the channel very high, to the point where the fundee
1562 // sending any amount would result in a channel reserve violation. In this test
1563 // we check that we would be prevented from sending an HTLC in this situation.
1564 chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1565 chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1566 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1567 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1568 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1569 let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1570 let logger = test_utils::TestLogger::new();
1572 macro_rules! get_route_and_payment_hash {
1573 ($recv_value: expr) => {{
1574 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[1]);
1575 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1576 let route = get_route(&nodes[1].node.get_our_node_id(), net_graph_msg_handler, &nodes.first().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1577 (route, payment_hash, payment_preimage)
1581 let (route, our_payment_hash, _) = get_route_and_payment_hash!(1000);
1582 unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
1583 assert_eq!(err, "Cannot send value that would put them under remote channel reserve value"));
1584 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1585 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put them under remote channel reserve value".to_string(), 1);
1589 fn test_chan_reserve_violation_inbound_htlc_outbound_channel() {
1590 let mut chanmon_cfgs = create_chanmon_cfgs(2);
1591 // Set the fee rate for the channel very high, to the point where the funder
1592 // receiving 1 update_add_htlc would result in them closing the channel due
1593 // to channel reserve violation. This close could also happen if the fee went
1594 // up a more realistic amount, but many HTLCs were outstanding at the time of
1595 // the update_add_htlc.
1596 chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1597 chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1598 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1599 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1600 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1601 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1602 let logger = test_utils::TestLogger::new();
1604 macro_rules! get_route_and_payment_hash {
1605 ($recv_value: expr) => {{
1606 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[1]);
1607 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1608 let route = get_route(&nodes[1].node.get_our_node_id(), net_graph_msg_handler, &nodes.first().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1609 (route, payment_hash, payment_preimage)
1613 let (route, payment_hash, _) = get_route_and_payment_hash!(1000);
1614 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1615 let secp_ctx = Secp256k1::new();
1616 let session_priv = SecretKey::from_slice(&{
1617 let mut session_key = [0; 32];
1618 let mut rng = thread_rng();
1619 rng.fill_bytes(&mut session_key);
1621 }).expect("RNG is bad!");
1623 let cur_height = nodes[1].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1625 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1626 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 1000, &None, cur_height).unwrap();
1627 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1628 let msg = msgs::UpdateAddHTLC {
1631 amount_msat: htlc_msat + 1,
1632 payment_hash: payment_hash,
1633 cltv_expiry: htlc_cltv,
1634 onion_routing_packet: onion_packet,
1637 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &msg);
1638 // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1639 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot receive value that would put us under local channel reserve value".to_string(), 1);
1640 assert_eq!(nodes[0].node.list_channels().len(), 0);
1641 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
1642 assert_eq!(err_msg.data, "Cannot receive value that would put us under local channel reserve value");
1643 check_added_monitors!(nodes[0], 1);
1647 fn test_chan_reserve_violation_inbound_htlc_inbound_chan() {
1648 let chanmon_cfgs = create_chanmon_cfgs(3);
1649 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1650 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1651 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1652 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1653 let _ = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1654 let logger = test_utils::TestLogger::new();
1656 macro_rules! get_route_and_payment_hash {
1657 ($recv_value: expr) => {{
1658 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1659 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1660 let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes.last().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1661 (route, payment_hash, payment_preimage)
1666 let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1667 let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1668 let feerate = get_feerate!(nodes[0], chan.2);
1670 // Add a 2* and +1 for the fee spike reserve.
1671 let commit_tx_fee_2_htlc = 2*commit_tx_fee_msat(feerate, 2 + 1);
1672 let recv_value_1 = (chan_stat.value_to_self_msat - chan_stat.channel_reserve_msat - total_routing_fee_msat - commit_tx_fee_2_htlc)/2;
1673 let amt_msat_1 = recv_value_1 + total_routing_fee_msat;
1675 // Add a pending HTLC.
1676 let (route_1, our_payment_hash_1, _) = get_route_and_payment_hash!(amt_msat_1);
1677 let payment_event_1 = {
1678 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &None).unwrap();
1679 check_added_monitors!(nodes[0], 1);
1681 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1682 assert_eq!(events.len(), 1);
1683 SendEvent::from_event(events.remove(0))
1685 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1687 // Attempt to trigger a channel reserve violation --> payment failure.
1688 let commit_tx_fee_2_htlcs = commit_tx_fee_msat(feerate, 2);
1689 let recv_value_2 = chan_stat.value_to_self_msat - amt_msat_1 - chan_stat.channel_reserve_msat - total_routing_fee_msat - commit_tx_fee_2_htlcs + 1;
1690 let amt_msat_2 = recv_value_2 + total_routing_fee_msat;
1691 let (route_2, _, _) = get_route_and_payment_hash!(amt_msat_2);
1693 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1694 let secp_ctx = Secp256k1::new();
1695 let session_priv = SecretKey::from_slice(&{
1696 let mut session_key = [0; 32];
1697 let mut rng = thread_rng();
1698 rng.fill_bytes(&mut session_key);
1700 }).expect("RNG is bad!");
1702 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1704 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route_2.paths[0], &session_priv).unwrap();
1705 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route_2.paths[0], recv_value_2, &None, cur_height).unwrap();
1706 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash_1);
1707 let msg = msgs::UpdateAddHTLC {
1710 amount_msat: htlc_msat + 1,
1711 payment_hash: our_payment_hash_1,
1712 cltv_expiry: htlc_cltv,
1713 onion_routing_packet: onion_packet,
1716 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1717 // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1718 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote HTLC add would put them under remote reserve value".to_string(), 1);
1719 assert_eq!(nodes[1].node.list_channels().len(), 1);
1720 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1721 assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
1722 check_added_monitors!(nodes[1], 1);
1725 fn commit_tx_fee_msat(feerate: u32, num_htlcs: u64) -> u64 {
1726 (COMMITMENT_TX_BASE_WEIGHT + num_htlcs * COMMITMENT_TX_WEIGHT_PER_HTLC) * feerate as u64 / 1000 * 1000
1730 fn test_channel_reserve_holding_cell_htlcs() {
1731 let chanmon_cfgs = create_chanmon_cfgs(3);
1732 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1733 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1734 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1735 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1736 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1737 let logger = test_utils::TestLogger::new();
1739 let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1740 let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1742 let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1743 let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1745 macro_rules! get_route_and_payment_hash {
1746 ($recv_value: expr) => {{
1747 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1748 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1749 let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes.last().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1750 (route, payment_hash, payment_preimage)
1754 macro_rules! expect_forward {
1756 let mut events = $node.node.get_and_clear_pending_msg_events();
1757 assert_eq!(events.len(), 1);
1758 check_added_monitors!($node, 1);
1759 let payment_event = SendEvent::from_event(events.remove(0));
1764 let feemsat = 239; // somehow we know?
1765 let total_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1766 let feerate = get_feerate!(nodes[0], chan_1.2);
1768 let recv_value_0 = stat01.their_max_htlc_value_in_flight_msat - total_fee_msat;
1770 // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1772 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_0 + 1);
1773 assert!(route.paths[0].iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1774 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
1775 assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight our peer will accept"));
1776 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1777 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);
1780 // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1781 // nodes[0]'s wealth
1783 let amt_msat = recv_value_0 + total_fee_msat;
1784 // 3 for the 3 HTLCs that will be sent, 2* and +1 for the fee spike reserve.
1785 // Also, ensure that each payment has enough to be over the dust limit to
1786 // ensure it'll be included in each commit tx fee calculation.
1787 let commit_tx_fee_all_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1788 let ensure_htlc_amounts_above_dust_buffer = 3 * (stat01.their_dust_limit_msat + 1000);
1789 if stat01.value_to_self_msat < stat01.channel_reserve_msat + commit_tx_fee_all_htlcs + ensure_htlc_amounts_above_dust_buffer + amt_msat {
1792 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0, recv_value_0);
1794 let (stat01_, stat11_, stat12_, stat22_) = (
1795 get_channel_value_stat!(nodes[0], chan_1.2),
1796 get_channel_value_stat!(nodes[1], chan_1.2),
1797 get_channel_value_stat!(nodes[1], chan_2.2),
1798 get_channel_value_stat!(nodes[2], chan_2.2),
1801 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1802 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1803 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1804 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1805 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1808 // adding pending output.
1809 // 2* and +1 HTLCs on the commit tx fee for the fee spike reserve.
1810 // The reason we're dividing by two here is as follows: the dividend is the total outbound liquidity
1811 // after fees, the channel reserve, and the fee spike buffer are removed. We eventually want to
1812 // divide this quantity into 3 portions, that will each be sent in an HTLC. This allows us
1813 // to test channel channel reserve policy at the edges of what amount is sendable, i.e.
1814 // cases where 1 msat over X amount will cause a payment failure, but anything less than
1815 // that can be sent successfully. So, dividing by two is a somewhat arbitrary way of getting
1816 // the amount of the first of these aforementioned 3 payments. The reason we split into 3 payments
1817 // is to test the behavior of the holding cell with respect to channel reserve and commit tx fee
1819 let commit_tx_fee_2_htlcs = 2*commit_tx_fee_msat(feerate, 2 + 1);
1820 let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs)/2;
1821 let amt_msat_1 = recv_value_1 + total_fee_msat;
1823 let (route_1, our_payment_hash_1, our_payment_preimage_1) = get_route_and_payment_hash!(recv_value_1);
1824 let payment_event_1 = {
1825 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &None).unwrap();
1826 check_added_monitors!(nodes[0], 1);
1828 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1829 assert_eq!(events.len(), 1);
1830 SendEvent::from_event(events.remove(0))
1832 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1834 // channel reserve test with htlc pending output > 0
1835 let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs;
1837 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
1838 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
1839 assert_eq!(err, "Cannot send value that would put us under local channel reserve value"));
1840 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1843 // split the rest to test holding cell
1844 let commit_tx_fee_3_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1845 let additional_htlc_cost_msat = commit_tx_fee_3_htlcs - commit_tx_fee_2_htlcs;
1846 let recv_value_21 = recv_value_2/2 - additional_htlc_cost_msat/2;
1847 let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat - additional_htlc_cost_msat;
1849 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
1850 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 + commit_tx_fee_3_htlcs), stat.channel_reserve_msat);
1853 // now see if they go through on both sides
1854 let (route_21, our_payment_hash_21, our_payment_preimage_21) = get_route_and_payment_hash!(recv_value_21);
1855 // but this will stuck in the holding cell
1856 nodes[0].node.send_payment(&route_21, our_payment_hash_21, &None).unwrap();
1857 check_added_monitors!(nodes[0], 0);
1858 let events = nodes[0].node.get_and_clear_pending_events();
1859 assert_eq!(events.len(), 0);
1861 // test with outbound holding cell amount > 0
1863 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_22+1);
1864 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
1865 assert_eq!(err, "Cannot send value that would put us under local channel reserve value"));
1866 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1867 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us under local channel reserve value".to_string(), 2);
1870 let (route_22, our_payment_hash_22, our_payment_preimage_22) = get_route_and_payment_hash!(recv_value_22);
1871 // this will also stuck in the holding cell
1872 nodes[0].node.send_payment(&route_22, our_payment_hash_22, &None).unwrap();
1873 check_added_monitors!(nodes[0], 0);
1874 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1875 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1877 // flush the pending htlc
1878 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
1879 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1880 check_added_monitors!(nodes[1], 1);
1882 // the pending htlc should be promoted to committed
1883 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
1884 check_added_monitors!(nodes[0], 1);
1885 let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1887 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
1888 let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1889 // No commitment_signed so get_event_msg's assert(len == 1) passes
1890 check_added_monitors!(nodes[0], 1);
1892 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
1893 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1894 check_added_monitors!(nodes[1], 1);
1896 expect_pending_htlcs_forwardable!(nodes[1]);
1898 let ref payment_event_11 = expect_forward!(nodes[1]);
1899 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
1900 commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
1902 expect_pending_htlcs_forwardable!(nodes[2]);
1903 expect_payment_received!(nodes[2], our_payment_hash_1, recv_value_1);
1905 // flush the htlcs in the holding cell
1906 assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
1907 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
1908 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
1909 commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
1910 expect_pending_htlcs_forwardable!(nodes[1]);
1912 let ref payment_event_3 = expect_forward!(nodes[1]);
1913 assert_eq!(payment_event_3.msgs.len(), 2);
1914 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
1915 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
1917 commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
1918 expect_pending_htlcs_forwardable!(nodes[2]);
1920 let events = nodes[2].node.get_and_clear_pending_events();
1921 assert_eq!(events.len(), 2);
1923 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
1924 assert_eq!(our_payment_hash_21, *payment_hash);
1925 assert_eq!(*payment_secret, None);
1926 assert_eq!(recv_value_21, amt);
1928 _ => panic!("Unexpected event"),
1931 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
1932 assert_eq!(our_payment_hash_22, *payment_hash);
1933 assert_eq!(None, *payment_secret);
1934 assert_eq!(recv_value_22, amt);
1936 _ => panic!("Unexpected event"),
1939 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1, recv_value_1);
1940 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21, recv_value_21);
1941 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22, recv_value_22);
1943 let commit_tx_fee_0_htlcs = 2*commit_tx_fee_msat(feerate, 1);
1944 let recv_value_3 = commit_tx_fee_2_htlcs - commit_tx_fee_0_htlcs - total_fee_msat;
1946 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_3 + 1);
1947 let err = nodes[0].node.send_payment(&route, our_payment_hash, &None).err().unwrap();
1949 PaymentSendFailure::AllFailedRetrySafe(ref fails) => {
1951 APIError::ChannelUnavailable{err} =>
1952 assert_eq!(err, "Cannot send value that would put us under local channel reserve value"),
1953 _ => panic!("Unexpected error variant"),
1956 _ => panic!("Unexpected error variant"),
1958 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1959 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us under local channel reserve value".to_string(), 3);
1962 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_3, recv_value_3);
1964 let commit_tx_fee_1_htlc = 2*commit_tx_fee_msat(feerate, 1 + 1);
1965 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) - (recv_value_3 + total_fee_msat);
1966 let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
1967 assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
1968 assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat + commit_tx_fee_1_htlc);
1970 let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
1971 assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22 + recv_value_3);
1975 fn channel_reserve_in_flight_removes() {
1976 // In cases where one side claims an HTLC, it thinks it has additional available funds that it
1977 // can send to its counterparty, but due to update ordering, the other side may not yet have
1978 // considered those HTLCs fully removed.
1979 // This tests that we don't count HTLCs which will not be included in the next remote
1980 // commitment transaction towards the reserve value (as it implies no commitment transaction
1981 // will be generated which violates the remote reserve value).
1982 // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
1984 // * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
1985 // you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
1986 // you only consider the value of the first HTLC, it may not),
1987 // * start routing a third HTLC from A to B,
1988 // * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
1989 // the other claim in its holding cell, as it immediately goes into AwaitingRAA),
1990 // * deliver the first fulfill from B
1991 // * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
1993 // * deliver A's response CS and RAA.
1994 // This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
1995 // removed it fully. B now has the push_msat plus the first two HTLCs in value.
1996 // * Now B happily sends another HTLC, potentially violating its reserve value from A's point
1997 // of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
1998 let chanmon_cfgs = create_chanmon_cfgs(2);
1999 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2000 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2001 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2002 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2003 let logger = test_utils::TestLogger::new();
2005 let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
2006 // Route the first two HTLCs.
2007 let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
2008 let (payment_preimage_2, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
2010 // Start routing the third HTLC (this is just used to get everyone in the right state).
2011 let (payment_preimage_3, payment_hash_3) = get_payment_preimage_hash!(nodes[0]);
2013 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
2014 let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
2015 nodes[0].node.send_payment(&route, payment_hash_3, &None).unwrap();
2016 check_added_monitors!(nodes[0], 1);
2017 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2018 assert_eq!(events.len(), 1);
2019 SendEvent::from_event(events.remove(0))
2022 // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
2023 // initial fulfill/CS.
2024 assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000));
2025 check_added_monitors!(nodes[1], 1);
2026 let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2028 // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
2029 // remove the second HTLC when we send the HTLC back from B to A.
2030 assert!(nodes[1].node.claim_funds(payment_preimage_2, &None, 20000));
2031 check_added_monitors!(nodes[1], 1);
2032 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2034 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
2035 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
2036 check_added_monitors!(nodes[0], 1);
2037 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2038 expect_payment_sent!(nodes[0], payment_preimage_1);
2040 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
2041 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
2042 check_added_monitors!(nodes[1], 1);
2043 // B is already AwaitingRAA, so cant generate a CS here
2044 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2046 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2047 check_added_monitors!(nodes[1], 1);
2048 let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2050 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2051 check_added_monitors!(nodes[0], 1);
2052 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2054 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2055 check_added_monitors!(nodes[1], 1);
2056 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2058 // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
2059 // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
2060 // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
2061 // can no longer broadcast a commitment transaction with it and B has the preimage so can go
2062 // on-chain as necessary).
2063 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
2064 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
2065 check_added_monitors!(nodes[0], 1);
2066 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2067 expect_payment_sent!(nodes[0], payment_preimage_2);
2069 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2070 check_added_monitors!(nodes[1], 1);
2071 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2073 expect_pending_htlcs_forwardable!(nodes[1]);
2074 expect_payment_received!(nodes[1], payment_hash_3, 100000);
2076 // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
2077 // resolve the second HTLC from A's point of view.
2078 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2079 check_added_monitors!(nodes[0], 1);
2080 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2082 // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
2083 // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
2084 let (payment_preimage_4, payment_hash_4) = get_payment_preimage_hash!(nodes[1]);
2086 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
2087 let route = get_route(&nodes[1].node.get_our_node_id(), net_graph_msg_handler, &nodes[0].node.get_our_node_id(), None, &[], 10000, TEST_FINAL_CLTV, &logger).unwrap();
2088 nodes[1].node.send_payment(&route, payment_hash_4, &None).unwrap();
2089 check_added_monitors!(nodes[1], 1);
2090 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
2091 assert_eq!(events.len(), 1);
2092 SendEvent::from_event(events.remove(0))
2095 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
2096 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
2097 check_added_monitors!(nodes[0], 1);
2098 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2100 // Now just resolve all the outstanding messages/HTLCs for completeness...
2102 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2103 check_added_monitors!(nodes[1], 1);
2104 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2106 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2107 check_added_monitors!(nodes[1], 1);
2109 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2110 check_added_monitors!(nodes[0], 1);
2111 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2113 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2114 check_added_monitors!(nodes[1], 1);
2115 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2117 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2118 check_added_monitors!(nodes[0], 1);
2120 expect_pending_htlcs_forwardable!(nodes[0]);
2121 expect_payment_received!(nodes[0], payment_hash_4, 10000);
2123 claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4, 10_000);
2124 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3, 100_000);
2128 fn channel_monitor_network_test() {
2129 // Simple test which builds a network of ChannelManagers, connects them to each other, and
2130 // tests that ChannelMonitor is able to recover from various states.
2131 let chanmon_cfgs = create_chanmon_cfgs(5);
2132 let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
2133 let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
2134 let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
2136 // Create some initial channels
2137 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2138 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2139 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
2140 let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
2142 // Rebalance the network a bit by relaying one payment through all the channels...
2143 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2144 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2145 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2146 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2148 // Simple case with no pending HTLCs:
2149 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
2150 check_added_monitors!(nodes[1], 1);
2152 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
2153 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2154 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
2155 check_added_monitors!(nodes[0], 1);
2156 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
2158 get_announce_close_broadcast_events(&nodes, 0, 1);
2159 assert_eq!(nodes[0].node.list_channels().len(), 0);
2160 assert_eq!(nodes[1].node.list_channels().len(), 1);
2162 // One pending HTLC is discarded by the force-close:
2163 let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
2165 // Simple case of one pending HTLC to HTLC-Timeout
2166 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
2167 check_added_monitors!(nodes[1], 1);
2169 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
2170 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2171 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
2172 check_added_monitors!(nodes[2], 1);
2173 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
2175 get_announce_close_broadcast_events(&nodes, 1, 2);
2176 assert_eq!(nodes[1].node.list_channels().len(), 0);
2177 assert_eq!(nodes[2].node.list_channels().len(), 1);
2179 macro_rules! claim_funds {
2180 ($node: expr, $prev_node: expr, $preimage: expr, $amount: expr) => {
2182 assert!($node.node.claim_funds($preimage, &None, $amount));
2183 check_added_monitors!($node, 1);
2185 let events = $node.node.get_and_clear_pending_msg_events();
2186 assert_eq!(events.len(), 1);
2188 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2189 assert!(update_add_htlcs.is_empty());
2190 assert!(update_fail_htlcs.is_empty());
2191 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2193 _ => panic!("Unexpected event"),
2199 // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2200 // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2201 nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2202 check_added_monitors!(nodes[2], 1);
2203 let node2_commitment_txid;
2205 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2206 node2_commitment_txid = node_txn[0].txid();
2208 // Claim the payment on nodes[3], giving it knowledge of the preimage
2209 claim_funds!(nodes[3], nodes[2], payment_preimage_1, 3_000_000);
2211 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2212 nodes[3].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 1);
2213 check_added_monitors!(nodes[3], 1);
2215 check_preimage_claim(&nodes[3], &node_txn);
2217 get_announce_close_broadcast_events(&nodes, 2, 3);
2218 assert_eq!(nodes[2].node.list_channels().len(), 0);
2219 assert_eq!(nodes[3].node.list_channels().len(), 1);
2221 { // Cheat and reset nodes[4]'s height to 1
2222 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2223 nodes[4].block_notifier.block_connected(&Block { header, txdata: vec![] }, 1);
2226 assert_eq!(nodes[3].node.latest_block_height.load(Ordering::Acquire), 1);
2227 assert_eq!(nodes[4].node.latest_block_height.load(Ordering::Acquire), 1);
2228 // One pending HTLC to time out:
2229 let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2230 // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2234 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2235 nodes[3].block_notifier.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
2236 for i in 3..TEST_FINAL_CLTV + 2 + LATENCY_GRACE_PERIOD_BLOCKS + 1 {
2237 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2238 nodes[3].block_notifier.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
2240 check_added_monitors!(nodes[3], 1);
2242 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2244 let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2245 node_txn.retain(|tx| {
2246 if tx.input[0].previous_output.txid == node2_commitment_txid {
2252 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2254 // Claim the payment on nodes[4], giving it knowledge of the preimage
2255 claim_funds!(nodes[4], nodes[3], payment_preimage_2, 3_000_000);
2257 header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2259 nodes[4].block_notifier.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
2260 for i in 3..TEST_FINAL_CLTV + 2 - CLTV_CLAIM_BUFFER + 1 {
2261 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2262 nodes[4].block_notifier.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
2265 check_added_monitors!(nodes[4], 1);
2266 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2268 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2269 nodes[4].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, TEST_FINAL_CLTV - 5);
2271 check_preimage_claim(&nodes[4], &node_txn);
2273 get_announce_close_broadcast_events(&nodes, 3, 4);
2274 assert_eq!(nodes[3].node.list_channels().len(), 0);
2275 assert_eq!(nodes[4].node.list_channels().len(), 0);
2279 fn test_justice_tx() {
2280 // Test justice txn built on revoked HTLC-Success tx, against both sides
2281 let mut alice_config = UserConfig::default();
2282 alice_config.channel_options.announced_channel = true;
2283 alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2284 alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2285 let mut bob_config = UserConfig::default();
2286 bob_config.channel_options.announced_channel = true;
2287 bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2288 bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2289 let user_cfgs = [Some(alice_config), Some(bob_config)];
2290 let chanmon_cfgs = create_chanmon_cfgs(2);
2291 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2292 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2293 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2294 // Create some new channels:
2295 let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2297 // A pending HTLC which will be revoked:
2298 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2299 // Get the will-be-revoked local txn from nodes[0]
2300 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2301 assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2302 assert_eq!(revoked_local_txn[0].input.len(), 1);
2303 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2304 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2305 assert_eq!(revoked_local_txn[1].input.len(), 1);
2306 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2307 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2308 // Revoke the old state
2309 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 3_000_000);
2312 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2313 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2315 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2316 assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2317 assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2319 check_spends!(node_txn[0], revoked_local_txn[0]);
2320 node_txn.swap_remove(0);
2321 node_txn.truncate(1);
2323 check_added_monitors!(nodes[1], 1);
2324 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2326 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2327 // Verify broadcast of revoked HTLC-timeout
2328 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2329 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2330 check_added_monitors!(nodes[0], 1);
2331 // Broadcast revoked HTLC-timeout on node 1
2332 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2333 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2335 get_announce_close_broadcast_events(&nodes, 0, 1);
2337 assert_eq!(nodes[0].node.list_channels().len(), 0);
2338 assert_eq!(nodes[1].node.list_channels().len(), 0);
2340 // We test justice_tx build by A on B's revoked HTLC-Success tx
2341 // Create some new channels:
2342 let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2344 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2348 // A pending HTLC which will be revoked:
2349 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2350 // Get the will-be-revoked local txn from B
2351 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2352 assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2353 assert_eq!(revoked_local_txn[0].input.len(), 1);
2354 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2355 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2356 // Revoke the old state
2357 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4, 3_000_000);
2359 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2360 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2362 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2363 assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2364 assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2366 check_spends!(node_txn[0], revoked_local_txn[0]);
2367 node_txn.swap_remove(0);
2369 check_added_monitors!(nodes[0], 1);
2370 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2372 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2373 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2374 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2375 check_added_monitors!(nodes[1], 1);
2376 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2377 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2379 get_announce_close_broadcast_events(&nodes, 0, 1);
2380 assert_eq!(nodes[0].node.list_channels().len(), 0);
2381 assert_eq!(nodes[1].node.list_channels().len(), 0);
2385 fn revoked_output_claim() {
2386 // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2387 // transaction is broadcast by its counterparty
2388 let chanmon_cfgs = create_chanmon_cfgs(2);
2389 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2390 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2391 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2392 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2393 // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2394 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2395 assert_eq!(revoked_local_txn.len(), 1);
2396 // Only output is the full channel value back to nodes[0]:
2397 assert_eq!(revoked_local_txn[0].output.len(), 1);
2398 // Send a payment through, updating everyone's latest commitment txn
2399 send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000, 5_000_000);
2401 // Inform nodes[1] that nodes[0] broadcast a stale tx
2402 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2403 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2404 check_added_monitors!(nodes[1], 1);
2405 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2406 assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2408 check_spends!(node_txn[0], revoked_local_txn[0]);
2409 check_spends!(node_txn[1], chan_1.3);
2411 // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2412 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2413 get_announce_close_broadcast_events(&nodes, 0, 1);
2414 check_added_monitors!(nodes[0], 1)
2418 fn claim_htlc_outputs_shared_tx() {
2419 // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2420 let chanmon_cfgs = create_chanmon_cfgs(2);
2421 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2422 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2423 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2425 // Create some new channel:
2426 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2428 // Rebalance the network to generate htlc in the two directions
2429 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2430 // 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
2431 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2432 let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2434 // Get the will-be-revoked local txn from node[0]
2435 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2436 assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2437 assert_eq!(revoked_local_txn[0].input.len(), 1);
2438 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2439 assert_eq!(revoked_local_txn[1].input.len(), 1);
2440 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2441 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2442 check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2444 //Revoke the old state
2445 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2448 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2449 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2450 check_added_monitors!(nodes[0], 1);
2451 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2452 check_added_monitors!(nodes[1], 1);
2453 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2454 expect_payment_failed!(nodes[1], payment_hash_2, true);
2456 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2457 assert_eq!(node_txn.len(), 3); // ChannelMonitor: penalty tx, ChannelManager: local commitment + HTLC-timeout
2459 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2460 check_spends!(node_txn[0], revoked_local_txn[0]);
2462 let mut witness_lens = BTreeSet::new();
2463 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2464 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2465 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2466 assert_eq!(witness_lens.len(), 3);
2467 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2468 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2469 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2471 // Next nodes[1] broadcasts its current local tx state:
2472 assert_eq!(node_txn[1].input.len(), 1);
2473 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2475 assert_eq!(node_txn[2].input.len(), 1);
2476 let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
2477 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2478 assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
2479 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2480 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
2482 get_announce_close_broadcast_events(&nodes, 0, 1);
2483 assert_eq!(nodes[0].node.list_channels().len(), 0);
2484 assert_eq!(nodes[1].node.list_channels().len(), 0);
2488 fn claim_htlc_outputs_single_tx() {
2489 // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2490 let chanmon_cfgs = create_chanmon_cfgs(2);
2491 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2492 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2493 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2495 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2497 // Rebalance the network to generate htlc in the two directions
2498 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2499 // 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
2500 // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2501 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2502 let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2504 // Get the will-be-revoked local txn from node[0]
2505 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2507 //Revoke the old state
2508 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2511 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2512 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2513 check_added_monitors!(nodes[0], 1);
2514 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2515 check_added_monitors!(nodes[1], 1);
2516 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
2518 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
2519 expect_payment_failed!(nodes[1], payment_hash_2, true);
2521 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2522 assert_eq!(node_txn.len(), 9);
2523 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2524 // ChannelManager: local commmitment + local HTLC-timeout (2)
2525 // ChannelMonitor: bumped justice tx, after one increase, bumps on HTLC aren't generated not being substantial anymore, bump on revoked to_local isn't generated due to more room for expiration (2)
2526 // ChannelMonitor: local commitment + local HTLC-timeout (2)
2528 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2529 assert_eq!(node_txn[2].input.len(), 1);
2530 check_spends!(node_txn[2], chan_1.3);
2531 assert_eq!(node_txn[3].input.len(), 1);
2532 let witness_script = node_txn[3].input[0].witness.last().unwrap();
2533 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2534 check_spends!(node_txn[3], node_txn[2]);
2536 // Justice transactions are indices 1-2-4
2537 assert_eq!(node_txn[0].input.len(), 1);
2538 assert_eq!(node_txn[1].input.len(), 1);
2539 assert_eq!(node_txn[4].input.len(), 1);
2541 check_spends!(node_txn[0], revoked_local_txn[0]);
2542 check_spends!(node_txn[1], revoked_local_txn[0]);
2543 check_spends!(node_txn[4], revoked_local_txn[0]);
2545 let mut witness_lens = BTreeSet::new();
2546 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2547 witness_lens.insert(node_txn[1].input[0].witness.last().unwrap().len());
2548 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2549 assert_eq!(witness_lens.len(), 3);
2550 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2551 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2552 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2554 get_announce_close_broadcast_events(&nodes, 0, 1);
2555 assert_eq!(nodes[0].node.list_channels().len(), 0);
2556 assert_eq!(nodes[1].node.list_channels().len(), 0);
2560 fn test_htlc_on_chain_success() {
2561 // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2562 // ChainWatchInterface and pass the preimage backward accordingly. So here we test that ChannelManager is
2563 // broadcasting the right event to other nodes in payment path.
2564 // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2565 // A --------------------> B ----------------------> C (preimage)
2566 // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2567 // commitment transaction was broadcast.
2568 // Then, B should learn the preimage from said transactions, attempting to claim backwards
2570 // B should be able to claim via preimage if A then broadcasts its local tx.
2571 // Finally, when A sees B's latest local commitment transaction it should be able to claim
2572 // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2573 // PaymentSent event).
2575 let chanmon_cfgs = create_chanmon_cfgs(3);
2576 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2577 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2578 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2580 // Create some initial channels
2581 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2582 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2584 // Rebalance the network a bit by relaying one payment through all the channels...
2585 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2586 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2588 let (our_payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2589 let (our_payment_preimage_2, _payment_hash_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2590 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2592 // Broadcast legit commitment tx from C on B's chain
2593 // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2594 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2595 assert_eq!(commitment_tx.len(), 1);
2596 check_spends!(commitment_tx[0], chan_2.3);
2597 nodes[2].node.claim_funds(our_payment_preimage, &None, 3_000_000);
2598 nodes[2].node.claim_funds(our_payment_preimage_2, &None, 3_000_000);
2599 check_added_monitors!(nodes[2], 2);
2600 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2601 assert!(updates.update_add_htlcs.is_empty());
2602 assert!(updates.update_fail_htlcs.is_empty());
2603 assert!(updates.update_fail_malformed_htlcs.is_empty());
2604 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2606 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2607 check_closed_broadcast!(nodes[2], false);
2608 check_added_monitors!(nodes[2], 1);
2609 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx, 2*htlc-success tx), ChannelMonitor : 2 (2 * HTLC-Success tx)
2610 assert_eq!(node_txn.len(), 5);
2611 assert_eq!(node_txn[0], node_txn[3]);
2612 assert_eq!(node_txn[1], node_txn[4]);
2613 assert_eq!(node_txn[2], commitment_tx[0]);
2614 check_spends!(node_txn[0], commitment_tx[0]);
2615 check_spends!(node_txn[1], commitment_tx[0]);
2616 assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2617 assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2618 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2619 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2620 assert_eq!(node_txn[0].lock_time, 0);
2621 assert_eq!(node_txn[1].lock_time, 0);
2623 // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2624 nodes[1].block_notifier.block_connected(&Block { header, txdata: node_txn}, 1);
2626 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
2627 assert_eq!(added_monitors.len(), 1);
2628 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2629 added_monitors.clear();
2631 let events = nodes[1].node.get_and_clear_pending_msg_events();
2633 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
2634 assert_eq!(added_monitors.len(), 2);
2635 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2636 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2637 added_monitors.clear();
2639 assert_eq!(events.len(), 2);
2641 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2642 _ => panic!("Unexpected event"),
2645 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, .. } } => {
2646 assert!(update_add_htlcs.is_empty());
2647 assert!(update_fail_htlcs.is_empty());
2648 assert_eq!(update_fulfill_htlcs.len(), 1);
2649 assert!(update_fail_malformed_htlcs.is_empty());
2650 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2652 _ => panic!("Unexpected event"),
2654 macro_rules! check_tx_local_broadcast {
2655 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2656 let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2657 assert_eq!(node_txn.len(), 5);
2658 // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2659 // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout
2660 check_spends!(node_txn[0], $commitment_tx);
2661 check_spends!(node_txn[1], $commitment_tx);
2662 assert_ne!(node_txn[0].lock_time, 0);
2663 assert_ne!(node_txn[1].lock_time, 0);
2665 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2666 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2667 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2668 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2670 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2671 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2672 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2673 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2675 check_spends!(node_txn[2], $chan_tx);
2676 check_spends!(node_txn[3], node_txn[2]);
2677 check_spends!(node_txn[4], node_txn[2]);
2678 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), 71);
2679 assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2680 assert_eq!(node_txn[4].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2681 assert!(node_txn[3].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2682 assert!(node_txn[4].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2683 assert_ne!(node_txn[3].lock_time, 0);
2684 assert_ne!(node_txn[4].lock_time, 0);
2688 // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2689 // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2690 // timeout-claim of the output that nodes[2] just claimed via success.
2691 check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2693 // Broadcast legit commitment tx from A on B's chain
2694 // Broadcast preimage tx by B on offered output from A commitment tx on A's chain
2695 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2696 check_spends!(commitment_tx[0], chan_1.3);
2697 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2698 check_closed_broadcast!(nodes[1], false);
2699 check_added_monitors!(nodes[1], 1);
2700 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 1 (HTLC-Success)
2701 assert_eq!(node_txn.len(), 4);
2702 check_spends!(node_txn[0], commitment_tx[0]);
2703 assert_eq!(node_txn[0].input.len(), 2);
2704 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2705 assert_eq!(node_txn[0].input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2706 assert_eq!(node_txn[0].lock_time, 0);
2707 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2708 check_spends!(node_txn[1], chan_1.3);
2709 assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2710 check_spends!(node_txn[2], node_txn[1]);
2711 check_spends!(node_txn[3], node_txn[1]);
2712 // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2713 // we already checked the same situation with A.
2715 // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2716 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone(), node_txn[0].clone()] }, 1);
2717 check_closed_broadcast!(nodes[0], false);
2718 check_added_monitors!(nodes[0], 1);
2719 let events = nodes[0].node.get_and_clear_pending_events();
2720 assert_eq!(events.len(), 2);
2721 let mut first_claimed = false;
2722 for event in events {
2724 Event::PaymentSent { payment_preimage } => {
2725 if payment_preimage == our_payment_preimage {
2726 assert!(!first_claimed);
2727 first_claimed = true;
2729 assert_eq!(payment_preimage, our_payment_preimage_2);
2732 _ => panic!("Unexpected event"),
2735 check_tx_local_broadcast!(nodes[0], true, commitment_tx[0], chan_1.3);
2739 fn test_htlc_on_chain_timeout() {
2740 // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2741 // ChainWatchInterface and timeout the HTLC backward accordingly. So here we test that ChannelManager is
2742 // broadcasting the right event to other nodes in payment path.
2743 // A ------------------> B ----------------------> C (timeout)
2744 // B's commitment tx C's commitment tx
2746 // B's HTLC timeout tx B's timeout tx
2748 let chanmon_cfgs = create_chanmon_cfgs(3);
2749 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2750 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2751 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2753 // Create some intial channels
2754 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2755 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2757 // Rebalance the network a bit by relaying one payment thorugh all the channels...
2758 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2759 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2761 let (_payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2762 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2764 // Broadcast legit commitment tx from C on B's chain
2765 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2766 check_spends!(commitment_tx[0], chan_2.3);
2767 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
2768 check_added_monitors!(nodes[2], 0);
2769 expect_pending_htlcs_forwardable!(nodes[2]);
2770 check_added_monitors!(nodes[2], 1);
2772 let events = nodes[2].node.get_and_clear_pending_msg_events();
2773 assert_eq!(events.len(), 1);
2775 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, .. } } => {
2776 assert!(update_add_htlcs.is_empty());
2777 assert!(!update_fail_htlcs.is_empty());
2778 assert!(update_fulfill_htlcs.is_empty());
2779 assert!(update_fail_malformed_htlcs.is_empty());
2780 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2782 _ => panic!("Unexpected event"),
2784 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2785 check_closed_broadcast!(nodes[2], false);
2786 check_added_monitors!(nodes[2], 1);
2787 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2788 assert_eq!(node_txn.len(), 1);
2789 check_spends!(node_txn[0], chan_2.3);
2790 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2792 // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2793 // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2794 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2797 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2798 assert_eq!(node_txn.len(), 5); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (local commitment tx + HTLC-timeout), 1 timeout tx
2799 assert_eq!(node_txn[1], node_txn[3]);
2800 assert_eq!(node_txn[2], node_txn[4]);
2802 check_spends!(node_txn[0], commitment_tx[0]);
2803 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2805 check_spends!(node_txn[1], chan_2.3);
2806 check_spends!(node_txn[2], node_txn[1]);
2807 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2808 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2810 timeout_tx = node_txn[0].clone();
2814 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![timeout_tx]}, 1);
2815 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2816 check_added_monitors!(nodes[1], 1);
2817 check_closed_broadcast!(nodes[1], false);
2819 expect_pending_htlcs_forwardable!(nodes[1]);
2820 check_added_monitors!(nodes[1], 1);
2821 let events = nodes[1].node.get_and_clear_pending_msg_events();
2822 assert_eq!(events.len(), 1);
2824 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, .. } } => {
2825 assert!(update_add_htlcs.is_empty());
2826 assert!(!update_fail_htlcs.is_empty());
2827 assert!(update_fulfill_htlcs.is_empty());
2828 assert!(update_fail_malformed_htlcs.is_empty());
2829 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2831 _ => panic!("Unexpected event"),
2833 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
2834 assert_eq!(node_txn.len(), 0);
2836 // Broadcast legit commitment tx from B on A's chain
2837 let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
2838 check_spends!(commitment_tx[0], chan_1.3);
2840 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2841 check_closed_broadcast!(nodes[0], false);
2842 check_added_monitors!(nodes[0], 1);
2843 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 1 timeout tx
2844 assert_eq!(node_txn.len(), 3);
2845 check_spends!(node_txn[0], commitment_tx[0]);
2846 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2847 check_spends!(node_txn[1], chan_1.3);
2848 check_spends!(node_txn[2], node_txn[1]);
2849 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2850 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2854 fn test_simple_commitment_revoked_fail_backward() {
2855 // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
2856 // and fail backward accordingly.
2858 let chanmon_cfgs = create_chanmon_cfgs(3);
2859 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2860 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2861 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2863 // Create some initial channels
2864 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2865 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2867 let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2868 // Get the will-be-revoked local txn from nodes[2]
2869 let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
2870 // Revoke the old state
2871 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, 3_000_000);
2873 let (_, payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2875 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2876 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2877 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2878 check_added_monitors!(nodes[1], 1);
2879 check_closed_broadcast!(nodes[1], false);
2881 expect_pending_htlcs_forwardable!(nodes[1]);
2882 check_added_monitors!(nodes[1], 1);
2883 let events = nodes[1].node.get_and_clear_pending_msg_events();
2884 assert_eq!(events.len(), 1);
2886 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, .. } } => {
2887 assert!(update_add_htlcs.is_empty());
2888 assert_eq!(update_fail_htlcs.len(), 1);
2889 assert!(update_fulfill_htlcs.is_empty());
2890 assert!(update_fail_malformed_htlcs.is_empty());
2891 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2893 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
2894 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2896 let events = nodes[0].node.get_and_clear_pending_msg_events();
2897 assert_eq!(events.len(), 1);
2899 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
2900 _ => panic!("Unexpected event"),
2902 expect_payment_failed!(nodes[0], payment_hash, false);
2904 _ => panic!("Unexpected event"),
2908 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
2909 // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
2910 // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
2911 // commitment transaction anymore.
2912 // To do this, we have the peer which will broadcast a revoked commitment transaction send
2913 // a number of update_fail/commitment_signed updates without ever sending the RAA in
2914 // response to our commitment_signed. This is somewhat misbehavior-y, though not
2915 // technically disallowed and we should probably handle it reasonably.
2916 // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
2917 // failed/fulfilled backwards must be in at least one of the latest two remote commitment
2919 // * Once we move it out of our holding cell/add it, we will immediately include it in a
2920 // commitment_signed (implying it will be in the latest remote commitment transaction).
2921 // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
2922 // and once they revoke the previous commitment transaction (allowing us to send a new
2923 // commitment_signed) we will be free to fail/fulfill the HTLC backwards.
2924 let chanmon_cfgs = create_chanmon_cfgs(3);
2925 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2926 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2927 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2929 // Create some initial channels
2930 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2931 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2933 let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], if no_to_remote { 10_000 } else { 3_000_000 });
2934 // Get the will-be-revoked local txn from nodes[2]
2935 let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
2936 assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
2937 // Revoke the old state
2938 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, if no_to_remote { 10_000 } else { 3_000_000});
2940 let value = if use_dust {
2941 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
2942 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
2943 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().our_dust_limit_satoshis * 1000
2946 let (_, first_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2947 let (_, second_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2948 let (_, third_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2950 assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash, &None));
2951 expect_pending_htlcs_forwardable!(nodes[2]);
2952 check_added_monitors!(nodes[2], 1);
2953 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2954 assert!(updates.update_add_htlcs.is_empty());
2955 assert!(updates.update_fulfill_htlcs.is_empty());
2956 assert!(updates.update_fail_malformed_htlcs.is_empty());
2957 assert_eq!(updates.update_fail_htlcs.len(), 1);
2958 assert!(updates.update_fee.is_none());
2959 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2960 let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
2961 // Drop the last RAA from 3 -> 2
2963 assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash, &None));
2964 expect_pending_htlcs_forwardable!(nodes[2]);
2965 check_added_monitors!(nodes[2], 1);
2966 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2967 assert!(updates.update_add_htlcs.is_empty());
2968 assert!(updates.update_fulfill_htlcs.is_empty());
2969 assert!(updates.update_fail_malformed_htlcs.is_empty());
2970 assert_eq!(updates.update_fail_htlcs.len(), 1);
2971 assert!(updates.update_fee.is_none());
2972 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2973 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2974 check_added_monitors!(nodes[1], 1);
2975 // Note that nodes[1] is in AwaitingRAA, so won't send a CS
2976 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2977 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2978 check_added_monitors!(nodes[2], 1);
2980 assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash, &None));
2981 expect_pending_htlcs_forwardable!(nodes[2]);
2982 check_added_monitors!(nodes[2], 1);
2983 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2984 assert!(updates.update_add_htlcs.is_empty());
2985 assert!(updates.update_fulfill_htlcs.is_empty());
2986 assert!(updates.update_fail_malformed_htlcs.is_empty());
2987 assert_eq!(updates.update_fail_htlcs.len(), 1);
2988 assert!(updates.update_fee.is_none());
2989 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2990 // At this point first_payment_hash has dropped out of the latest two commitment
2991 // transactions that nodes[1] is tracking...
2992 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2993 check_added_monitors!(nodes[1], 1);
2994 // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
2995 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2996 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2997 check_added_monitors!(nodes[2], 1);
2999 // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
3000 // on nodes[2]'s RAA.
3001 let (_, fourth_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3002 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3003 let logger = test_utils::TestLogger::new();
3004 let route = get_route(&nodes[1].node.get_our_node_id(), net_graph_msg_handler, &nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3005 nodes[1].node.send_payment(&route, fourth_payment_hash, &None).unwrap();
3006 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3007 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3008 check_added_monitors!(nodes[1], 0);
3011 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
3012 // One monitor for the new revocation preimage, no second on as we won't generate a new
3013 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
3014 check_added_monitors!(nodes[1], 1);
3015 let events = nodes[1].node.get_and_clear_pending_events();
3016 assert_eq!(events.len(), 1);
3018 Event::PendingHTLCsForwardable { .. } => { },
3019 _ => panic!("Unexpected event"),
3021 // Deliberately don't process the pending fail-back so they all fail back at once after
3022 // block connection just like the !deliver_bs_raa case
3025 let mut failed_htlcs = HashSet::new();
3026 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3028 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
3029 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3030 check_added_monitors!(nodes[1], 1);
3031 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
3033 let events = nodes[1].node.get_and_clear_pending_events();
3034 assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
3036 Event::PaymentFailed { ref payment_hash, .. } => {
3037 assert_eq!(*payment_hash, fourth_payment_hash);
3039 _ => panic!("Unexpected event"),
3041 if !deliver_bs_raa {
3043 Event::PendingHTLCsForwardable { .. } => { },
3044 _ => panic!("Unexpected event"),
3047 nodes[1].node.process_pending_htlc_forwards();
3048 check_added_monitors!(nodes[1], 1);
3050 let events = nodes[1].node.get_and_clear_pending_msg_events();
3051 assert_eq!(events.len(), if deliver_bs_raa { 3 } else { 2 });
3052 match events[if deliver_bs_raa { 1 } else { 0 }] {
3053 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
3054 _ => panic!("Unexpected event"),
3058 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, .. } } => {
3059 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
3060 assert_eq!(update_add_htlcs.len(), 1);
3061 assert!(update_fulfill_htlcs.is_empty());
3062 assert!(update_fail_htlcs.is_empty());
3063 assert!(update_fail_malformed_htlcs.is_empty());
3065 _ => panic!("Unexpected event"),
3068 match events[if deliver_bs_raa { 2 } else { 1 }] {
3069 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, .. } } => {
3070 assert!(update_add_htlcs.is_empty());
3071 assert_eq!(update_fail_htlcs.len(), 3);
3072 assert!(update_fulfill_htlcs.is_empty());
3073 assert!(update_fail_malformed_htlcs.is_empty());
3074 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3076 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3077 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
3078 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
3080 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3082 let events = nodes[0].node.get_and_clear_pending_msg_events();
3083 // If we delivered B's RAA we got an unknown preimage error, not something
3084 // that we should update our routing table for.
3085 assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
3086 for event in events {
3088 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3089 _ => panic!("Unexpected event"),
3092 let events = nodes[0].node.get_and_clear_pending_events();
3093 assert_eq!(events.len(), 3);
3095 Event::PaymentFailed { ref payment_hash, .. } => {
3096 assert!(failed_htlcs.insert(payment_hash.0));
3098 _ => panic!("Unexpected event"),
3101 Event::PaymentFailed { ref payment_hash, .. } => {
3102 assert!(failed_htlcs.insert(payment_hash.0));
3104 _ => panic!("Unexpected event"),
3107 Event::PaymentFailed { ref payment_hash, .. } => {
3108 assert!(failed_htlcs.insert(payment_hash.0));
3110 _ => panic!("Unexpected event"),
3113 _ => panic!("Unexpected event"),
3116 assert!(failed_htlcs.contains(&first_payment_hash.0));
3117 assert!(failed_htlcs.contains(&second_payment_hash.0));
3118 assert!(failed_htlcs.contains(&third_payment_hash.0));
3122 fn test_commitment_revoked_fail_backward_exhaustive_a() {
3123 do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
3124 do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
3125 do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
3126 do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
3130 fn test_commitment_revoked_fail_backward_exhaustive_b() {
3131 do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
3132 do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
3133 do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
3134 do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
3138 fn fail_backward_pending_htlc_upon_channel_failure() {
3139 let chanmon_cfgs = create_chanmon_cfgs(2);
3140 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3141 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3142 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3143 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
3144 let logger = test_utils::TestLogger::new();
3146 // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
3148 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
3149 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3150 let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[1].node.get_our_node_id(), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3151 nodes[0].node.send_payment(&route, payment_hash, &None).unwrap();
3152 check_added_monitors!(nodes[0], 1);
3154 let payment_event = {
3155 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3156 assert_eq!(events.len(), 1);
3157 SendEvent::from_event(events.remove(0))
3159 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3160 assert_eq!(payment_event.msgs.len(), 1);
3163 // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3164 let (_, failed_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3166 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3167 let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[1].node.get_our_node_id(), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3168 nodes[0].node.send_payment(&route, failed_payment_hash, &None).unwrap();
3169 check_added_monitors!(nodes[0], 0);
3171 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3174 // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3176 let (_, payment_hash) = get_payment_preimage_hash!(nodes[1]);
3178 let secp_ctx = Secp256k1::new();
3179 let session_priv = {
3180 let mut session_key = [0; 32];
3181 let mut rng = thread_rng();
3182 rng.fill_bytes(&mut session_key);
3183 SecretKey::from_slice(&session_key).expect("RNG is bad!")
3186 let current_height = nodes[1].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
3187 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3188 let route = get_route(&nodes[1].node.get_our_node_id(), net_graph_msg_handler, &nodes[0].node.get_our_node_id(), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3189 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &None, current_height).unwrap();
3190 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3191 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3193 // Send a 0-msat update_add_htlc to fail the channel.
3194 let update_add_htlc = msgs::UpdateAddHTLC {
3200 onion_routing_packet,
3202 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3205 // Check that Alice fails backward the pending HTLC from the second payment.
3206 expect_payment_failed!(nodes[0], failed_payment_hash, true);
3207 check_closed_broadcast!(nodes[0], true);
3208 check_added_monitors!(nodes[0], 1);
3212 fn test_htlc_ignore_latest_remote_commitment() {
3213 // Test that HTLC transactions spending the latest remote commitment transaction are simply
3214 // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3215 let chanmon_cfgs = create_chanmon_cfgs(2);
3216 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3217 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3218 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3219 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3221 route_payment(&nodes[0], &[&nodes[1]], 10000000);
3222 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id);
3223 check_closed_broadcast!(nodes[0], false);
3224 check_added_monitors!(nodes[0], 1);
3226 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3227 assert_eq!(node_txn.len(), 2);
3229 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3230 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
3231 check_closed_broadcast!(nodes[1], false);
3232 check_added_monitors!(nodes[1], 1);
3234 // Duplicate the block_connected call since this may happen due to other listeners
3235 // registering new transactions
3236 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
3240 fn test_force_close_fail_back() {
3241 // Check which HTLCs are failed-backwards on channel force-closure
3242 let chanmon_cfgs = create_chanmon_cfgs(3);
3243 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3244 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3245 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3246 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3247 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3248 let logger = test_utils::TestLogger::new();
3250 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3252 let mut payment_event = {
3253 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3254 let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, 42, &logger).unwrap();
3255 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
3256 check_added_monitors!(nodes[0], 1);
3258 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3259 assert_eq!(events.len(), 1);
3260 SendEvent::from_event(events.remove(0))
3263 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3264 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3266 expect_pending_htlcs_forwardable!(nodes[1]);
3268 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3269 assert_eq!(events_2.len(), 1);
3270 payment_event = SendEvent::from_event(events_2.remove(0));
3271 assert_eq!(payment_event.msgs.len(), 1);
3273 check_added_monitors!(nodes[1], 1);
3274 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3275 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3276 check_added_monitors!(nodes[2], 1);
3277 let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3279 // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3280 // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3281 // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3283 nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id);
3284 check_closed_broadcast!(nodes[2], false);
3285 check_added_monitors!(nodes[2], 1);
3287 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3288 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3289 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3290 // back to nodes[1] upon timeout otherwise.
3291 assert_eq!(node_txn.len(), 1);
3295 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3296 nodes[1].block_notifier.block_connected_checked(&header, 1, &[&tx], &[1]);
3298 // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3299 check_closed_broadcast!(nodes[1], false);
3300 check_added_monitors!(nodes[1], 1);
3302 // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3304 let mut monitors = nodes[2].chan_monitor.simple_monitor.monitors.lock().unwrap();
3305 monitors.get_mut(&OutPoint{ txid: Txid::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), index: 0 }).unwrap()
3306 .provide_payment_preimage(&our_payment_hash, &our_payment_preimage);
3308 nodes[2].block_notifier.block_connected_checked(&header, 1, &[&tx], &[1]);
3309 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3310 assert_eq!(node_txn.len(), 1);
3311 assert_eq!(node_txn[0].input.len(), 1);
3312 assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3313 assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3314 assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3316 check_spends!(node_txn[0], tx);
3320 fn test_unconf_chan() {
3321 // After creating a chan between nodes, we disconnect all blocks previously seen to force a channel close on nodes[0] side
3322 let chanmon_cfgs = create_chanmon_cfgs(2);
3323 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3324 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3325 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3326 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3328 let channel_state = nodes[0].node.channel_state.lock().unwrap();
3329 assert_eq!(channel_state.by_id.len(), 1);
3330 assert_eq!(channel_state.short_to_id.len(), 1);
3331 mem::drop(channel_state);
3333 let mut headers = Vec::new();
3334 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3335 headers.push(header.clone());
3337 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3338 headers.push(header.clone());
3340 let mut height = 99;
3341 while !headers.is_empty() {
3342 nodes[0].node.block_disconnected(&headers.pop().unwrap(), height);
3345 check_closed_broadcast!(nodes[0], false);
3346 check_added_monitors!(nodes[0], 1);
3347 let channel_state = nodes[0].node.channel_state.lock().unwrap();
3348 assert_eq!(channel_state.by_id.len(), 0);
3349 assert_eq!(channel_state.short_to_id.len(), 0);
3353 fn test_simple_peer_disconnect() {
3354 // Test that we can reconnect when there are no lost messages
3355 let chanmon_cfgs = create_chanmon_cfgs(3);
3356 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3357 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3358 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3359 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3360 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3362 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3363 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3364 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3366 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3367 let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3368 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3369 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1, 1_000_000);
3371 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3372 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3373 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3375 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3376 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3377 let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3378 let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3380 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3381 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3383 claim_payment_along_route(&nodes[0], &vec!(&nodes[1], &nodes[2]), true, payment_preimage_3, 1_000_000);
3384 fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3386 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3388 let events = nodes[0].node.get_and_clear_pending_events();
3389 assert_eq!(events.len(), 2);
3391 Event::PaymentSent { payment_preimage } => {
3392 assert_eq!(payment_preimage, payment_preimage_3);
3394 _ => panic!("Unexpected event"),
3397 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3398 assert_eq!(payment_hash, payment_hash_5);
3399 assert!(rejected_by_dest);
3401 _ => panic!("Unexpected event"),
3405 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4, 1_000_000);
3406 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3409 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
3410 // Test that we can reconnect when in-flight HTLC updates get dropped
3411 let chanmon_cfgs = create_chanmon_cfgs(2);
3412 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3413 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3414 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3415 if messages_delivered == 0 {
3416 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3417 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3419 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3422 let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
3424 let logger = test_utils::TestLogger::new();
3425 let payment_event = {
3426 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3427 let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[1].node.get_our_node_id(), Some(&nodes[0].node.list_usable_channels()), &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3428 nodes[0].node.send_payment(&route, payment_hash_1, &None).unwrap();
3429 check_added_monitors!(nodes[0], 1);
3431 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3432 assert_eq!(events.len(), 1);
3433 SendEvent::from_event(events.remove(0))
3435 assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3437 if messages_delivered < 2 {
3438 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3440 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3441 if messages_delivered >= 3 {
3442 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3443 check_added_monitors!(nodes[1], 1);
3444 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3446 if messages_delivered >= 4 {
3447 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3448 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3449 check_added_monitors!(nodes[0], 1);
3451 if messages_delivered >= 5 {
3452 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3453 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3454 // No commitment_signed so get_event_msg's assert(len == 1) passes
3455 check_added_monitors!(nodes[0], 1);
3457 if messages_delivered >= 6 {
3458 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3459 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3460 check_added_monitors!(nodes[1], 1);
3467 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3468 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3469 if messages_delivered < 3 {
3470 // Even if the funding_locked messages get exchanged, as long as nothing further was
3471 // received on either side, both sides will need to resend them.
3472 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3473 } else if messages_delivered == 3 {
3474 // nodes[0] still wants its RAA + commitment_signed
3475 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3476 } else if messages_delivered == 4 {
3477 // nodes[0] still wants its commitment_signed
3478 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3479 } else if messages_delivered == 5 {
3480 // nodes[1] still wants its final RAA
3481 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3482 } else if messages_delivered == 6 {
3483 // Everything was delivered...
3484 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3487 let events_1 = nodes[1].node.get_and_clear_pending_events();
3488 assert_eq!(events_1.len(), 1);
3490 Event::PendingHTLCsForwardable { .. } => { },
3491 _ => panic!("Unexpected event"),
3494 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3495 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3496 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3498 nodes[1].node.process_pending_htlc_forwards();
3500 let events_2 = nodes[1].node.get_and_clear_pending_events();
3501 assert_eq!(events_2.len(), 1);
3503 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
3504 assert_eq!(payment_hash_1, *payment_hash);
3505 assert_eq!(*payment_secret, None);
3506 assert_eq!(amt, 1000000);
3508 _ => panic!("Unexpected event"),
3511 nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000);
3512 check_added_monitors!(nodes[1], 1);
3514 let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3515 assert_eq!(events_3.len(), 1);
3516 let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3517 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3518 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3519 assert!(updates.update_add_htlcs.is_empty());
3520 assert!(updates.update_fail_htlcs.is_empty());
3521 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3522 assert!(updates.update_fail_malformed_htlcs.is_empty());
3523 assert!(updates.update_fee.is_none());
3524 (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3526 _ => panic!("Unexpected event"),
3529 if messages_delivered >= 1 {
3530 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3532 let events_4 = nodes[0].node.get_and_clear_pending_events();
3533 assert_eq!(events_4.len(), 1);
3535 Event::PaymentSent { ref payment_preimage } => {
3536 assert_eq!(payment_preimage_1, *payment_preimage);
3538 _ => panic!("Unexpected event"),
3541 if messages_delivered >= 2 {
3542 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3543 check_added_monitors!(nodes[0], 1);
3544 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3546 if messages_delivered >= 3 {
3547 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3548 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3549 check_added_monitors!(nodes[1], 1);
3551 if messages_delivered >= 4 {
3552 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3553 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3554 // No commitment_signed so get_event_msg's assert(len == 1) passes
3555 check_added_monitors!(nodes[1], 1);
3557 if messages_delivered >= 5 {
3558 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3559 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3560 check_added_monitors!(nodes[0], 1);
3567 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3568 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3569 if messages_delivered < 2 {
3570 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3571 //TODO: Deduplicate PaymentSent events, then enable this if:
3572 //if messages_delivered < 1 {
3573 let events_4 = nodes[0].node.get_and_clear_pending_events();
3574 assert_eq!(events_4.len(), 1);
3576 Event::PaymentSent { ref payment_preimage } => {
3577 assert_eq!(payment_preimage_1, *payment_preimage);
3579 _ => panic!("Unexpected event"),
3582 } else if messages_delivered == 2 {
3583 // nodes[0] still wants its RAA + commitment_signed
3584 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3585 } else if messages_delivered == 3 {
3586 // nodes[0] still wants its commitment_signed
3587 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3588 } else if messages_delivered == 4 {
3589 // nodes[1] still wants its final RAA
3590 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3591 } else if messages_delivered == 5 {
3592 // Everything was delivered...
3593 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3596 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3597 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3598 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3600 // Channel should still work fine...
3601 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3602 let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[1].node.get_our_node_id(), Some(&nodes[0].node.list_usable_channels()), &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3603 let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3604 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3608 fn test_drop_messages_peer_disconnect_a() {
3609 do_test_drop_messages_peer_disconnect(0);
3610 do_test_drop_messages_peer_disconnect(1);
3611 do_test_drop_messages_peer_disconnect(2);
3612 do_test_drop_messages_peer_disconnect(3);
3616 fn test_drop_messages_peer_disconnect_b() {
3617 do_test_drop_messages_peer_disconnect(4);
3618 do_test_drop_messages_peer_disconnect(5);
3619 do_test_drop_messages_peer_disconnect(6);
3623 fn test_funding_peer_disconnect() {
3624 // Test that we can lock in our funding tx while disconnected
3625 let chanmon_cfgs = create_chanmon_cfgs(2);
3626 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3627 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3628 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3629 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3631 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3632 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3634 confirm_transaction(&nodes[0].block_notifier, &nodes[0].chain_monitor, &tx, tx.version);
3635 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3636 assert_eq!(events_1.len(), 1);
3638 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3639 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3641 _ => panic!("Unexpected event"),
3644 reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3646 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3647 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3649 confirm_transaction(&nodes[1].block_notifier, &nodes[1].chain_monitor, &tx, tx.version);
3650 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3651 assert_eq!(events_2.len(), 2);
3652 let funding_locked = match events_2[0] {
3653 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3654 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3657 _ => panic!("Unexpected event"),
3659 let bs_announcement_sigs = match events_2[1] {
3660 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3661 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3664 _ => panic!("Unexpected event"),
3667 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3669 nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3670 nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3671 let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3672 assert_eq!(events_3.len(), 2);
3673 let as_announcement_sigs = match events_3[0] {
3674 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3675 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3678 _ => panic!("Unexpected event"),
3680 let (as_announcement, as_update) = match events_3[1] {
3681 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3682 (msg.clone(), update_msg.clone())
3684 _ => panic!("Unexpected event"),
3687 nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3688 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3689 assert_eq!(events_4.len(), 1);
3690 let (_, bs_update) = match events_4[0] {
3691 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3692 (msg.clone(), update_msg.clone())
3694 _ => panic!("Unexpected event"),
3697 nodes[0].net_graph_msg_handler.handle_channel_announcement(&as_announcement).unwrap();
3698 nodes[0].net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
3699 nodes[0].net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
3701 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3702 let logger = test_utils::TestLogger::new();
3703 let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3704 let (payment_preimage, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3705 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage, 1_000_000);
3709 fn test_drop_messages_peer_disconnect_dual_htlc() {
3710 // Test that we can handle reconnecting when both sides of a channel have pending
3711 // commitment_updates when we disconnect.
3712 let chanmon_cfgs = create_chanmon_cfgs(2);
3713 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3714 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3715 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3716 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3717 let logger = test_utils::TestLogger::new();
3719 let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3721 // Now try to send a second payment which will fail to send
3722 let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
3723 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3724 let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3725 nodes[0].node.send_payment(&route, payment_hash_2, &None).unwrap();
3726 check_added_monitors!(nodes[0], 1);
3728 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3729 assert_eq!(events_1.len(), 1);
3731 MessageSendEvent::UpdateHTLCs { .. } => {},
3732 _ => panic!("Unexpected event"),
3735 assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000));
3736 check_added_monitors!(nodes[1], 1);
3738 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3739 assert_eq!(events_2.len(), 1);
3741 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 } } => {
3742 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3743 assert!(update_add_htlcs.is_empty());
3744 assert_eq!(update_fulfill_htlcs.len(), 1);
3745 assert!(update_fail_htlcs.is_empty());
3746 assert!(update_fail_malformed_htlcs.is_empty());
3747 assert!(update_fee.is_none());
3749 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3750 let events_3 = nodes[0].node.get_and_clear_pending_events();
3751 assert_eq!(events_3.len(), 1);
3753 Event::PaymentSent { ref payment_preimage } => {
3754 assert_eq!(*payment_preimage, payment_preimage_1);
3756 _ => panic!("Unexpected event"),
3759 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
3760 let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3761 // No commitment_signed so get_event_msg's assert(len == 1) passes
3762 check_added_monitors!(nodes[0], 1);
3764 _ => panic!("Unexpected event"),
3767 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3768 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3770 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3771 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3772 assert_eq!(reestablish_1.len(), 1);
3773 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3774 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3775 assert_eq!(reestablish_2.len(), 1);
3777 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3778 let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3779 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3780 let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3782 assert!(as_resp.0.is_none());
3783 assert!(bs_resp.0.is_none());
3785 assert!(bs_resp.1.is_none());
3786 assert!(bs_resp.2.is_none());
3788 assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3790 assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3791 assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3792 assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3793 assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3794 assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3795 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
3796 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
3797 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3798 // No commitment_signed so get_event_msg's assert(len == 1) passes
3799 check_added_monitors!(nodes[1], 1);
3801 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
3802 let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3803 assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
3804 assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
3805 assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
3806 assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
3807 assert!(bs_second_commitment_signed.update_fee.is_none());
3808 check_added_monitors!(nodes[1], 1);
3810 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3811 let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3812 assert!(as_commitment_signed.update_add_htlcs.is_empty());
3813 assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
3814 assert!(as_commitment_signed.update_fail_htlcs.is_empty());
3815 assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
3816 assert!(as_commitment_signed.update_fee.is_none());
3817 check_added_monitors!(nodes[0], 1);
3819 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
3820 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3821 // No commitment_signed so get_event_msg's assert(len == 1) passes
3822 check_added_monitors!(nodes[0], 1);
3824 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
3825 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3826 // No commitment_signed so get_event_msg's assert(len == 1) passes
3827 check_added_monitors!(nodes[1], 1);
3829 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3830 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3831 check_added_monitors!(nodes[1], 1);
3833 expect_pending_htlcs_forwardable!(nodes[1]);
3835 let events_5 = nodes[1].node.get_and_clear_pending_events();
3836 assert_eq!(events_5.len(), 1);
3838 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt: _ } => {
3839 assert_eq!(payment_hash_2, *payment_hash);
3840 assert_eq!(*payment_secret, None);
3842 _ => panic!("Unexpected event"),
3845 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
3846 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3847 check_added_monitors!(nodes[0], 1);
3849 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3852 fn do_test_htlc_timeout(send_partial_mpp: bool) {
3853 // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
3854 // to avoid our counterparty failing the channel.
3855 let chanmon_cfgs = create_chanmon_cfgs(2);
3856 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3857 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3858 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3860 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3861 let logger = test_utils::TestLogger::new();
3863 let our_payment_hash = if send_partial_mpp {
3864 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3865 let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[1].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
3866 let (_, our_payment_hash) = get_payment_preimage_hash!(&nodes[0]);
3867 let payment_secret = PaymentSecret([0xdb; 32]);
3868 // Use the utility function send_payment_along_path to send the payment with MPP data which
3869 // indicates there are more HTLCs coming.
3870 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200000, CHAN_CONFIRM_DEPTH).unwrap();
3871 check_added_monitors!(nodes[0], 1);
3872 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3873 assert_eq!(events.len(), 1);
3874 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
3875 // hop should *not* yet generate any PaymentReceived event(s).
3876 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false);
3879 route_payment(&nodes[0], &[&nodes[1]], 100000).1
3882 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3883 nodes[0].block_notifier.block_connected_checked(&header, 101, &[], &[]);
3884 nodes[1].block_notifier.block_connected_checked(&header, 101, &[], &[]);
3885 for i in 102..TEST_FINAL_CLTV + 100 + 1 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS {
3886 header.prev_blockhash = header.bitcoin_hash();
3887 nodes[0].block_notifier.block_connected_checked(&header, i, &[], &[]);
3888 nodes[1].block_notifier.block_connected_checked(&header, i, &[], &[]);
3891 expect_pending_htlcs_forwardable!(nodes[1]);
3893 check_added_monitors!(nodes[1], 1);
3894 let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3895 assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
3896 assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
3897 assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
3898 assert!(htlc_timeout_updates.update_fee.is_none());
3900 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
3901 commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
3902 // 100_000 msat as u64, followed by a height of 123 as u32
3903 let mut expected_failure_data = byte_utils::be64_to_array(100_000).to_vec();
3904 expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(123));
3905 expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
3909 fn test_htlc_timeout() {
3910 do_test_htlc_timeout(true);
3911 do_test_htlc_timeout(false);
3914 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
3915 // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
3916 let chanmon_cfgs = create_chanmon_cfgs(3);
3917 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3918 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3919 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3920 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3921 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3922 let logger = test_utils::TestLogger::new();
3924 // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
3925 let (_, first_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3927 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3928 let route = get_route(&nodes[1].node.get_our_node_id(), net_graph_msg_handler, &nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
3929 nodes[1].node.send_payment(&route, first_payment_hash, &None).unwrap();
3931 assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
3932 check_added_monitors!(nodes[1], 1);
3934 // Now attempt to route a second payment, which should be placed in the holding cell
3935 let (_, second_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3937 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3938 let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
3939 nodes[0].node.send_payment(&route, second_payment_hash, &None).unwrap();
3940 check_added_monitors!(nodes[0], 1);
3941 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
3942 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3943 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3944 expect_pending_htlcs_forwardable!(nodes[1]);
3945 check_added_monitors!(nodes[1], 0);
3947 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3948 let route = get_route(&nodes[1].node.get_our_node_id(), net_graph_msg_handler, &nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
3949 nodes[1].node.send_payment(&route, second_payment_hash, &None).unwrap();
3950 check_added_monitors!(nodes[1], 0);
3953 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3954 nodes[1].block_notifier.block_connected_checked(&header, 101, &[], &[]);
3955 for i in 102..TEST_FINAL_CLTV + 100 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS {
3956 header.prev_blockhash = header.bitcoin_hash();
3957 nodes[1].block_notifier.block_connected_checked(&header, i, &[], &[]);
3960 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3961 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3963 header.prev_blockhash = header.bitcoin_hash();
3964 nodes[1].block_notifier.block_connected_checked(&header, TEST_FINAL_CLTV + 100 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS, &[], &[]);
3967 expect_pending_htlcs_forwardable!(nodes[1]);
3968 check_added_monitors!(nodes[1], 1);
3969 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
3970 assert_eq!(fail_commit.len(), 1);
3971 match fail_commit[0] {
3972 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
3973 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3974 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
3976 _ => unreachable!(),
3978 expect_payment_failed!(nodes[0], second_payment_hash, false);
3979 if let &MessageSendEvent::PaymentFailureNetworkUpdate { ref update } = &nodes[0].node.get_and_clear_pending_msg_events()[0] {
3981 &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {},
3982 _ => panic!("Unexpected event"),
3985 panic!("Unexpected event");
3988 expect_payment_failed!(nodes[1], second_payment_hash, true);
3993 fn test_holding_cell_htlc_add_timeouts() {
3994 do_test_holding_cell_htlc_add_timeouts(false);
3995 do_test_holding_cell_htlc_add_timeouts(true);
3999 fn test_invalid_channel_announcement() {
4000 //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
4001 let secp_ctx = Secp256k1::new();
4002 let chanmon_cfgs = create_chanmon_cfgs(2);
4003 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4004 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4005 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4007 let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
4009 let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
4010 let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
4011 let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4012 let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4014 nodes[0].net_graph_msg_handler.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap(), is_permanent: false } );
4016 let as_bitcoin_key = as_chan.get_local_keys().inner.local_channel_pubkeys.funding_pubkey;
4017 let bs_bitcoin_key = bs_chan.get_local_keys().inner.local_channel_pubkeys.funding_pubkey;
4019 let as_network_key = nodes[0].node.get_our_node_id();
4020 let bs_network_key = nodes[1].node.get_our_node_id();
4022 let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
4024 let mut chan_announcement;
4026 macro_rules! dummy_unsigned_msg {
4028 msgs::UnsignedChannelAnnouncement {
4029 features: ChannelFeatures::known(),
4030 chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
4031 short_channel_id: as_chan.get_short_channel_id().unwrap(),
4032 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
4033 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
4034 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
4035 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
4036 excess_data: Vec::new(),
4041 macro_rules! sign_msg {
4042 ($unsigned_msg: expr) => {
4043 let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
4044 let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_local_keys().inner.funding_key);
4045 let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_local_keys().inner.funding_key);
4046 let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
4047 let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
4048 chan_announcement = msgs::ChannelAnnouncement {
4049 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
4050 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
4051 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
4052 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
4053 contents: $unsigned_msg
4058 let unsigned_msg = dummy_unsigned_msg!();
4059 sign_msg!(unsigned_msg);
4060 assert_eq!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).unwrap(), true);
4061 let _ = nodes[0].net_graph_msg_handler.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap(), is_permanent: false } );
4063 // Configured with Network::Testnet
4064 let mut unsigned_msg = dummy_unsigned_msg!();
4065 unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.bitcoin_hash();
4066 sign_msg!(unsigned_msg);
4067 assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4069 let mut unsigned_msg = dummy_unsigned_msg!();
4070 unsigned_msg.chain_hash = BlockHash::hash(&[1,2,3,4,5,6,7,8,9]);
4071 sign_msg!(unsigned_msg);
4072 assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4076 fn test_no_txn_manager_serialize_deserialize() {
4077 let chanmon_cfgs = create_chanmon_cfgs(2);
4078 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4079 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4080 let logger: test_utils::TestLogger;
4081 let fee_estimator: test_utils::TestFeeEstimator;
4082 let new_chan_monitor: test_utils::TestChannelMonitor;
4083 let keys_manager: test_utils::TestKeysInterface;
4084 let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4085 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4087 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
4089 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4091 let nodes_0_serialized = nodes[0].node.encode();
4092 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4093 nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
4095 logger = test_utils::TestLogger::new();
4096 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4097 new_chan_monitor = test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator);
4098 nodes[0].chan_monitor = &new_chan_monitor;
4099 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4100 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read).unwrap();
4101 assert!(chan_0_monitor_read.is_empty());
4103 let mut nodes_0_read = &nodes_0_serialized[..];
4104 let config = UserConfig::default();
4105 keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
4106 let (_, nodes_0_deserialized_tmp) = {
4107 let mut channel_monitors = HashMap::new();
4108 channel_monitors.insert(chan_0_monitor.get_funding_txo(), &mut chan_0_monitor);
4109 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4110 default_config: config,
4111 keys_manager: &keys_manager,
4112 fee_estimator: &fee_estimator,
4113 monitor: nodes[0].chan_monitor,
4114 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4116 channel_monitors: &mut channel_monitors,
4119 nodes_0_deserialized = nodes_0_deserialized_tmp;
4120 assert!(nodes_0_read.is_empty());
4122 assert!(nodes[0].chan_monitor.add_monitor(chan_0_monitor.get_funding_txo(), chan_0_monitor).is_ok());
4123 nodes[0].node = &nodes_0_deserialized;
4124 nodes[0].block_notifier.register_listener(nodes[0].node);
4125 assert_eq!(nodes[0].node.list_channels().len(), 1);
4126 check_added_monitors!(nodes[0], 1);
4128 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4129 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4130 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4131 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4133 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4134 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4135 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4136 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4138 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4139 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4140 for node in nodes.iter() {
4141 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4142 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4143 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4146 send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
4150 fn test_manager_serialize_deserialize_events() {
4151 // This test makes sure the events field in ChannelManager survives de/serialization
4152 let chanmon_cfgs = create_chanmon_cfgs(2);
4153 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4154 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4155 let fee_estimator: test_utils::TestFeeEstimator;
4156 let logger: test_utils::TestLogger;
4157 let new_chan_monitor: test_utils::TestChannelMonitor;
4158 let keys_manager: test_utils::TestKeysInterface;
4159 let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4160 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4162 // Start creating a channel, but stop right before broadcasting the event message FundingBroadcastSafe
4163 let channel_value = 100000;
4164 let push_msat = 10001;
4165 let a_flags = InitFeatures::known();
4166 let b_flags = InitFeatures::known();
4167 let node_a = nodes.pop().unwrap();
4168 let node_b = nodes.pop().unwrap();
4169 node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
4170 node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), a_flags, &get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id()));
4171 node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), b_flags, &get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id()));
4173 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&node_a, channel_value, 42);
4175 node_a.node.funding_transaction_generated(&temporary_channel_id, funding_output);
4176 check_added_monitors!(node_a, 0);
4178 node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id()));
4180 let mut added_monitors = node_b.chan_monitor.added_monitors.lock().unwrap();
4181 assert_eq!(added_monitors.len(), 1);
4182 assert_eq!(added_monitors[0].0, funding_output);
4183 added_monitors.clear();
4186 node_a.node.handle_funding_signed(&node_b.node.get_our_node_id(), &get_event_msg!(node_b, MessageSendEvent::SendFundingSigned, node_a.node.get_our_node_id()));
4188 let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
4189 assert_eq!(added_monitors.len(), 1);
4190 assert_eq!(added_monitors[0].0, funding_output);
4191 added_monitors.clear();
4193 // Normally, this is where node_a would check for a FundingBroadcastSafe event, but the test de/serializes first instead
4198 // Start the de/seriailization process mid-channel creation to check that the channel manager will hold onto events that are serialized
4199 let nodes_0_serialized = nodes[0].node.encode();
4200 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4201 nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
4203 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4204 logger = test_utils::TestLogger::new();
4205 new_chan_monitor = test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator);
4206 nodes[0].chan_monitor = &new_chan_monitor;
4207 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4208 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read).unwrap();
4209 assert!(chan_0_monitor_read.is_empty());
4211 let mut nodes_0_read = &nodes_0_serialized[..];
4212 let config = UserConfig::default();
4213 keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
4214 let (_, nodes_0_deserialized_tmp) = {
4215 let mut channel_monitors = HashMap::new();
4216 channel_monitors.insert(chan_0_monitor.get_funding_txo(), &mut chan_0_monitor);
4217 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4218 default_config: config,
4219 keys_manager: &keys_manager,
4220 fee_estimator: &fee_estimator,
4221 monitor: nodes[0].chan_monitor,
4222 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4224 channel_monitors: &mut channel_monitors,
4227 nodes_0_deserialized = nodes_0_deserialized_tmp;
4228 assert!(nodes_0_read.is_empty());
4230 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4232 assert!(nodes[0].chan_monitor.add_monitor(chan_0_monitor.get_funding_txo(), chan_0_monitor).is_ok());
4233 nodes[0].node = &nodes_0_deserialized;
4235 // After deserializing, make sure the FundingBroadcastSafe event is still held by the channel manager
4236 let events_4 = nodes[0].node.get_and_clear_pending_events();
4237 assert_eq!(events_4.len(), 1);
4239 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
4240 assert_eq!(user_channel_id, 42);
4241 assert_eq!(*funding_txo, funding_output);
4243 _ => panic!("Unexpected event"),
4246 // Make sure the channel is functioning as though the de/serialization never happened
4247 nodes[0].block_notifier.register_listener(nodes[0].node);
4248 assert_eq!(nodes[0].node.list_channels().len(), 1);
4249 check_added_monitors!(nodes[0], 1);
4251 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4252 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4253 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4254 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4256 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4257 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4258 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4259 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4261 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4262 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4263 for node in nodes.iter() {
4264 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4265 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4266 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4269 send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
4273 fn test_simple_manager_serialize_deserialize() {
4274 let chanmon_cfgs = create_chanmon_cfgs(2);
4275 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4276 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4277 let logger: test_utils::TestLogger;
4278 let fee_estimator: test_utils::TestFeeEstimator;
4279 let new_chan_monitor: test_utils::TestChannelMonitor;
4280 let keys_manager: test_utils::TestKeysInterface;
4281 let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4282 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4283 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4285 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4286 let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4288 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4290 let nodes_0_serialized = nodes[0].node.encode();
4291 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4292 nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
4294 logger = test_utils::TestLogger::new();
4295 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4296 new_chan_monitor = test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator);
4297 nodes[0].chan_monitor = &new_chan_monitor;
4298 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4299 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read).unwrap();
4300 assert!(chan_0_monitor_read.is_empty());
4302 let mut nodes_0_read = &nodes_0_serialized[..];
4303 keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
4304 let (_, nodes_0_deserialized_tmp) = {
4305 let mut channel_monitors = HashMap::new();
4306 channel_monitors.insert(chan_0_monitor.get_funding_txo(), &mut chan_0_monitor);
4307 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4308 default_config: UserConfig::default(),
4309 keys_manager: &keys_manager,
4310 fee_estimator: &fee_estimator,
4311 monitor: nodes[0].chan_monitor,
4312 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4314 channel_monitors: &mut channel_monitors,
4317 nodes_0_deserialized = nodes_0_deserialized_tmp;
4318 assert!(nodes_0_read.is_empty());
4320 assert!(nodes[0].chan_monitor.add_monitor(chan_0_monitor.get_funding_txo(), chan_0_monitor).is_ok());
4321 nodes[0].node = &nodes_0_deserialized;
4322 check_added_monitors!(nodes[0], 1);
4324 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4326 fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
4327 claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage, 1_000_000);
4331 fn test_manager_serialize_deserialize_inconsistent_monitor() {
4332 // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
4333 let chanmon_cfgs = create_chanmon_cfgs(4);
4334 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4335 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4336 let logger: test_utils::TestLogger;
4337 let fee_estimator: test_utils::TestFeeEstimator;
4338 let new_chan_monitor: test_utils::TestChannelMonitor;
4339 let keys_manager: test_utils::TestKeysInterface;
4340 let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4341 let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4342 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4343 create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::known(), InitFeatures::known());
4344 let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
4346 let mut node_0_stale_monitors_serialized = Vec::new();
4347 for monitor in nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter() {
4348 let mut writer = test_utils::TestVecWriter(Vec::new());
4349 monitor.1.write_for_disk(&mut writer).unwrap();
4350 node_0_stale_monitors_serialized.push(writer.0);
4353 let (our_payment_preimage, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
4355 // Serialize the ChannelManager here, but the monitor we keep up-to-date
4356 let nodes_0_serialized = nodes[0].node.encode();
4358 route_payment(&nodes[0], &[&nodes[3]], 1000000);
4359 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4360 nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4361 nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4363 // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
4365 let mut node_0_monitors_serialized = Vec::new();
4366 for monitor in nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter() {
4367 let mut writer = test_utils::TestVecWriter(Vec::new());
4368 monitor.1.write_for_disk(&mut writer).unwrap();
4369 node_0_monitors_serialized.push(writer.0);
4372 logger = test_utils::TestLogger::new();
4373 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4374 new_chan_monitor = test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator);
4375 nodes[0].chan_monitor = &new_chan_monitor;
4377 let mut node_0_stale_monitors = Vec::new();
4378 for serialized in node_0_stale_monitors_serialized.iter() {
4379 let mut read = &serialized[..];
4380 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut read).unwrap();
4381 assert!(read.is_empty());
4382 node_0_stale_monitors.push(monitor);
4385 let mut node_0_monitors = Vec::new();
4386 for serialized in node_0_monitors_serialized.iter() {
4387 let mut read = &serialized[..];
4388 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut read).unwrap();
4389 assert!(read.is_empty());
4390 node_0_monitors.push(monitor);
4393 keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
4395 let mut nodes_0_read = &nodes_0_serialized[..];
4396 if let Err(msgs::DecodeError::InvalidValue) =
4397 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4398 default_config: UserConfig::default(),
4399 keys_manager: &keys_manager,
4400 fee_estimator: &fee_estimator,
4401 monitor: nodes[0].chan_monitor,
4402 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4404 channel_monitors: &mut node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo(), monitor) }).collect(),
4406 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
4409 let mut nodes_0_read = &nodes_0_serialized[..];
4410 let (_, nodes_0_deserialized_tmp) =
4411 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4412 default_config: UserConfig::default(),
4413 keys_manager: &keys_manager,
4414 fee_estimator: &fee_estimator,
4415 monitor: nodes[0].chan_monitor,
4416 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4418 channel_monitors: &mut node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo(), monitor) }).collect(),
4420 nodes_0_deserialized = nodes_0_deserialized_tmp;
4421 assert!(nodes_0_read.is_empty());
4423 { // Channel close should result in a commitment tx and an HTLC tx
4424 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4425 assert_eq!(txn.len(), 2);
4426 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
4427 assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
4430 for monitor in node_0_monitors.drain(..) {
4431 assert!(nodes[0].chan_monitor.add_monitor(monitor.get_funding_txo(), monitor).is_ok());
4432 check_added_monitors!(nodes[0], 1);
4434 nodes[0].node = &nodes_0_deserialized;
4436 // nodes[1] and nodes[2] have no lost state with nodes[0]...
4437 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4438 reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4439 //... and we can even still claim the payment!
4440 claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage, 1_000_000);
4442 nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4443 let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4444 nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4445 nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
4446 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4447 assert_eq!(msg_events.len(), 1);
4448 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
4450 &ErrorAction::SendErrorMessage { ref msg } => {
4451 assert_eq!(msg.channel_id, channel_id);
4453 _ => panic!("Unexpected event!"),
4458 macro_rules! check_spendable_outputs {
4459 ($node: expr, $der_idx: expr, $keysinterface: expr, $chan_value: expr) => {
4461 let events = $node.chan_monitor.simple_monitor.get_and_clear_pending_events();
4462 let mut txn = Vec::new();
4463 for event in events {
4465 Event::SpendableOutputs { ref outputs } => {
4466 for outp in outputs {
4468 SpendableOutputDescriptor::StaticOutputRemotePayment { ref outpoint, ref output, ref key_derivation_params } => {
4470 previous_output: outpoint.clone(),
4471 script_sig: Script::new(),
4473 witness: Vec::new(),
4476 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4477 value: output.value,
4479 let mut spend_tx = Transaction {
4485 let secp_ctx = Secp256k1::new();
4486 let keys = $keysinterface.derive_channel_keys($chan_value, key_derivation_params.0, key_derivation_params.1);
4487 let remotepubkey = keys.pubkeys().payment_point;
4488 let witness_script = Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: remotepubkey}, Network::Testnet).script_pubkey();
4489 let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
4490 let remotesig = secp_ctx.sign(&sighash, &keys.inner.payment_key);
4491 spend_tx.input[0].witness.push(remotesig.serialize_der().to_vec());
4492 spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4493 spend_tx.input[0].witness.push(remotepubkey.serialize().to_vec());
4496 SpendableOutputDescriptor::DynamicOutputP2WSH { ref outpoint, ref per_commitment_point, ref to_self_delay, ref output, ref key_derivation_params, ref remote_revocation_pubkey } => {
4498 previous_output: outpoint.clone(),
4499 script_sig: Script::new(),
4500 sequence: *to_self_delay as u32,
4501 witness: Vec::new(),
4504 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4505 value: output.value,
4507 let mut spend_tx = Transaction {
4513 let secp_ctx = Secp256k1::new();
4514 let keys = $keysinterface.derive_channel_keys($chan_value, key_derivation_params.0, key_derivation_params.1);
4515 if let Ok(delayed_payment_key) = chan_utils::derive_private_key(&secp_ctx, &per_commitment_point, &keys.inner.delayed_payment_base_key) {
4517 let delayed_payment_pubkey = PublicKey::from_secret_key(&secp_ctx, &delayed_payment_key);
4518 let witness_script = chan_utils::get_revokeable_redeemscript(remote_revocation_pubkey, *to_self_delay, &delayed_payment_pubkey);
4519 let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
4520 let local_delayedsig = secp_ctx.sign(&sighash, &delayed_payment_key);
4521 spend_tx.input[0].witness.push(local_delayedsig.serialize_der().to_vec());
4522 spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4523 spend_tx.input[0].witness.push(vec!()); //MINIMALIF
4524 spend_tx.input[0].witness.push(witness_script.clone().into_bytes());
4528 SpendableOutputDescriptor::StaticOutput { ref outpoint, ref output } => {
4529 let secp_ctx = Secp256k1::new();
4531 previous_output: outpoint.clone(),
4532 script_sig: Script::new(),
4534 witness: Vec::new(),
4537 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4538 value: output.value,
4540 let mut spend_tx = Transaction {
4544 output: vec![outp.clone()],
4547 match ExtendedPrivKey::new_master(Network::Testnet, &$node.node_seed) {
4549 match master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx($der_idx).expect("key space exhausted")) {
4551 Err(_) => panic!("Your RNG is busted"),
4554 Err(_) => panic!("Your rng is busted"),
4557 let pubkey = ExtendedPubKey::from_private(&secp_ctx, &secret).public_key;
4558 let witness_script = Address::p2pkh(&pubkey, Network::Testnet).script_pubkey();
4559 let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
4560 let sig = secp_ctx.sign(&sighash, &secret.private_key.key);
4561 spend_tx.input[0].witness.push(sig.serialize_der().to_vec());
4562 spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4563 spend_tx.input[0].witness.push(pubkey.key.serialize().to_vec());
4569 _ => panic!("Unexpected event"),
4578 fn test_claim_sizeable_push_msat() {
4579 // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4580 let chanmon_cfgs = create_chanmon_cfgs(2);
4581 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4582 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4583 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4585 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4586 nodes[1].node.force_close_channel(&chan.2);
4587 check_closed_broadcast!(nodes[1], false);
4588 check_added_monitors!(nodes[1], 1);
4589 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4590 assert_eq!(node_txn.len(), 1);
4591 check_spends!(node_txn[0], chan.3);
4592 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
4594 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4595 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
4596 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4598 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4599 assert_eq!(spend_txn.len(), 1);
4600 check_spends!(spend_txn[0], node_txn[0]);
4604 fn test_claim_on_remote_sizeable_push_msat() {
4605 // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4606 // to_remote output is encumbered by a P2WPKH
4607 let chanmon_cfgs = create_chanmon_cfgs(2);
4608 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4609 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4610 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4612 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4613 nodes[0].node.force_close_channel(&chan.2);
4614 check_closed_broadcast!(nodes[0], false);
4615 check_added_monitors!(nodes[0], 1);
4617 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4618 assert_eq!(node_txn.len(), 1);
4619 check_spends!(node_txn[0], chan.3);
4620 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
4622 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4623 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
4624 check_closed_broadcast!(nodes[1], false);
4625 check_added_monitors!(nodes[1], 1);
4626 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4628 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4629 assert_eq!(spend_txn.len(), 2);
4630 assert_eq!(spend_txn[0], spend_txn[1]);
4631 check_spends!(spend_txn[0], node_txn[0]);
4635 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4636 // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4637 // to_remote output is encumbered by a P2WPKH
4639 let chanmon_cfgs = create_chanmon_cfgs(2);
4640 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4641 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4642 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4644 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::known(), InitFeatures::known());
4645 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4646 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4647 assert_eq!(revoked_local_txn[0].input.len(), 1);
4648 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4650 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4651 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4652 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 0);
4653 check_closed_broadcast!(nodes[1], false);
4654 check_added_monitors!(nodes[1], 1);
4656 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4657 let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4658 nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4659 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4661 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4662 assert_eq!(spend_txn.len(), 3);
4663 assert_eq!(spend_txn[0], spend_txn[1]); // to_remote output on revoked remote commitment_tx
4664 check_spends!(spend_txn[0], revoked_local_txn[0]);
4665 check_spends!(spend_txn[2], node_txn[0]);
4669 fn test_static_spendable_outputs_preimage_tx() {
4670 let chanmon_cfgs = create_chanmon_cfgs(2);
4671 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4672 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4673 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4675 // Create some initial channels
4676 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4678 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4680 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4681 assert_eq!(commitment_tx[0].input.len(), 1);
4682 assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4684 // Settle A's commitment tx on B's chain
4685 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4686 assert!(nodes[1].node.claim_funds(payment_preimage, &None, 3_000_000));
4687 check_added_monitors!(nodes[1], 1);
4688 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()] }, 1);
4689 check_added_monitors!(nodes[1], 1);
4690 let events = nodes[1].node.get_and_clear_pending_msg_events();
4692 MessageSendEvent::UpdateHTLCs { .. } => {},
4693 _ => panic!("Unexpected event"),
4696 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4697 _ => panic!("Unexepected event"),
4700 // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4701 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4702 assert_eq!(node_txn.len(), 3);
4703 check_spends!(node_txn[0], commitment_tx[0]);
4704 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4705 check_spends!(node_txn[1], chan_1.3);
4706 check_spends!(node_txn[2], node_txn[1]);
4708 let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4709 nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4710 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4712 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4713 assert_eq!(spend_txn.len(), 1);
4714 check_spends!(spend_txn[0], node_txn[0]);
4718 fn test_static_spendable_outputs_timeout_tx() {
4719 let chanmon_cfgs = create_chanmon_cfgs(2);
4720 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4721 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4722 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4724 // Create some initial channels
4725 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4727 // Rebalance the network a bit by relaying one payment through all the channels ...
4728 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
4730 let (_, our_payment_hash) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
4732 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4733 assert_eq!(commitment_tx[0].input.len(), 1);
4734 assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4736 // Settle A's commitment tx on B' chain
4737 let header = BlockHeader { version: 0x2000_0000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
4738 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()] }, 0);
4739 check_added_monitors!(nodes[1], 1);
4740 let events = nodes[1].node.get_and_clear_pending_msg_events();
4742 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4743 _ => panic!("Unexpected event"),
4746 // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
4747 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4748 assert_eq!(node_txn.len(), 3); // ChannelManager : 2 (local commitent tx + HTLC-timeout), ChannelMonitor: timeout tx
4749 check_spends!(node_txn[0], commitment_tx[0].clone());
4750 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4751 check_spends!(node_txn[1], chan_1.3.clone());
4752 check_spends!(node_txn[2], node_txn[1]);
4754 let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4755 nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4756 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4757 expect_payment_failed!(nodes[1], our_payment_hash, true);
4759 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4760 assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote (*2), timeout_tx.output (*1)
4761 check_spends!(spend_txn[2], node_txn[0].clone());
4765 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
4766 let chanmon_cfgs = create_chanmon_cfgs(2);
4767 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4768 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4769 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4771 // Create some initial channels
4772 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4774 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4775 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4776 assert_eq!(revoked_local_txn[0].input.len(), 1);
4777 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4779 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4781 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4782 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 0);
4783 check_closed_broadcast!(nodes[1], false);
4784 check_added_monitors!(nodes[1], 1);
4786 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4787 assert_eq!(node_txn.len(), 2);
4788 assert_eq!(node_txn[0].input.len(), 2);
4789 check_spends!(node_txn[0], revoked_local_txn[0]);
4791 let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4792 nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4793 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4795 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4796 assert_eq!(spend_txn.len(), 1);
4797 check_spends!(spend_txn[0], node_txn[0]);
4801 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
4802 let chanmon_cfgs = create_chanmon_cfgs(2);
4803 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4804 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4805 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4807 // Create some initial channels
4808 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4810 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4811 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4812 assert_eq!(revoked_local_txn[0].input.len(), 1);
4813 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4815 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4817 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4818 // A will generate HTLC-Timeout from revoked commitment tx
4819 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4820 check_closed_broadcast!(nodes[0], false);
4821 check_added_monitors!(nodes[0], 1);
4823 let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4824 assert_eq!(revoked_htlc_txn.len(), 2);
4825 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4826 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4827 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
4828 check_spends!(revoked_htlc_txn[1], chan_1.3);
4830 // B will generate justice tx from A's revoked commitment/HTLC tx
4831 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 0);
4832 check_closed_broadcast!(nodes[1], false);
4833 check_added_monitors!(nodes[1], 1);
4835 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4836 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
4837 assert_eq!(node_txn[0].input.len(), 2);
4838 check_spends!(node_txn[0], revoked_local_txn[0]);
4839 check_spends!(node_txn[1], chan_1.3);
4840 assert_eq!(node_txn[2].input.len(), 1);
4841 check_spends!(node_txn[2], revoked_htlc_txn[0]);
4842 assert_eq!(node_txn[3].input.len(), 1);
4843 check_spends!(node_txn[3], revoked_local_txn[0]);
4845 let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4846 nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone(), node_txn[2].clone()] }, 1);
4847 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4849 // Check B's ChannelMonitor was able to generate the right spendable output descriptor
4850 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4851 assert_eq!(spend_txn.len(), 2);
4852 check_spends!(spend_txn[0], node_txn[0]);
4853 check_spends!(spend_txn[1], node_txn[2]);
4857 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
4858 let chanmon_cfgs = create_chanmon_cfgs(2);
4859 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4860 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4861 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4863 // Create some initial channels
4864 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4866 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4867 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
4868 assert_eq!(revoked_local_txn[0].input.len(), 1);
4869 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4871 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4873 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4874 // B will generate HTLC-Success from revoked commitment tx
4875 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4876 check_closed_broadcast!(nodes[1], false);
4877 check_added_monitors!(nodes[1], 1);
4878 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4880 assert_eq!(revoked_htlc_txn.len(), 2);
4881 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4882 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4883 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
4885 // A will generate justice tx from B's revoked commitment/HTLC tx
4886 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
4887 check_closed_broadcast!(nodes[0], false);
4888 check_added_monitors!(nodes[0], 1);
4890 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4891 assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
4892 assert_eq!(node_txn[2].input.len(), 1);
4893 check_spends!(node_txn[2], revoked_htlc_txn[0]);
4895 let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4896 nodes[0].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone(), node_txn[2].clone()] }, 1);
4897 connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4899 // Check A's ChannelMonitor was able to generate the right spendable output descriptor
4900 let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
4901 assert_eq!(spend_txn.len(), 5); // Duplicated SpendableOutput due to block rescan after revoked htlc output tracking
4902 assert_eq!(spend_txn[0], spend_txn[1]);
4903 assert_eq!(spend_txn[0], spend_txn[2]);
4904 check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
4905 check_spends!(spend_txn[3], node_txn[0]); // spending justice tx output from revoked local tx htlc received output
4906 check_spends!(spend_txn[4], node_txn[2]); // spending justice tx output on htlc success tx
4910 fn test_onchain_to_onchain_claim() {
4911 // Test that in case of channel closure, we detect the state of output thanks to
4912 // ChainWatchInterface and claim HTLC on downstream peer's remote commitment tx.
4913 // First, have C claim an HTLC against its own latest commitment transaction.
4914 // Then, broadcast these to B, which should update the monitor downstream on the A<->B
4916 // Finally, check that B will claim the HTLC output if A's latest commitment transaction
4919 let chanmon_cfgs = create_chanmon_cfgs(3);
4920 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4921 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4922 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4924 // Create some initial channels
4925 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4926 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
4928 // Rebalance the network a bit by relaying one payment through all the channels ...
4929 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
4930 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
4932 let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
4933 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
4934 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
4935 check_spends!(commitment_tx[0], chan_2.3);
4936 nodes[2].node.claim_funds(payment_preimage, &None, 3_000_000);
4937 check_added_monitors!(nodes[2], 1);
4938 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
4939 assert!(updates.update_add_htlcs.is_empty());
4940 assert!(updates.update_fail_htlcs.is_empty());
4941 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4942 assert!(updates.update_fail_malformed_htlcs.is_empty());
4944 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
4945 check_closed_broadcast!(nodes[2], false);
4946 check_added_monitors!(nodes[2], 1);
4948 let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
4949 assert_eq!(c_txn.len(), 3);
4950 assert_eq!(c_txn[0], c_txn[2]);
4951 assert_eq!(commitment_tx[0], c_txn[1]);
4952 check_spends!(c_txn[1], chan_2.3);
4953 check_spends!(c_txn[2], c_txn[1]);
4954 assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
4955 assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4956 assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
4957 assert_eq!(c_txn[0].lock_time, 0); // Success tx
4959 // 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
4960 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]}, 1);
4962 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4963 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-timeout tx
4964 assert_eq!(b_txn.len(), 3);
4965 check_spends!(b_txn[1], chan_2.3); // B local commitment tx, issued by ChannelManager
4966 check_spends!(b_txn[2], b_txn[1]); // HTLC-Timeout on B local commitment tx, issued by ChannelManager
4967 assert_eq!(b_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4968 assert!(b_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
4969 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
4970 check_spends!(b_txn[0], c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor, * 2 due to block rescan
4971 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4972 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
4973 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
4976 check_added_monitors!(nodes[1], 1);
4977 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
4978 check_added_monitors!(nodes[1], 1);
4979 match msg_events[0] {
4980 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4981 _ => panic!("Unexpected event"),
4983 match msg_events[1] {
4984 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, .. } } => {
4985 assert!(update_add_htlcs.is_empty());
4986 assert!(update_fail_htlcs.is_empty());
4987 assert_eq!(update_fulfill_htlcs.len(), 1);
4988 assert!(update_fail_malformed_htlcs.is_empty());
4989 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
4991 _ => panic!("Unexpected event"),
4993 // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
4994 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4995 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
4996 let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4997 // ChannelMonitor: HTLC-Success tx, ChannelManager: local commitment tx + HTLC-Success tx
4998 assert_eq!(b_txn.len(), 3);
4999 check_spends!(b_txn[1], chan_1.3);
5000 check_spends!(b_txn[2], b_txn[1]);
5001 check_spends!(b_txn[0], commitment_tx[0]);
5002 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5003 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5004 assert_eq!(b_txn[0].lock_time, 0); // Success tx
5006 check_closed_broadcast!(nodes[1], false);
5007 check_added_monitors!(nodes[1], 1);
5011 fn test_duplicate_payment_hash_one_failure_one_success() {
5012 // Topology : A --> B --> C
5013 // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
5014 let chanmon_cfgs = create_chanmon_cfgs(3);
5015 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5016 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5017 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5019 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5020 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5022 let (our_payment_preimage, duplicate_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
5023 *nodes[0].network_payment_count.borrow_mut() -= 1;
5024 assert_eq!(route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000).1, duplicate_payment_hash);
5026 let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
5027 assert_eq!(commitment_txn[0].input.len(), 1);
5028 check_spends!(commitment_txn[0], chan_2.3);
5030 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5031 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
5032 check_closed_broadcast!(nodes[1], false);
5033 check_added_monitors!(nodes[1], 1);
5035 let htlc_timeout_tx;
5036 { // Extract one of the two HTLC-Timeout transaction
5037 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5038 // ChannelMonitor: timeout tx * 2, ChannelManager: local commitment tx + HTLC-timeout * 2
5039 assert_eq!(node_txn.len(), 5);
5040 check_spends!(node_txn[0], commitment_txn[0]);
5041 assert_eq!(node_txn[0].input.len(), 1);
5042 check_spends!(node_txn[1], commitment_txn[0]);
5043 assert_eq!(node_txn[1].input.len(), 1);
5044 assert_ne!(node_txn[0].input[0], node_txn[1].input[0]);
5045 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5046 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5047 check_spends!(node_txn[2], chan_2.3);
5048 check_spends!(node_txn[3], node_txn[2]);
5049 check_spends!(node_txn[4], node_txn[2]);
5050 htlc_timeout_tx = node_txn[1].clone();
5053 nodes[2].node.claim_funds(our_payment_preimage, &None, 900_000);
5054 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
5055 check_added_monitors!(nodes[2], 3);
5056 let events = nodes[2].node.get_and_clear_pending_msg_events();
5058 MessageSendEvent::UpdateHTLCs { .. } => {},
5059 _ => panic!("Unexpected event"),
5062 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5063 _ => panic!("Unexepected event"),
5065 let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5066 assert_eq!(htlc_success_txn.len(), 5); // ChannelMonitor: HTLC-Success txn (*2 due to 2-HTLC outputs), ChannelManager: local commitment tx + HTLC-Success txn (*2 due to 2-HTLC outputs)
5067 check_spends!(htlc_success_txn[2], chan_2.3);
5068 check_spends!(htlc_success_txn[3], htlc_success_txn[2]);
5069 check_spends!(htlc_success_txn[4], htlc_success_txn[2]);
5070 assert_eq!(htlc_success_txn[0], htlc_success_txn[3]);
5071 assert_eq!(htlc_success_txn[0].input.len(), 1);
5072 assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5073 assert_eq!(htlc_success_txn[1], htlc_success_txn[4]);
5074 assert_eq!(htlc_success_txn[1].input.len(), 1);
5075 assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5076 assert_ne!(htlc_success_txn[0].input[0], htlc_success_txn[1].input[0]);
5077 check_spends!(htlc_success_txn[0], commitment_txn[0]);
5078 check_spends!(htlc_success_txn[1], commitment_txn[0]);
5080 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![htlc_timeout_tx] }, 200);
5081 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
5082 expect_pending_htlcs_forwardable!(nodes[1]);
5083 let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5084 assert!(htlc_updates.update_add_htlcs.is_empty());
5085 assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5086 assert_eq!(htlc_updates.update_fail_htlcs[0].htlc_id, 1);
5087 assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5088 assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5089 check_added_monitors!(nodes[1], 1);
5091 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
5092 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5094 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5095 let events = nodes[0].node.get_and_clear_pending_msg_events();
5096 assert_eq!(events.len(), 1);
5098 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. } } => {
5100 _ => { panic!("Unexpected event"); }
5103 expect_payment_failed!(nodes[0], duplicate_payment_hash, false);
5105 // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5106 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![htlc_success_txn[0].clone()] }, 200);
5107 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5108 assert!(updates.update_add_htlcs.is_empty());
5109 assert!(updates.update_fail_htlcs.is_empty());
5110 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5111 assert_eq!(updates.update_fulfill_htlcs[0].htlc_id, 0);
5112 assert!(updates.update_fail_malformed_htlcs.is_empty());
5113 check_added_monitors!(nodes[1], 1);
5115 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
5116 commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5118 let events = nodes[0].node.get_and_clear_pending_events();
5120 Event::PaymentSent { ref payment_preimage } => {
5121 assert_eq!(*payment_preimage, our_payment_preimage);
5123 _ => panic!("Unexpected event"),
5128 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
5129 let chanmon_cfgs = create_chanmon_cfgs(2);
5130 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5131 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5132 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5134 // Create some initial channels
5135 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5137 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5138 let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5139 assert_eq!(local_txn[0].input.len(), 1);
5140 check_spends!(local_txn[0], chan_1.3);
5142 // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5143 nodes[1].node.claim_funds(payment_preimage, &None, 9_000_000);
5144 check_added_monitors!(nodes[1], 1);
5145 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5146 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![local_txn[0].clone()] }, 1);
5147 check_added_monitors!(nodes[1], 1);
5148 let events = nodes[1].node.get_and_clear_pending_msg_events();
5150 MessageSendEvent::UpdateHTLCs { .. } => {},
5151 _ => panic!("Unexpected event"),
5154 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5155 _ => panic!("Unexepected event"),
5158 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5159 assert_eq!(node_txn[0].input.len(), 1);
5160 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5161 check_spends!(node_txn[0], local_txn[0]);
5162 vec![node_txn[0].clone(), node_txn[2].clone()]
5165 let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5166 nodes[1].block_notifier.block_connected(&Block { header: header_201, txdata: node_txn.clone() }, 201);
5167 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 201, true, header_201.bitcoin_hash());
5169 // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5170 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5171 assert_eq!(spend_txn.len(), 2);
5172 check_spends!(spend_txn[0], node_txn[0]);
5173 check_spends!(spend_txn[1], node_txn[1]);
5176 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
5177 // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
5178 // unrevoked commitment transaction.
5179 // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
5180 // a remote RAA before they could be failed backwards (and combinations thereof).
5181 // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
5182 // use the same payment hashes.
5183 // Thus, we use a six-node network:
5188 // And test where C fails back to A/B when D announces its latest commitment transaction
5189 let chanmon_cfgs = create_chanmon_cfgs(6);
5190 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
5191 let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
5192 let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
5193 let logger = test_utils::TestLogger::new();
5195 create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5196 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5197 let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5198 create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
5199 create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
5201 // Rebalance and check output sanity...
5202 send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000, 500_000);
5203 send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000, 500_000);
5204 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
5206 let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
5208 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
5210 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
5211 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
5212 let our_node_id = &nodes[1].node.get_our_node_id();
5213 let route = get_route(our_node_id, net_graph_msg_handler, &nodes[5].node.get_our_node_id(), None, &Vec::new(), ds_dust_limit*1000, TEST_FINAL_CLTV, &logger).unwrap();
5215 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
5217 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
5219 let (_, payment_hash_3) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5221 let (_, payment_hash_4) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5222 let route = get_route(our_node_id, net_graph_msg_handler, &nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
5224 send_along_route_with_hash(&nodes[1], route.clone(), &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_3);
5226 send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_4);
5229 let (_, payment_hash_5) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5231 let route = get_route(our_node_id, net_graph_msg_handler, &nodes[5].node.get_our_node_id(), None, &Vec::new(), ds_dust_limit*1000, TEST_FINAL_CLTV, &logger).unwrap();
5232 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
5235 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
5237 let route = get_route(our_node_id, net_graph_msg_handler, &nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
5238 send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_6);
5240 // Double-check that six of the new HTLC were added
5241 // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
5242 // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
5243 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
5244 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
5246 // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
5247 // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
5248 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1, &None));
5249 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3, &None));
5250 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5, &None));
5251 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6, &None));
5252 check_added_monitors!(nodes[4], 0);
5253 expect_pending_htlcs_forwardable!(nodes[4]);
5254 check_added_monitors!(nodes[4], 1);
5256 let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
5257 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
5258 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
5259 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
5260 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
5261 commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
5263 // Fail 3rd below-dust and 7th above-dust HTLCs
5264 assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2, &None));
5265 assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4, &None));
5266 check_added_monitors!(nodes[5], 0);
5267 expect_pending_htlcs_forwardable!(nodes[5]);
5268 check_added_monitors!(nodes[5], 1);
5270 let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5271 nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5272 nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5273 commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5275 let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5277 expect_pending_htlcs_forwardable!(nodes[3]);
5278 check_added_monitors!(nodes[3], 1);
5279 let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5280 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5281 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5282 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5283 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5284 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5285 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5286 if deliver_last_raa {
5287 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5289 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5292 // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5293 // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5294 // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5295 // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5297 // We now broadcast the latest commitment transaction, which *should* result in failures for
5298 // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5299 // the non-broadcast above-dust HTLCs.
5301 // Alternatively, we may broadcast the previous commitment transaction, which should only
5302 // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5303 let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5305 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5306 if announce_latest {
5307 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![ds_last_commitment_tx[0].clone()]}, 1);
5309 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![ds_prev_commitment_tx[0].clone()]}, 1);
5311 connect_blocks(&nodes[2].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
5312 check_closed_broadcast!(nodes[2], false);
5313 expect_pending_htlcs_forwardable!(nodes[2]);
5314 check_added_monitors!(nodes[2], 3);
5316 let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5317 assert_eq!(cs_msgs.len(), 2);
5318 let mut a_done = false;
5319 for msg in cs_msgs {
5321 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5322 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5323 // should be failed-backwards here.
5324 let target = if *node_id == nodes[0].node.get_our_node_id() {
5325 // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5326 for htlc in &updates.update_fail_htlcs {
5327 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 });
5329 assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5334 // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5335 for htlc in &updates.update_fail_htlcs {
5336 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5338 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5339 assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5342 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5343 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5344 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5345 if announce_latest {
5346 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5347 if *node_id == nodes[0].node.get_our_node_id() {
5348 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5351 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5353 _ => panic!("Unexpected event"),
5357 let as_events = nodes[0].node.get_and_clear_pending_events();
5358 assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
5359 let mut as_failds = HashSet::new();
5360 for event in as_events.iter() {
5361 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5362 assert!(as_failds.insert(*payment_hash));
5363 if *payment_hash != payment_hash_2 {
5364 assert_eq!(*rejected_by_dest, deliver_last_raa);
5366 assert!(!rejected_by_dest);
5368 } else { panic!("Unexpected event"); }
5370 assert!(as_failds.contains(&payment_hash_1));
5371 assert!(as_failds.contains(&payment_hash_2));
5372 if announce_latest {
5373 assert!(as_failds.contains(&payment_hash_3));
5374 assert!(as_failds.contains(&payment_hash_5));
5376 assert!(as_failds.contains(&payment_hash_6));
5378 let bs_events = nodes[1].node.get_and_clear_pending_events();
5379 assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
5380 let mut bs_failds = HashSet::new();
5381 for event in bs_events.iter() {
5382 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5383 assert!(bs_failds.insert(*payment_hash));
5384 if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5385 assert_eq!(*rejected_by_dest, deliver_last_raa);
5387 assert!(!rejected_by_dest);
5389 } else { panic!("Unexpected event"); }
5391 assert!(bs_failds.contains(&payment_hash_1));
5392 assert!(bs_failds.contains(&payment_hash_2));
5393 if announce_latest {
5394 assert!(bs_failds.contains(&payment_hash_4));
5396 assert!(bs_failds.contains(&payment_hash_5));
5398 // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5399 // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
5400 // to unknown-preimage-etc, B should have gotten 2. Thus, in the
5401 // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
5402 // PaymentFailureNetworkUpdates.
5403 let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
5404 assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5405 let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5406 assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5407 for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
5409 &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
5410 _ => panic!("Unexpected event"),
5416 fn test_fail_backwards_latest_remote_announce_a() {
5417 do_test_fail_backwards_unrevoked_remote_announce(false, true);
5421 fn test_fail_backwards_latest_remote_announce_b() {
5422 do_test_fail_backwards_unrevoked_remote_announce(true, true);
5426 fn test_fail_backwards_previous_remote_announce() {
5427 do_test_fail_backwards_unrevoked_remote_announce(false, false);
5428 // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5429 // tested for in test_commitment_revoked_fail_backward_exhaustive()
5433 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5434 let chanmon_cfgs = create_chanmon_cfgs(2);
5435 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5436 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5437 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5439 // Create some initial channels
5440 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5442 let (_, our_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5443 let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5444 assert_eq!(local_txn[0].input.len(), 1);
5445 check_spends!(local_txn[0], chan_1.3);
5447 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5448 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5449 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![local_txn[0].clone()] }, 200);
5450 check_closed_broadcast!(nodes[0], false);
5451 check_added_monitors!(nodes[0], 1);
5453 let htlc_timeout = {
5454 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5455 assert_eq!(node_txn[0].input.len(), 1);
5456 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5457 check_spends!(node_txn[0], local_txn[0]);
5461 let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5462 nodes[0].block_notifier.block_connected(&Block { header: header_201, txdata: vec![htlc_timeout.clone()] }, 201);
5463 connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 201, true, header_201.bitcoin_hash());
5464 expect_payment_failed!(nodes[0], our_payment_hash, true);
5466 // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5467 let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
5468 assert_eq!(spend_txn.len(), 3);
5469 assert_eq!(spend_txn[0], spend_txn[1]);
5470 check_spends!(spend_txn[0], local_txn[0]);
5471 check_spends!(spend_txn[2], htlc_timeout);
5475 fn test_key_derivation_params() {
5476 // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with
5477 // a key manager rotation to test that key_derivation_params returned in DynamicOutputP2WSH
5478 // let us re-derive the channel key set to then derive a delayed_payment_key.
5480 let chanmon_cfgs = create_chanmon_cfgs(3);
5482 // We manually create the node configuration to backup the seed.
5483 let mut rng = thread_rng();
5484 let mut seed = [0; 32];
5485 rng.fill_bytes(&mut seed);
5486 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5487 let chan_monitor = test_utils::TestChannelMonitor::new(&chanmon_cfgs[0].chain_monitor, &chanmon_cfgs[0].tx_broadcaster, &chanmon_cfgs[0].logger, &chanmon_cfgs[0].fee_estimator);
5488 let node = NodeCfg { chain_monitor: &chanmon_cfgs[0].chain_monitor, logger: &chanmon_cfgs[0].logger, tx_broadcaster: &chanmon_cfgs[0].tx_broadcaster, fee_estimator: &chanmon_cfgs[0].fee_estimator, chan_monitor, keys_manager, node_seed: seed };
5489 let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5490 node_cfgs.remove(0);
5491 node_cfgs.insert(0, node);
5493 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5494 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5496 // Create some initial channels
5497 // Create a dummy channel to advance index by one and thus test re-derivation correctness
5499 let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5500 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5501 assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5503 let (_, our_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5504 let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5505 let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5506 assert_eq!(local_txn_1[0].input.len(), 1);
5507 check_spends!(local_txn_1[0], chan_1.3);
5509 // We check funding pubkey are unique
5510 let (from_0_funding_key_0, from_0_funding_key_1) = (PublicKey::from_slice(&local_txn_0[0].input[0].witness[3][2..35]), PublicKey::from_slice(&local_txn_0[0].input[0].witness[3][36..69]));
5511 let (from_1_funding_key_0, from_1_funding_key_1) = (PublicKey::from_slice(&local_txn_1[0].input[0].witness[3][2..35]), PublicKey::from_slice(&local_txn_1[0].input[0].witness[3][36..69]));
5512 if from_0_funding_key_0 == from_1_funding_key_0
5513 || from_0_funding_key_0 == from_1_funding_key_1
5514 || from_0_funding_key_1 == from_1_funding_key_0
5515 || from_0_funding_key_1 == from_1_funding_key_1 {
5516 panic!("Funding pubkeys aren't unique");
5519 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5520 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5521 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![local_txn_1[0].clone()] }, 200);
5522 check_closed_broadcast!(nodes[0], false);
5523 check_added_monitors!(nodes[0], 1);
5525 let htlc_timeout = {
5526 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5527 assert_eq!(node_txn[0].input.len(), 1);
5528 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5529 check_spends!(node_txn[0], local_txn_1[0]);
5533 let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5534 nodes[0].block_notifier.block_connected(&Block { header: header_201, txdata: vec![htlc_timeout.clone()] }, 201);
5535 connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 201, true, header_201.bitcoin_hash());
5536 expect_payment_failed!(nodes[0], our_payment_hash, true);
5538 // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5539 let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5540 let spend_txn = check_spendable_outputs!(nodes[0], 1, new_keys_manager, 100000);
5541 assert_eq!(spend_txn.len(), 3);
5542 assert_eq!(spend_txn[0], spend_txn[1]);
5543 check_spends!(spend_txn[0], local_txn_1[0]);
5544 check_spends!(spend_txn[2], htlc_timeout);
5548 fn test_static_output_closing_tx() {
5549 let chanmon_cfgs = create_chanmon_cfgs(2);
5550 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5551 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5552 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5554 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5556 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
5557 let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5559 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5560 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![closing_tx.clone()] }, 0);
5561 connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 0, true, header.bitcoin_hash());
5563 let spend_txn = check_spendable_outputs!(nodes[0], 2, node_cfgs[0].keys_manager, 100000);
5564 assert_eq!(spend_txn.len(), 1);
5565 check_spends!(spend_txn[0], closing_tx);
5567 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![closing_tx.clone()] }, 0);
5568 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 0, true, header.bitcoin_hash());
5570 let spend_txn = check_spendable_outputs!(nodes[1], 2, node_cfgs[1].keys_manager, 100000);
5571 assert_eq!(spend_txn.len(), 1);
5572 check_spends!(spend_txn[0], closing_tx);
5575 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5576 let chanmon_cfgs = create_chanmon_cfgs(2);
5577 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5578 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5579 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5580 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5582 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5584 // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5585 // present in B's local commitment transaction, but none of A's commitment transactions.
5586 assert!(nodes[1].node.claim_funds(our_payment_preimage, &None, if use_dust { 50_000 } else { 3_000_000 }));
5587 check_added_monitors!(nodes[1], 1);
5589 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5590 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5591 let events = nodes[0].node.get_and_clear_pending_events();
5592 assert_eq!(events.len(), 1);
5594 Event::PaymentSent { payment_preimage } => {
5595 assert_eq!(payment_preimage, our_payment_preimage);
5597 _ => panic!("Unexpected event"),
5600 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5601 check_added_monitors!(nodes[0], 1);
5602 let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5603 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5604 check_added_monitors!(nodes[1], 1);
5606 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5607 for i in 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + CHAN_CONFIRM_DEPTH + 1 {
5608 nodes[1].block_notifier.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
5609 header.prev_blockhash = header.bitcoin_hash();
5611 test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5612 check_closed_broadcast!(nodes[1], false);
5613 check_added_monitors!(nodes[1], 1);
5616 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5617 let chanmon_cfgs = create_chanmon_cfgs(2);
5618 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5619 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5620 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5621 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5622 let logger = test_utils::TestLogger::new();
5624 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
5625 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5626 let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[1].node.get_our_node_id(), None, &Vec::new(), if use_dust { 50000 } else { 3000000 }, TEST_FINAL_CLTV, &logger).unwrap();
5627 nodes[0].node.send_payment(&route, payment_hash, &None).unwrap();
5628 check_added_monitors!(nodes[0], 1);
5630 let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5632 // As far as A is concerned, the HTLC is now present only in the latest remote commitment
5633 // transaction, however it is not in A's latest local commitment, so we can just broadcast that
5634 // to "time out" the HTLC.
5636 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5638 for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
5639 nodes[0].block_notifier.block_connected(&Block { header, txdata: Vec::new()}, i);
5640 header.prev_blockhash = header.bitcoin_hash();
5642 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5643 check_closed_broadcast!(nodes[0], false);
5644 check_added_monitors!(nodes[0], 1);
5647 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
5648 let chanmon_cfgs = create_chanmon_cfgs(3);
5649 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5650 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5651 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5652 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5654 // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
5655 // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
5656 // Also optionally test that we *don't* fail the channel in case the commitment transaction was
5657 // actually revoked.
5658 let htlc_value = if use_dust { 50000 } else { 3000000 };
5659 let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
5660 assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash, &None));
5661 expect_pending_htlcs_forwardable!(nodes[1]);
5662 check_added_monitors!(nodes[1], 1);
5664 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5665 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
5666 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5667 check_added_monitors!(nodes[0], 1);
5668 let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5669 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5670 check_added_monitors!(nodes[1], 1);
5671 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
5672 check_added_monitors!(nodes[1], 1);
5673 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
5675 if check_revoke_no_close {
5676 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
5677 check_added_monitors!(nodes[0], 1);
5680 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5681 for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
5682 nodes[0].block_notifier.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
5683 header.prev_blockhash = header.bitcoin_hash();
5685 if !check_revoke_no_close {
5686 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5687 check_closed_broadcast!(nodes[0], false);
5688 check_added_monitors!(nodes[0], 1);
5690 expect_payment_failed!(nodes[0], our_payment_hash, true);
5694 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
5695 // There are only a few cases to test here:
5696 // * its not really normative behavior, but we test that below-dust HTLCs "included" in
5697 // broadcastable commitment transactions result in channel closure,
5698 // * its included in an unrevoked-but-previous remote commitment transaction,
5699 // * its included in the latest remote or local commitment transactions.
5700 // We test each of the three possible commitment transactions individually and use both dust and
5702 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
5703 // assume they are handled the same across all six cases, as both outbound and inbound failures are
5704 // tested for at least one of the cases in other tests.
5706 fn htlc_claim_single_commitment_only_a() {
5707 do_htlc_claim_local_commitment_only(true);
5708 do_htlc_claim_local_commitment_only(false);
5710 do_htlc_claim_current_remote_commitment_only(true);
5711 do_htlc_claim_current_remote_commitment_only(false);
5715 fn htlc_claim_single_commitment_only_b() {
5716 do_htlc_claim_previous_remote_commitment_only(true, false);
5717 do_htlc_claim_previous_remote_commitment_only(false, false);
5718 do_htlc_claim_previous_remote_commitment_only(true, true);
5719 do_htlc_claim_previous_remote_commitment_only(false, true);
5722 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>)
5723 where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
5726 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);
5730 // 0: node1 fails backward
5731 // 1: final node fails backward
5732 // 2: payment completed but the user rejects the payment
5733 // 3: final node fails backward (but tamper onion payloads from node0)
5734 // 100: trigger error in the intermediate node and tamper returning fail_htlc
5735 // 200: trigger error in the final node and tamper returning fail_htlc
5736 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>)
5737 where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
5738 F2: for <'a> FnMut(&'a mut msgs::UpdateFailHTLC),
5742 // reset block height
5743 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5744 for ix in 0..nodes.len() {
5745 nodes[ix].block_notifier.block_connected_checked(&header, 1, &[], &[]);
5748 macro_rules! expect_event {
5749 ($node: expr, $event_type: path) => {{
5750 let events = $node.node.get_and_clear_pending_events();
5751 assert_eq!(events.len(), 1);
5753 $event_type { .. } => {},
5754 _ => panic!("Unexpected event"),
5759 macro_rules! expect_htlc_forward {
5761 expect_event!($node, Event::PendingHTLCsForwardable);
5762 $node.node.process_pending_htlc_forwards();
5766 // 0 ~~> 2 send payment
5767 nodes[0].node.send_payment(&route, payment_hash.clone(), &None).unwrap();
5768 check_added_monitors!(nodes[0], 1);
5769 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5770 // temper update_add (0 => 1)
5771 let mut update_add_0 = update_0.update_add_htlcs[0].clone();
5772 if test_case == 0 || test_case == 3 || test_case == 100 {
5773 callback_msg(&mut update_add_0);
5776 // 0 => 1 update_add & CS
5777 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0);
5778 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
5780 let update_1_0 = match test_case {
5781 0|100 => { // intermediate node failure; fail backward to 0
5782 let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5783 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));
5786 1|2|3|200 => { // final node failure; forwarding to 2
5787 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
5789 if test_case != 200 {
5792 expect_htlc_forward!(&nodes[1]);
5794 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
5795 check_added_monitors!(&nodes[1], 1);
5796 assert_eq!(update_1.update_add_htlcs.len(), 1);
5797 // tamper update_add (1 => 2)
5798 let mut update_add_1 = update_1.update_add_htlcs[0].clone();
5799 if test_case != 3 && test_case != 200 {
5800 callback_msg(&mut update_add_1);
5804 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1);
5805 commitment_signed_dance!(nodes[2], nodes[1], update_1.commitment_signed, false, true);
5807 if test_case == 2 || test_case == 200 {
5808 expect_htlc_forward!(&nodes[2]);
5809 expect_event!(&nodes[2], Event::PaymentReceived);
5811 expect_pending_htlcs_forwardable!(nodes[2]);
5814 let update_2_1 = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5815 if test_case == 2 || test_case == 200 {
5816 check_added_monitors!(&nodes[2], 1);
5818 assert!(update_2_1.update_fail_htlcs.len() == 1);
5820 let mut fail_msg = update_2_1.update_fail_htlcs[0].clone();
5821 if test_case == 200 {
5822 callback_fail(&mut fail_msg);
5826 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &fail_msg);
5827 commitment_signed_dance!(nodes[1], nodes[2], update_2_1.commitment_signed, true);
5829 // backward fail on 1
5830 let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5831 assert!(update_1_0.update_fail_htlcs.len() == 1);
5834 _ => unreachable!(),
5837 // 1 => 0 commitment_signed_dance
5838 if update_1_0.update_fail_htlcs.len() > 0 {
5839 let mut fail_msg = update_1_0.update_fail_htlcs[0].clone();
5840 if test_case == 100 {
5841 callback_fail(&mut fail_msg);
5843 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
5845 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_1_0.update_fail_malformed_htlcs[0]);
5848 commitment_signed_dance!(nodes[0], nodes[1], update_1_0.commitment_signed, false, true);
5850 let events = nodes[0].node.get_and_clear_pending_events();
5851 assert_eq!(events.len(), 1);
5852 if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code, error_data: _ } = &events[0] {
5853 assert_eq!(*rejected_by_dest, !expected_retryable);
5854 assert_eq!(*error_code, expected_error_code);
5856 panic!("Uexpected event");
5859 let events = nodes[0].node.get_and_clear_pending_msg_events();
5860 if expected_channel_update.is_some() {
5861 assert_eq!(events.len(), 1);
5863 MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
5865 &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {
5866 if let HTLCFailChannelUpdate::ChannelUpdateMessage { .. } = expected_channel_update.unwrap() {} else {
5867 panic!("channel_update not found!");
5870 &HTLCFailChannelUpdate::ChannelClosed { ref short_channel_id, ref is_permanent } => {
5871 if let HTLCFailChannelUpdate::ChannelClosed { short_channel_id: ref expected_short_channel_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
5872 assert!(*short_channel_id == *expected_short_channel_id);
5873 assert!(*is_permanent == *expected_is_permanent);
5875 panic!("Unexpected message event");
5878 &HTLCFailChannelUpdate::NodeFailure { ref node_id, ref is_permanent } => {
5879 if let HTLCFailChannelUpdate::NodeFailure { node_id: ref expected_node_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
5880 assert!(*node_id == *expected_node_id);
5881 assert!(*is_permanent == *expected_is_permanent);
5883 panic!("Unexpected message event");
5888 _ => panic!("Unexpected message event"),
5891 assert_eq!(events.len(), 0);
5895 impl msgs::ChannelUpdate {
5896 fn dummy() -> msgs::ChannelUpdate {
5897 use bitcoin::secp256k1::ffi::Signature as FFISignature;
5898 use bitcoin::secp256k1::Signature;
5899 msgs::ChannelUpdate {
5900 signature: Signature::from(FFISignature::new()),
5901 contents: msgs::UnsignedChannelUpdate {
5902 chain_hash: BlockHash::hash(&vec![0u8][..]),
5903 short_channel_id: 0,
5906 cltv_expiry_delta: 0,
5907 htlc_minimum_msat: 0,
5909 fee_proportional_millionths: 0,
5910 excess_data: vec![],
5916 struct BogusOnionHopData {
5919 impl BogusOnionHopData {
5920 fn new(orig: msgs::OnionHopData) -> Self {
5921 Self { data: orig.encode() }
5924 impl Writeable for BogusOnionHopData {
5925 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
5926 writer.write_all(&self.data[..])
5931 fn test_onion_failure() {
5932 use ln::msgs::ChannelUpdate;
5933 use ln::channelmanager::CLTV_FAR_FAR_AWAY;
5934 use bitcoin::secp256k1;
5936 const BADONION: u16 = 0x8000;
5937 const PERM: u16 = 0x4000;
5938 const NODE: u16 = 0x2000;
5939 const UPDATE: u16 = 0x1000;
5941 let chanmon_cfgs = create_chanmon_cfgs(3);
5942 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5943 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5944 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5945 for node in nodes.iter() {
5946 *node.keys_manager.override_session_priv.lock().unwrap() = Some(SecretKey::from_slice(&[3; 32]).unwrap());
5948 let channels = [create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()), create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known())];
5949 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
5950 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5951 let logger = test_utils::TestLogger::new();
5952 let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[2].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV, &logger).unwrap();
5954 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 40000, 40_000);
5956 // intermediate node failure
5957 run_onion_failure_test("invalid_realm", 0, &nodes, &route, &payment_hash, |msg| {
5958 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5959 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5960 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5961 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height).unwrap();
5962 let mut new_payloads = Vec::new();
5963 for payload in onion_payloads.drain(..) {
5964 new_payloads.push(BogusOnionHopData::new(payload));
5966 // break the first (non-final) hop payload by swapping the realm (0) byte for a byte
5967 // describing a length-1 TLV payload, which is obviously bogus.
5968 new_payloads[0].data[0] = 1;
5969 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
5970 }, ||{}, 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
5972 // final node failure
5973 run_onion_failure_test("invalid_realm", 3, &nodes, &route, &payment_hash, |msg| {
5974 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5975 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5976 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5977 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height).unwrap();
5978 let mut new_payloads = Vec::new();
5979 for payload in onion_payloads.drain(..) {
5980 new_payloads.push(BogusOnionHopData::new(payload));
5982 // break the last-hop payload by swapping the realm (0) byte for a byte describing a
5983 // length-1 TLV payload, which is obviously bogus.
5984 new_payloads[1].data[0] = 1;
5985 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
5986 }, ||{}, false, Some(PERM|22), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
5988 // the following three with run_onion_failure_test_with_fail_intercept() test only the origin node
5989 // receiving simulated fail messages
5990 // intermediate node failure
5991 run_onion_failure_test_with_fail_intercept("temporary_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
5993 msg.amount_msat -= 1;
5995 // and tamper returning error message
5996 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5997 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5998 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], NODE|2, &[0;0]);
5999 }, ||{}, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: false}));
6001 // final node failure
6002 run_onion_failure_test_with_fail_intercept("temporary_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
6003 // and tamper returning error message
6004 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6005 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6006 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], NODE|2, &[0;0]);
6008 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
6009 }, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: false}));
6011 // intermediate node failure
6012 run_onion_failure_test_with_fail_intercept("permanent_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
6013 msg.amount_msat -= 1;
6015 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6016 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6017 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|2, &[0;0]);
6018 }, ||{}, true, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: true}));
6020 // final node failure
6021 run_onion_failure_test_with_fail_intercept("permanent_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
6022 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6023 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6024 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|2, &[0;0]);
6026 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
6027 }, false, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: true}));
6029 // intermediate node failure
6030 run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
6031 msg.amount_msat -= 1;
6033 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6034 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6035 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|3, &[0;0]);
6037 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
6038 }, true, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: true}));
6040 // final node failure
6041 run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
6042 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6043 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6044 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|3, &[0;0]);
6046 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
6047 }, false, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: true}));
6049 run_onion_failure_test("invalid_onion_version", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.version = 1; }, ||{}, true,
6050 Some(BADONION|PERM|4), None);
6052 run_onion_failure_test("invalid_onion_hmac", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.hmac = [3; 32]; }, ||{}, true,
6053 Some(BADONION|PERM|5), None);
6055 run_onion_failure_test("invalid_onion_key", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.public_key = Err(secp256k1::Error::InvalidPublicKey);}, ||{}, true,
6056 Some(BADONION|PERM|6), None);
6058 run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
6059 msg.amount_msat -= 1;
6061 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6062 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6063 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], UPDATE|7, &ChannelUpdate::dummy().encode_with_len()[..]);
6064 }, ||{}, true, Some(UPDATE|7), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
6066 run_onion_failure_test_with_fail_intercept("permanent_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
6067 msg.amount_msat -= 1;
6069 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6070 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6071 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|8, &[0;0]);
6072 // short_channel_id from the processing node
6073 }, ||{}, true, Some(PERM|8), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
6075 run_onion_failure_test_with_fail_intercept("required_channel_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
6076 msg.amount_msat -= 1;
6078 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6079 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6080 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|9, &[0;0]);
6081 // short_channel_id from the processing node
6082 }, ||{}, true, Some(PERM|9), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
6084 let mut bogus_route = route.clone();
6085 bogus_route.paths[0][1].short_channel_id -= 1;
6086 run_onion_failure_test("unknown_next_peer", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(PERM|10),
6087 Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: bogus_route.paths[0][1].short_channel_id, is_permanent:true}));
6089 let amt_to_forward = nodes[1].node.channel_state.lock().unwrap().by_id.get(&channels[1].2).unwrap().get_their_htlc_minimum_msat() - 1;
6090 let mut bogus_route = route.clone();
6091 let route_len = bogus_route.paths[0].len();
6092 bogus_route.paths[0][route_len-1].fee_msat = amt_to_forward;
6093 run_onion_failure_test("amount_below_minimum", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(UPDATE|11), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
6095 //TODO: with new config API, we will be able to generate both valid and
6096 //invalid channel_update cases.
6097 run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, |msg| {
6098 msg.amount_msat -= 1;
6099 }, || {}, true, Some(UPDATE|12), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
6101 run_onion_failure_test("incorrect_cltv_expiry", 0, &nodes, &route, &payment_hash, |msg| {
6102 // need to violate: cltv_expiry - cltv_expiry_delta >= outgoing_cltv_value
6103 msg.cltv_expiry -= 1;
6104 }, || {}, true, Some(UPDATE|13), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
6106 run_onion_failure_test("expiry_too_soon", 0, &nodes, &route, &payment_hash, |msg| {
6107 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
6108 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6110 nodes[1].block_notifier.block_connected_checked(&header, height, &[], &[]);
6111 }, ||{}, true, Some(UPDATE|14), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
6113 run_onion_failure_test("unknown_payment_hash", 2, &nodes, &route, &payment_hash, |_| {}, || {
6114 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
6115 }, false, Some(PERM|15), None);
6117 run_onion_failure_test("final_expiry_too_soon", 1, &nodes, &route, &payment_hash, |msg| {
6118 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
6119 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6121 nodes[2].block_notifier.block_connected_checked(&header, height, &[], &[]);
6122 }, || {}, true, Some(17), None);
6124 run_onion_failure_test("final_incorrect_cltv_expiry", 1, &nodes, &route, &payment_hash, |_| {}, || {
6125 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
6126 for f in pending_forwards.iter_mut() {
6128 &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
6129 forward_info.outgoing_cltv_value += 1,
6134 }, true, Some(18), None);
6136 run_onion_failure_test("final_incorrect_htlc_amount", 1, &nodes, &route, &payment_hash, |_| {}, || {
6137 // violate amt_to_forward > msg.amount_msat
6138 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
6139 for f in pending_forwards.iter_mut() {
6141 &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
6142 forward_info.amt_to_forward -= 1,
6147 }, true, Some(19), None);
6149 run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, |_| {}, || {
6150 // disconnect event to the channel between nodes[1] ~ nodes[2]
6151 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
6152 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6153 }, true, Some(UPDATE|20), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
6154 reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
6156 run_onion_failure_test("expiry_too_far", 0, &nodes, &route, &payment_hash, |msg| {
6157 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6158 let mut route = route.clone();
6160 route.paths[0][1].cltv_expiry_delta += CLTV_FAR_FAR_AWAY + route.paths[0][0].cltv_expiry_delta + 1;
6161 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6162 let (onion_payloads, _, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, height).unwrap();
6163 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
6164 msg.cltv_expiry = htlc_cltv;
6165 msg.onion_routing_packet = onion_packet;
6166 }, ||{}, true, Some(21), None);
6171 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
6172 let chanmon_cfgs = create_chanmon_cfgs(2);
6173 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6174 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6175 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6176 //Force duplicate channel ids
6177 for node in nodes.iter() {
6178 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
6181 // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
6182 let channel_value_satoshis=10000;
6183 let push_msat=10001;
6184 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6185 let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6186 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6188 //Create a second channel with a channel_id collision
6189 assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6193 fn bolt2_open_channel_sending_node_checks_part2() {
6194 let chanmon_cfgs = create_chanmon_cfgs(2);
6195 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6196 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6197 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6199 // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
6200 let channel_value_satoshis=2^24;
6201 let push_msat=10001;
6202 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6204 // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
6205 let channel_value_satoshis=10000;
6206 // Test when push_msat is equal to 1000 * funding_satoshis.
6207 let push_msat=1000*channel_value_satoshis+1;
6208 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6210 // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
6211 let channel_value_satoshis=10000;
6212 let push_msat=10001;
6213 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
6214 let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6215 assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
6217 // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
6218 // 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
6219 assert!(node0_to_1_send_open_channel.channel_flags<=1);
6221 // 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.
6222 assert!(BREAKDOWN_TIMEOUT>0);
6223 assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
6225 // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
6226 let chain_hash=genesis_block(Network::Testnet).header.bitcoin_hash();
6227 assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
6229 // 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.
6230 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
6231 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
6232 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
6233 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
6234 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
6237 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
6238 // 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.
6239 //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.
6242 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
6243 //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
6244 let chanmon_cfgs = create_chanmon_cfgs(2);
6245 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6246 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6247 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6248 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6250 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6251 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6252 let logger = test_utils::TestLogger::new();
6253 let mut route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6254 route.paths[0][0].fee_msat = 100;
6256 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
6257 assert_eq!(err, "Cannot send less than their minimum HTLC value"));
6258 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6259 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
6263 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
6264 //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6265 let chanmon_cfgs = create_chanmon_cfgs(2);
6266 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6267 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6268 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6269 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6270 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6272 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6273 let logger = test_utils::TestLogger::new();
6274 let mut route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6275 route.paths[0][0].fee_msat = 0;
6276 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
6277 assert_eq!(err, "Cannot send 0-msat HTLC"));
6279 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6280 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
6284 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
6285 //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6286 let chanmon_cfgs = create_chanmon_cfgs(2);
6287 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6288 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6289 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6290 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6292 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6293 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6294 let logger = test_utils::TestLogger::new();
6295 let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6296 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6297 check_added_monitors!(nodes[0], 1);
6298 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6299 updates.update_add_htlcs[0].amount_msat = 0;
6301 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6302 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
6303 check_closed_broadcast!(nodes[1], true).unwrap();
6304 check_added_monitors!(nodes[1], 1);
6308 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6309 //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6310 //It is enforced when constructing a route.
6311 let chanmon_cfgs = create_chanmon_cfgs(2);
6312 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6313 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6314 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6315 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 0, InitFeatures::known(), InitFeatures::known());
6316 let logger = test_utils::TestLogger::new();
6318 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6320 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6321 let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[1].node.get_our_node_id(), None, &[], 100000000, 500000001, &logger).unwrap();
6322 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::RouteError { err },
6323 assert_eq!(err, "Channel CLTV overflowed?!"));
6327 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6328 //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.
6329 //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6330 //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
6331 let chanmon_cfgs = create_chanmon_cfgs(2);
6332 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6333 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6334 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6335 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6336 let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().their_max_accepted_htlcs as u64;
6338 let logger = test_utils::TestLogger::new();
6339 for i in 0..max_accepted_htlcs {
6340 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6341 let payment_event = {
6342 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6343 let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6344 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6345 check_added_monitors!(nodes[0], 1);
6347 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6348 assert_eq!(events.len(), 1);
6349 if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6350 assert_eq!(htlcs[0].htlc_id, i);
6354 SendEvent::from_event(events.remove(0))
6356 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6357 check_added_monitors!(nodes[1], 0);
6358 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6360 expect_pending_htlcs_forwardable!(nodes[1]);
6361 expect_payment_received!(nodes[1], our_payment_hash, 100000);
6363 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6364 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6365 let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6366 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
6367 assert_eq!(err, "Cannot push more than their max accepted HTLCs"));
6369 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6370 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
6374 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6375 //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.
6376 let chanmon_cfgs = create_chanmon_cfgs(2);
6377 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6378 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6379 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6380 let channel_value = 100000;
6381 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::known(), InitFeatures::known());
6382 let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).their_max_htlc_value_in_flight_msat;
6384 send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight, max_in_flight);
6386 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6387 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6388 let logger = test_utils::TestLogger::new();
6389 let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[1].node.get_our_node_id(), None, &[], max_in_flight+1, TEST_FINAL_CLTV, &logger).unwrap();
6390 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
6391 assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight our peer will accept"));
6393 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6394 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);
6396 send_payment(&nodes[0], &[&nodes[1]], max_in_flight, max_in_flight);
6399 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6401 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6402 //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
6403 let chanmon_cfgs = create_chanmon_cfgs(2);
6404 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6405 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6406 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6407 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6408 let htlc_minimum_msat: u64;
6410 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
6411 let channel = chan_lock.by_id.get(&chan.2).unwrap();
6412 htlc_minimum_msat = channel.get_our_htlc_minimum_msat();
6415 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6416 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6417 let logger = test_utils::TestLogger::new();
6418 let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[1].node.get_our_node_id(), None, &[], htlc_minimum_msat, TEST_FINAL_CLTV, &logger).unwrap();
6419 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6420 check_added_monitors!(nodes[0], 1);
6421 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6422 updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6423 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6424 assert!(nodes[1].node.list_channels().is_empty());
6425 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6426 assert_eq!(err_msg.data, "Remote side tried to send less than our minimum HTLC value");
6427 check_added_monitors!(nodes[1], 1);
6431 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6432 //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
6433 let chanmon_cfgs = create_chanmon_cfgs(2);
6434 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6435 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6436 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6437 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6438 let logger = test_utils::TestLogger::new();
6440 let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6441 let channel_reserve = chan_stat.channel_reserve_msat;
6442 let feerate = get_feerate!(nodes[0], chan.2);
6443 // The 2* and +1 are for the fee spike reserve.
6444 let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1);
6446 let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6447 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6448 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6449 let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[1].node.get_our_node_id(), None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6450 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6451 check_added_monitors!(nodes[0], 1);
6452 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6454 // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6455 // at this time channel-initiatee receivers are not required to enforce that senders
6456 // respect the fee_spike_reserve.
6457 updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
6458 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6460 assert!(nodes[1].node.list_channels().is_empty());
6461 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6462 assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
6463 check_added_monitors!(nodes[1], 1);
6467 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
6468 //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
6469 //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
6470 let chanmon_cfgs = create_chanmon_cfgs(2);
6471 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6472 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6473 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6474 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6475 let logger = test_utils::TestLogger::new();
6477 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6479 let session_priv = SecretKey::from_slice(&{
6480 let mut session_key = [0; 32];
6481 let mut rng = thread_rng();
6482 rng.fill_bytes(&mut session_key);
6484 }).expect("RNG is bad!");
6486 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6487 let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[1].node.get_our_node_id(), None, &[], 3999999, TEST_FINAL_CLTV, &logger).unwrap();
6489 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
6490 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
6491 let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &None, cur_height).unwrap();
6492 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
6494 let mut msg = msgs::UpdateAddHTLC {
6498 payment_hash: our_payment_hash,
6499 cltv_expiry: htlc_cltv,
6500 onion_routing_packet: onion_packet.clone(),
6503 for i in 0..super::channel::OUR_MAX_HTLCS {
6504 msg.htlc_id = i as u64;
6505 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6507 msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
6508 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6510 assert!(nodes[1].node.list_channels().is_empty());
6511 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6512 assert_eq!(err_msg.data, "Remote tried to push more than our max accepted HTLCs");
6513 check_added_monitors!(nodes[1], 1);
6517 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
6518 //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
6519 let chanmon_cfgs = create_chanmon_cfgs(2);
6520 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6521 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6522 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6523 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6524 let logger = test_utils::TestLogger::new();
6526 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6527 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6528 let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6529 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6530 check_added_monitors!(nodes[0], 1);
6531 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6532 updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).their_max_htlc_value_in_flight_msat + 1;
6533 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6535 assert!(nodes[1].node.list_channels().is_empty());
6536 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6537 assert_eq!(err_msg.data,"Remote HTLC add would put them over our max HTLC value");
6538 check_added_monitors!(nodes[1], 1);
6542 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6543 //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6544 let chanmon_cfgs = create_chanmon_cfgs(2);
6545 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6546 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6547 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6548 let logger = test_utils::TestLogger::new();
6550 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6551 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6552 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6553 let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6554 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6555 check_added_monitors!(nodes[0], 1);
6556 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6557 updates.update_add_htlcs[0].cltv_expiry = 500000000;
6558 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6560 assert!(nodes[1].node.list_channels().is_empty());
6561 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6562 assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6563 check_added_monitors!(nodes[1], 1);
6567 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6568 //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6569 // We test this by first testing that that repeated HTLCs pass commitment signature checks
6570 // after disconnect and that non-sequential htlc_ids result in a channel failure.
6571 let chanmon_cfgs = create_chanmon_cfgs(2);
6572 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6573 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6574 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6575 let logger = test_utils::TestLogger::new();
6577 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6578 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6579 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6580 let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6581 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6582 check_added_monitors!(nodes[0], 1);
6583 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6584 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6586 //Disconnect and Reconnect
6587 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6588 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6589 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6590 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6591 assert_eq!(reestablish_1.len(), 1);
6592 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6593 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6594 assert_eq!(reestablish_2.len(), 1);
6595 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6596 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6597 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6598 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6601 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6602 assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6603 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6604 check_added_monitors!(nodes[1], 1);
6605 let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6607 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6609 assert!(nodes[1].node.list_channels().is_empty());
6610 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6611 assert_eq!(err_msg.data, "Remote skipped HTLC ID");
6612 check_added_monitors!(nodes[1], 1);
6616 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6617 //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.
6619 let chanmon_cfgs = create_chanmon_cfgs(2);
6620 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6621 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6622 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6623 let logger = test_utils::TestLogger::new();
6624 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6625 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6626 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6627 let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6628 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6630 check_added_monitors!(nodes[0], 1);
6631 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6632 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6634 let update_msg = msgs::UpdateFulfillHTLC{
6637 payment_preimage: our_payment_preimage,
6640 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6642 assert!(nodes[0].node.list_channels().is_empty());
6643 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6644 assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
6645 check_added_monitors!(nodes[0], 1);
6649 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6650 //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.
6652 let chanmon_cfgs = create_chanmon_cfgs(2);
6653 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6654 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6655 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6656 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6657 let logger = test_utils::TestLogger::new();
6659 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6660 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6661 let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6662 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6663 check_added_monitors!(nodes[0], 1);
6664 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6665 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6667 let update_msg = msgs::UpdateFailHTLC{
6670 reason: msgs::OnionErrorPacket { data: Vec::new()},
6673 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6675 assert!(nodes[0].node.list_channels().is_empty());
6676 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6677 assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
6678 check_added_monitors!(nodes[0], 1);
6682 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6683 //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.
6685 let chanmon_cfgs = create_chanmon_cfgs(2);
6686 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6687 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6688 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6689 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6690 let logger = test_utils::TestLogger::new();
6692 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6693 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6694 let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6695 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6696 check_added_monitors!(nodes[0], 1);
6697 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6698 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6700 let update_msg = msgs::UpdateFailMalformedHTLC{
6703 sha256_of_onion: [1; 32],
6704 failure_code: 0x8000,
6707 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6709 assert!(nodes[0].node.list_channels().is_empty());
6710 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6711 assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
6712 check_added_monitors!(nodes[0], 1);
6716 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
6717 //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
6719 let chanmon_cfgs = create_chanmon_cfgs(2);
6720 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6721 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6722 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6723 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6725 let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6727 nodes[1].node.claim_funds(our_payment_preimage, &None, 100_000);
6728 check_added_monitors!(nodes[1], 1);
6730 let events = nodes[1].node.get_and_clear_pending_msg_events();
6731 assert_eq!(events.len(), 1);
6732 let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6734 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, .. } } => {
6735 assert!(update_add_htlcs.is_empty());
6736 assert_eq!(update_fulfill_htlcs.len(), 1);
6737 assert!(update_fail_htlcs.is_empty());
6738 assert!(update_fail_malformed_htlcs.is_empty());
6739 assert!(update_fee.is_none());
6740 update_fulfill_htlcs[0].clone()
6742 _ => panic!("Unexpected event"),
6746 update_fulfill_msg.htlc_id = 1;
6748 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6750 assert!(nodes[0].node.list_channels().is_empty());
6751 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6752 assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
6753 check_added_monitors!(nodes[0], 1);
6757 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
6758 //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.
6760 let chanmon_cfgs = create_chanmon_cfgs(2);
6761 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6762 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6763 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6764 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6766 let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6768 nodes[1].node.claim_funds(our_payment_preimage, &None, 100_000);
6769 check_added_monitors!(nodes[1], 1);
6771 let events = nodes[1].node.get_and_clear_pending_msg_events();
6772 assert_eq!(events.len(), 1);
6773 let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6775 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, .. } } => {
6776 assert!(update_add_htlcs.is_empty());
6777 assert_eq!(update_fulfill_htlcs.len(), 1);
6778 assert!(update_fail_htlcs.is_empty());
6779 assert!(update_fail_malformed_htlcs.is_empty());
6780 assert!(update_fee.is_none());
6781 update_fulfill_htlcs[0].clone()
6783 _ => panic!("Unexpected event"),
6787 update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
6789 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6791 assert!(nodes[0].node.list_channels().is_empty());
6792 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6793 assert_eq!(err_msg.data, "Remote tried to fulfill HTLC with an incorrect preimage");
6794 check_added_monitors!(nodes[0], 1);
6798 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
6799 //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.
6801 let chanmon_cfgs = create_chanmon_cfgs(2);
6802 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6803 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6804 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6805 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6806 let logger = test_utils::TestLogger::new();
6808 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6809 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6810 let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6811 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6812 check_added_monitors!(nodes[0], 1);
6814 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6815 updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6817 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6818 check_added_monitors!(nodes[1], 0);
6819 commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
6821 let events = nodes[1].node.get_and_clear_pending_msg_events();
6823 let mut update_msg: msgs::UpdateFailMalformedHTLC = {
6825 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, .. } } => {
6826 assert!(update_add_htlcs.is_empty());
6827 assert!(update_fulfill_htlcs.is_empty());
6828 assert!(update_fail_htlcs.is_empty());
6829 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6830 assert!(update_fee.is_none());
6831 update_fail_malformed_htlcs[0].clone()
6833 _ => panic!("Unexpected event"),
6836 update_msg.failure_code &= !0x8000;
6837 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6839 assert!(nodes[0].node.list_channels().is_empty());
6840 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6841 assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
6842 check_added_monitors!(nodes[0], 1);
6846 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
6847 //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
6848 // * 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.
6850 let chanmon_cfgs = create_chanmon_cfgs(3);
6851 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6852 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6853 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6854 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6855 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6856 let logger = test_utils::TestLogger::new();
6858 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6861 let mut payment_event = {
6862 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6863 let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
6864 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6865 check_added_monitors!(nodes[0], 1);
6866 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6867 assert_eq!(events.len(), 1);
6868 SendEvent::from_event(events.remove(0))
6870 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6871 check_added_monitors!(nodes[1], 0);
6872 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6873 expect_pending_htlcs_forwardable!(nodes[1]);
6874 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
6875 assert_eq!(events_2.len(), 1);
6876 check_added_monitors!(nodes[1], 1);
6877 payment_event = SendEvent::from_event(events_2.remove(0));
6878 assert_eq!(payment_event.msgs.len(), 1);
6881 payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6882 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
6883 check_added_monitors!(nodes[2], 0);
6884 commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
6886 let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
6887 assert_eq!(events_3.len(), 1);
6888 let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
6890 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 } } => {
6891 assert!(update_add_htlcs.is_empty());
6892 assert!(update_fulfill_htlcs.is_empty());
6893 assert!(update_fail_htlcs.is_empty());
6894 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6895 assert!(update_fee.is_none());
6896 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
6898 _ => panic!("Unexpected event"),
6902 nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
6904 check_added_monitors!(nodes[1], 0);
6905 commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
6906 expect_pending_htlcs_forwardable!(nodes[1]);
6907 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
6908 assert_eq!(events_4.len(), 1);
6910 //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
6912 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, .. } } => {
6913 assert!(update_add_htlcs.is_empty());
6914 assert!(update_fulfill_htlcs.is_empty());
6915 assert_eq!(update_fail_htlcs.len(), 1);
6916 assert!(update_fail_malformed_htlcs.is_empty());
6917 assert!(update_fee.is_none());
6919 _ => panic!("Unexpected event"),
6922 check_added_monitors!(nodes[1], 1);
6925 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
6926 // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
6927 // 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
6928 // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
6930 let chanmon_cfgs = create_chanmon_cfgs(2);
6931 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6932 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6933 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6934 let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6936 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6938 // We route 2 dust-HTLCs between A and B
6939 let (_, payment_hash_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6940 let (_, payment_hash_2) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6941 route_payment(&nodes[0], &[&nodes[1]], 1000000);
6943 // Cache one local commitment tx as previous
6944 let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6946 // Fail one HTLC to prune it in the will-be-latest-local commitment tx
6947 assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2, &None));
6948 check_added_monitors!(nodes[1], 0);
6949 expect_pending_htlcs_forwardable!(nodes[1]);
6950 check_added_monitors!(nodes[1], 1);
6952 let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6953 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
6954 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
6955 check_added_monitors!(nodes[0], 1);
6957 // Cache one local commitment tx as lastest
6958 let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6960 let events = nodes[0].node.get_and_clear_pending_msg_events();
6962 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
6963 assert_eq!(node_id, nodes[1].node.get_our_node_id());
6965 _ => panic!("Unexpected event"),
6968 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
6969 assert_eq!(node_id, nodes[1].node.get_our_node_id());
6971 _ => panic!("Unexpected event"),
6974 assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
6975 // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
6976 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6978 if announce_latest {
6979 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_last_commitment_tx[0].clone()]}, 1);
6981 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_prev_commitment_tx[0].clone()]}, 1);
6984 check_closed_broadcast!(nodes[0], false);
6985 check_added_monitors!(nodes[0], 1);
6987 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6988 connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
6989 let events = nodes[0].node.get_and_clear_pending_events();
6990 // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
6991 assert_eq!(events.len(), 2);
6992 let mut first_failed = false;
6993 for event in events {
6995 Event::PaymentFailed { payment_hash, .. } => {
6996 if payment_hash == payment_hash_1 {
6997 assert!(!first_failed);
6998 first_failed = true;
7000 assert_eq!(payment_hash, payment_hash_2);
7003 _ => panic!("Unexpected event"),
7009 fn test_failure_delay_dust_htlc_local_commitment() {
7010 do_test_failure_delay_dust_htlc_local_commitment(true);
7011 do_test_failure_delay_dust_htlc_local_commitment(false);
7015 fn test_no_failure_dust_htlc_local_commitment() {
7016 // Transaction filters for failing back dust htlc based on local commitment txn infos has been
7017 // prone to error, we test here that a dummy transaction don't fail them.
7019 let chanmon_cfgs = create_chanmon_cfgs(2);
7020 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7021 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7022 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7023 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7026 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
7028 let as_dust_limit = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
7029 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
7031 // We route 2 dust-HTLCs between A and B
7032 let (preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7033 let (preimage_2, _) = route_payment(&nodes[1], &[&nodes[0]], as_dust_limit*1000);
7035 // Build a dummy invalid transaction trying to spend a commitment tx
7037 previous_output: BitcoinOutPoint { txid: chan.3.txid(), vout: 0 },
7038 script_sig: Script::new(),
7040 witness: Vec::new(),
7044 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
7048 let dummy_tx = Transaction {
7055 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7056 nodes[0].chan_monitor.simple_monitor.block_connected(&header, 1, &[&dummy_tx], &[1;1]);
7057 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7058 assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
7059 // We broadcast a few more block to check everything is all right
7060 connect_blocks(&nodes[0].block_notifier, 20, 1, true, header.bitcoin_hash());
7061 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7062 assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
7064 claim_payment(&nodes[0], &vec!(&nodes[1])[..], preimage_1, bs_dust_limit*1000);
7065 claim_payment(&nodes[1], &vec!(&nodes[0])[..], preimage_2, as_dust_limit*1000);
7068 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
7069 // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
7070 // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
7071 // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
7072 // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
7073 // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
7074 // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
7076 let chanmon_cfgs = create_chanmon_cfgs(3);
7077 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7078 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7079 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7080 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7082 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
7084 let (_payment_preimage_1, dust_hash) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7085 let (_payment_preimage_2, non_dust_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7087 let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7088 let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
7090 // We revoked bs_commitment_tx
7092 let (payment_preimage_3, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7093 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 1_000_000);
7096 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7097 let mut timeout_tx = Vec::new();
7099 // We fail dust-HTLC 1 by broadcast of local commitment tx
7100 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_commitment_tx[0].clone()]}, 1);
7101 check_closed_broadcast!(nodes[0], false);
7102 check_added_monitors!(nodes[0], 1);
7103 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7104 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
7105 let parent_hash = connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
7106 expect_payment_failed!(nodes[0], dust_hash, true);
7107 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7108 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
7109 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7110 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7111 nodes[0].block_notifier.block_connected(&Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
7112 let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7113 connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
7114 expect_payment_failed!(nodes[0], non_dust_hash, true);
7116 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
7117 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![bs_commitment_tx[0].clone()]}, 1);
7118 check_closed_broadcast!(nodes[0], false);
7119 check_added_monitors!(nodes[0], 1);
7120 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7121 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
7122 let parent_hash = connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
7123 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7125 expect_payment_failed!(nodes[0], dust_hash, true);
7126 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7127 // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
7128 nodes[0].block_notifier.block_connected(&Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
7129 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7130 let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7131 connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
7132 expect_payment_failed!(nodes[0], non_dust_hash, true);
7134 // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
7136 let events = nodes[0].node.get_and_clear_pending_events();
7137 assert_eq!(events.len(), 2);
7140 Event::PaymentFailed { payment_hash, .. } => {
7141 if payment_hash == dust_hash { first = true; }
7142 else { first = false; }
7144 _ => panic!("Unexpected event"),
7147 Event::PaymentFailed { payment_hash, .. } => {
7148 if first { assert_eq!(payment_hash, non_dust_hash); }
7149 else { assert_eq!(payment_hash, dust_hash); }
7151 _ => panic!("Unexpected event"),
7158 fn test_sweep_outbound_htlc_failure_update() {
7159 do_test_sweep_outbound_htlc_failure_update(false, true);
7160 do_test_sweep_outbound_htlc_failure_update(false, false);
7161 do_test_sweep_outbound_htlc_failure_update(true, false);
7165 fn test_upfront_shutdown_script() {
7166 // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
7167 // enforce it at shutdown message
7169 let mut config = UserConfig::default();
7170 config.channel_options.announced_channel = true;
7171 config.peer_channel_config_limits.force_announced_channel_preference = false;
7172 config.channel_options.commit_upfront_shutdown_pubkey = false;
7173 let user_cfgs = [None, Some(config), None];
7174 let chanmon_cfgs = create_chanmon_cfgs(3);
7175 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7176 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7177 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7179 // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
7180 let flags = InitFeatures::known();
7181 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7182 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7183 let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7184 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7185 // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that we disconnect peer
7186 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
7187 assert_eq!(check_closed_broadcast!(nodes[2], true).unwrap().data, "Got shutdown request with a scriptpubkey which did not match their previous scriptpubkey");
7188 check_added_monitors!(nodes[2], 1);
7190 // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
7191 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7192 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7193 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7194 // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
7195 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
7196 let events = nodes[2].node.get_and_clear_pending_msg_events();
7197 assert_eq!(events.len(), 1);
7199 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7200 _ => panic!("Unexpected event"),
7203 // We test that if case of peer non-signaling we don't enforce committed script at channel opening
7204 let flags_no = InitFeatures::known().clear_upfront_shutdown_script();
7205 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
7206 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7207 let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
7208 node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7209 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_1_shutdown);
7210 let events = nodes[1].node.get_and_clear_pending_msg_events();
7211 assert_eq!(events.len(), 1);
7213 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7214 _ => panic!("Unexpected event"),
7217 // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7218 // channel smoothly, opt-out is from channel initiator here
7219 let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
7220 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7221 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7222 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7223 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
7224 let events = nodes[0].node.get_and_clear_pending_msg_events();
7225 assert_eq!(events.len(), 1);
7227 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7228 _ => panic!("Unexpected event"),
7231 //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7232 //// channel smoothly
7233 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
7234 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7235 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7236 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7237 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
7238 let events = nodes[0].node.get_and_clear_pending_msg_events();
7239 assert_eq!(events.len(), 2);
7241 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7242 _ => panic!("Unexpected event"),
7245 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7246 _ => panic!("Unexpected event"),
7251 fn test_user_configurable_csv_delay() {
7252 // We test our channel constructors yield errors when we pass them absurd csv delay
7254 let mut low_our_to_self_config = UserConfig::default();
7255 low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
7256 let mut high_their_to_self_config = UserConfig::default();
7257 high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
7258 let user_cfgs = [Some(high_their_to_self_config.clone()), None];
7259 let chanmon_cfgs = create_chanmon_cfgs(2);
7260 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7261 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
7262 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7264 // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
7265 let keys_manager: Arc<KeysInterface<ChanKeySigner = EnforcingChannelKeys>> = Arc::new(test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet));
7266 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, &low_our_to_self_config) {
7268 APIError::APIMisuseError { err } => { assert_eq!(err, "Configured with an unreasonable our_to_self_delay putting user funds at risks"); },
7269 _ => panic!("Unexpected event"),
7271 } else { assert!(false) }
7273 // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
7274 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7275 let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7276 open_channel.to_self_delay = 200;
7277 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::known(), &open_channel, 0, &low_our_to_self_config) {
7279 ChannelError::Close(err) => { assert_eq!(err, "Configured with an unreasonable our_to_self_delay putting user funds at risks"); },
7280 _ => panic!("Unexpected event"),
7282 } else { assert!(false); }
7284 // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
7285 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7286 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id()));
7287 let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7288 accept_channel.to_self_delay = 200;
7289 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7290 if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
7292 &ErrorAction::SendErrorMessage { ref msg } => {
7293 assert_eq!(msg.data,"They wanted our payments to be delayed by a needlessly long period");
7295 _ => { assert!(false); }
7297 } else { assert!(false); }
7299 // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
7300 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7301 let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7302 open_channel.to_self_delay = 200;
7303 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::known(), &open_channel, 0, &high_their_to_self_config) {
7305 ChannelError::Close(err) => { assert_eq!(err, "They wanted our payments to be delayed by a needlessly long period"); },
7306 _ => panic!("Unexpected event"),
7308 } else { assert!(false); }
7312 fn test_data_loss_protect() {
7313 // We want to be sure that :
7314 // * we don't broadcast our Local Commitment Tx in case of fallen behind
7315 // * we close channel in case of detecting other being fallen behind
7316 // * we are able to claim our own outputs thanks to to_remote being static
7324 let chanmon_cfgs = create_chanmon_cfgs(2);
7325 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7326 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7327 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7329 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7331 // Cache node A state before any channel update
7332 let previous_node_state = nodes[0].node.encode();
7333 let mut previous_chan_monitor_state = test_utils::TestVecWriter(Vec::new());
7334 nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut previous_chan_monitor_state).unwrap();
7336 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
7337 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
7339 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7340 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7342 // Restore node A from previous state
7343 logger = test_utils::TestLogger::with_id(format!("node {}", 0));
7344 let mut chan_monitor = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut ::std::io::Cursor::new(previous_chan_monitor_state.0)).unwrap().1;
7345 chain_monitor = ChainWatchInterfaceUtil::new(Network::Testnet);
7346 tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())};
7347 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
7348 keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
7349 monitor = test_utils::TestChannelMonitor::new(&chain_monitor, &tx_broadcaster, &logger, &fee_estimator);
7351 let mut channel_monitors = HashMap::new();
7352 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chan_monitor);
7353 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut ::std::io::Cursor::new(previous_node_state), ChannelManagerReadArgs {
7354 keys_manager: &keys_manager,
7355 fee_estimator: &fee_estimator,
7358 tx_broadcaster: &tx_broadcaster,
7359 default_config: UserConfig::default(),
7360 channel_monitors: &mut channel_monitors,
7363 nodes[0].node = &node_state_0;
7364 assert!(monitor.add_monitor(OutPoint { txid: chan.3.txid(), index: 0 }, chan_monitor).is_ok());
7365 nodes[0].chan_monitor = &monitor;
7366 nodes[0].chain_monitor = &chain_monitor;
7368 nodes[0].block_notifier = BlockNotifier::new(&nodes[0].chain_monitor);
7369 nodes[0].block_notifier.register_listener(&nodes[0].chan_monitor.simple_monitor);
7370 nodes[0].block_notifier.register_listener(nodes[0].node);
7372 check_added_monitors!(nodes[0], 1);
7374 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7375 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7377 let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7379 // Check we don't broadcast any transactions following learning of per_commitment_point from B
7380 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
7381 check_added_monitors!(nodes[0], 1);
7384 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7385 assert_eq!(node_txn.len(), 0);
7388 let mut reestablish_1 = Vec::with_capacity(1);
7389 for msg in nodes[0].node.get_and_clear_pending_msg_events() {
7390 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
7391 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7392 reestablish_1.push(msg.clone());
7393 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
7394 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
7396 &ErrorAction::SendErrorMessage { ref msg } => {
7397 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");
7399 _ => panic!("Unexpected event!"),
7402 panic!("Unexpected event")
7406 // Check we close channel detecting A is fallen-behind
7407 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7408 assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
7409 check_added_monitors!(nodes[1], 1);
7412 // Check A is able to claim to_remote output
7413 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7414 assert_eq!(node_txn.len(), 1);
7415 check_spends!(node_txn[0], chan.3);
7416 assert_eq!(node_txn[0].output.len(), 2);
7417 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
7418 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()]}, 0);
7419 connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 0, true, header.bitcoin_hash());
7420 let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
7421 assert_eq!(spend_txn.len(), 1);
7422 check_spends!(spend_txn[0], node_txn[0]);
7426 fn test_check_htlc_underpaying() {
7427 // Send payment through A -> B but A is maliciously
7428 // sending a probe payment (i.e less than expected value0
7429 // to B, B should refuse payment.
7431 let chanmon_cfgs = create_chanmon_cfgs(2);
7432 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7433 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7434 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7436 // Create some initial channels
7437 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7439 let (payment_preimage, payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 10_000);
7441 // Node 3 is expecting payment of 100_000 but receive 10_000,
7442 // fail htlc like we didn't know the preimage.
7443 nodes[1].node.claim_funds(payment_preimage, &None, 100_000);
7444 nodes[1].node.process_pending_htlc_forwards();
7446 let events = nodes[1].node.get_and_clear_pending_msg_events();
7447 assert_eq!(events.len(), 1);
7448 let (update_fail_htlc, commitment_signed) = match events[0] {
7449 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 } } => {
7450 assert!(update_add_htlcs.is_empty());
7451 assert!(update_fulfill_htlcs.is_empty());
7452 assert_eq!(update_fail_htlcs.len(), 1);
7453 assert!(update_fail_malformed_htlcs.is_empty());
7454 assert!(update_fee.is_none());
7455 (update_fail_htlcs[0].clone(), commitment_signed)
7457 _ => panic!("Unexpected event"),
7459 check_added_monitors!(nodes[1], 1);
7461 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
7462 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
7464 // 10_000 msat as u64, followed by a height of 99 as u32
7465 let mut expected_failure_data = byte_utils::be64_to_array(10_000).to_vec();
7466 expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(99));
7467 expect_payment_failed!(nodes[0], payment_hash, true, 0x4000|15, &expected_failure_data[..]);
7468 nodes[1].node.get_and_clear_pending_events();
7472 fn test_announce_disable_channels() {
7473 // Create 2 channels between A and B. Disconnect B. Call timer_chan_freshness_every_min and check for generated
7474 // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
7476 let chanmon_cfgs = create_chanmon_cfgs(2);
7477 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7478 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7479 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7481 let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7482 let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7483 let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7486 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7487 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7489 nodes[0].node.timer_chan_freshness_every_min(); // dirty -> stagged
7490 nodes[0].node.timer_chan_freshness_every_min(); // staged -> fresh
7491 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7492 assert_eq!(msg_events.len(), 3);
7493 for e in msg_events {
7495 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7496 let short_id = msg.contents.short_channel_id;
7497 // Check generated channel_update match list in PendingChannelUpdate
7498 if short_id != short_id_1 && short_id != short_id_2 && short_id != short_id_3 {
7499 panic!("Generated ChannelUpdate for wrong chan!");
7502 _ => panic!("Unexpected event"),
7506 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7507 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7508 assert_eq!(reestablish_1.len(), 3);
7509 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7510 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7511 assert_eq!(reestablish_2.len(), 3);
7513 // Reestablish chan_1
7514 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7515 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7516 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7517 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7518 // Reestablish chan_2
7519 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
7520 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7521 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
7522 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7523 // Reestablish chan_3
7524 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
7525 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7526 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
7527 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7529 nodes[0].node.timer_chan_freshness_every_min();
7530 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7534 fn test_bump_penalty_txn_on_revoked_commitment() {
7535 // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
7536 // we're able to claim outputs on revoked commitment transaction before timelocks expiration
7538 let chanmon_cfgs = create_chanmon_cfgs(2);
7539 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7540 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7541 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7543 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7544 let logger = test_utils::TestLogger::new();
7547 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7548 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
7549 let route = get_route(&nodes[1].node.get_our_node_id(), net_graph_msg_handler, &nodes[0].node.get_our_node_id(), None, &Vec::new(), 3000000, 30, &logger).unwrap();
7550 send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
7552 let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
7553 // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7554 assert_eq!(revoked_txn[0].output.len(), 4);
7555 assert_eq!(revoked_txn[0].input.len(), 1);
7556 assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
7557 let revoked_txid = revoked_txn[0].txid();
7559 let mut penalty_sum = 0;
7560 for outp in revoked_txn[0].output.iter() {
7561 if outp.script_pubkey.is_v0_p2wsh() {
7562 penalty_sum += outp.value;
7566 // Connect blocks to change height_timer range to see if we use right soonest_timelock
7567 let header_114 = connect_blocks(&nodes[1].block_notifier, 114, 0, false, Default::default());
7569 // Actually revoke tx by claiming a HTLC
7570 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
7571 let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7572 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_txn[0].clone()] }, 115);
7573 check_added_monitors!(nodes[1], 1);
7575 // One or more justice tx should have been broadcast, check it
7579 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7580 assert_eq!(node_txn.len(), 3); // justice tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout (broadcasted from ChannelManager)
7581 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7582 assert_eq!(node_txn[0].output.len(), 1);
7583 check_spends!(node_txn[0], revoked_txn[0]);
7584 let fee_1 = penalty_sum - node_txn[0].output[0].value;
7585 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
7586 penalty_1 = node_txn[0].txid();
7590 // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
7591 let header = connect_blocks(&nodes[1].block_notifier, 3, 115, true, header.bitcoin_hash());
7592 let mut penalty_2 = penalty_1;
7593 let mut feerate_2 = 0;
7595 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7596 assert_eq!(node_txn.len(), 1);
7597 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7598 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7599 assert_eq!(node_txn[0].output.len(), 1);
7600 check_spends!(node_txn[0], revoked_txn[0]);
7601 penalty_2 = node_txn[0].txid();
7602 // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7603 assert_ne!(penalty_2, penalty_1);
7604 let fee_2 = penalty_sum - node_txn[0].output[0].value;
7605 feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7606 // Verify 25% bump heuristic
7607 assert!(feerate_2 * 100 >= feerate_1 * 125);
7611 assert_ne!(feerate_2, 0);
7613 // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
7614 connect_blocks(&nodes[1].block_notifier, 3, 118, true, header);
7616 let mut feerate_3 = 0;
7618 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7619 assert_eq!(node_txn.len(), 1);
7620 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7621 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7622 assert_eq!(node_txn[0].output.len(), 1);
7623 check_spends!(node_txn[0], revoked_txn[0]);
7624 penalty_3 = node_txn[0].txid();
7625 // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7626 assert_ne!(penalty_3, penalty_2);
7627 let fee_3 = penalty_sum - node_txn[0].output[0].value;
7628 feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
7629 // Verify 25% bump heuristic
7630 assert!(feerate_3 * 100 >= feerate_2 * 125);
7634 assert_ne!(feerate_3, 0);
7636 nodes[1].node.get_and_clear_pending_events();
7637 nodes[1].node.get_and_clear_pending_msg_events();
7641 fn test_bump_penalty_txn_on_revoked_htlcs() {
7642 // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
7643 // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
7645 let chanmon_cfgs = create_chanmon_cfgs(2);
7646 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7647 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7648 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7650 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7651 // Lock HTLC in both directions
7652 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3_000_000).0;
7653 route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7655 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7656 assert_eq!(revoked_local_txn[0].input.len(), 1);
7657 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7659 // Revoke local commitment tx
7660 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
7662 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7663 // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
7664 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
7665 check_closed_broadcast!(nodes[1], false);
7666 check_added_monitors!(nodes[1], 1);
7668 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7669 assert_eq!(revoked_htlc_txn.len(), 4);
7670 if revoked_htlc_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7671 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7672 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7673 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7674 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7675 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7676 } else if revoked_htlc_txn[1].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7677 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7678 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7679 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7680 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7681 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7684 // Broadcast set of revoked txn on A
7685 let header_128 = connect_blocks(&nodes[0].block_notifier, 128, 0, true, header.bitcoin_hash());
7686 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
7688 let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7689 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);
7694 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7695 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
7696 // Verify claim tx are spending revoked HTLC txn
7697 assert_eq!(node_txn[4].input.len(), 2);
7698 assert_eq!(node_txn[4].output.len(), 1);
7699 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7700 first = node_txn[4].txid();
7701 // Store both feerates for later comparison
7702 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[4].output[0].value;
7703 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
7704 penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
7708 // Connect three more block to see if bumped penalty are issued for HTLC txn
7709 let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7710 nodes[0].block_notifier.block_connected(&Block { header: header_130, txdata: penalty_txn }, 130);
7712 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7713 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
7715 check_spends!(node_txn[0], revoked_local_txn[0]);
7716 check_spends!(node_txn[1], revoked_local_txn[0]);
7721 // Few more blocks to confirm penalty txn
7722 let header_135 = connect_blocks(&nodes[0].block_notifier, 5, 130, true, header_130.bitcoin_hash());
7723 assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
7724 let header_144 = connect_blocks(&nodes[0].block_notifier, 9, 135, true, header_135);
7726 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7727 assert_eq!(node_txn.len(), 1);
7729 assert_eq!(node_txn[0].input.len(), 2);
7730 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7731 // Verify bumped tx is different and 25% bump heuristic
7732 assert_ne!(first, node_txn[0].txid());
7733 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[0].output[0].value;
7734 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7735 assert!(feerate_2 * 100 > feerate_1 * 125);
7736 let txn = vec![node_txn[0].clone()];
7740 // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
7741 let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7742 nodes[0].block_notifier.block_connected(&Block { header: header_145, txdata: node_txn }, 145);
7743 connect_blocks(&nodes[0].block_notifier, 20, 145, true, header_145.bitcoin_hash());
7745 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7746 // We verify than no new transaction has been broadcast because previously
7747 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
7748 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
7749 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
7750 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
7751 // up bumped justice generation.
7752 assert_eq!(node_txn.len(), 0);
7755 check_closed_broadcast!(nodes[0], false);
7756 check_added_monitors!(nodes[0], 1);
7760 fn test_bump_penalty_txn_on_remote_commitment() {
7761 // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
7762 // we're able to claim outputs on remote commitment transaction before timelocks expiration
7765 // Provide preimage for one
7766 // Check aggregation
7768 let chanmon_cfgs = create_chanmon_cfgs(2);
7769 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7770 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7771 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7773 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7774 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7775 route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
7777 // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7778 let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
7779 assert_eq!(remote_txn[0].output.len(), 4);
7780 assert_eq!(remote_txn[0].input.len(), 1);
7781 assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
7783 // Claim a HTLC without revocation (provide B monitor with preimage)
7784 nodes[1].node.claim_funds(payment_preimage, &None, 3_000_000);
7785 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7786 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
7787 check_added_monitors!(nodes[1], 2);
7789 // One or more claim tx should have been broadcast, check it
7792 let feerate_timeout;
7793 let feerate_preimage;
7795 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7796 assert_eq!(node_txn.len(), 5); // 2 * claim tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout + local HTLC-success (broadcasted from ChannelManager)
7797 assert_eq!(node_txn[0].input.len(), 1);
7798 assert_eq!(node_txn[1].input.len(), 1);
7799 check_spends!(node_txn[0], remote_txn[0]);
7800 check_spends!(node_txn[1], remote_txn[0]);
7801 check_spends!(node_txn[2], chan.3);
7802 check_spends!(node_txn[3], node_txn[2]);
7803 check_spends!(node_txn[4], node_txn[2]);
7804 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7805 timeout = node_txn[0].txid();
7806 let index = node_txn[0].input[0].previous_output.vout;
7807 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7808 feerate_timeout = fee * 1000 / node_txn[0].get_weight() as u64;
7810 preimage = node_txn[1].txid();
7811 let index = node_txn[1].input[0].previous_output.vout;
7812 let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7813 feerate_preimage = fee * 1000 / node_txn[1].get_weight() as u64;
7815 timeout = node_txn[1].txid();
7816 let index = node_txn[1].input[0].previous_output.vout;
7817 let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7818 feerate_timeout = fee * 1000 / node_txn[1].get_weight() as u64;
7820 preimage = node_txn[0].txid();
7821 let index = node_txn[0].input[0].previous_output.vout;
7822 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7823 feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
7827 assert_ne!(feerate_timeout, 0);
7828 assert_ne!(feerate_preimage, 0);
7830 // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
7831 connect_blocks(&nodes[1].block_notifier, 15, 1, true, header.bitcoin_hash());
7833 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7834 assert_eq!(node_txn.len(), 2);
7835 assert_eq!(node_txn[0].input.len(), 1);
7836 assert_eq!(node_txn[1].input.len(), 1);
7837 check_spends!(node_txn[0], remote_txn[0]);
7838 check_spends!(node_txn[1], remote_txn[0]);
7839 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7840 let index = node_txn[0].input[0].previous_output.vout;
7841 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7842 let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
7843 assert!(new_feerate * 100 > feerate_timeout * 125);
7844 assert_ne!(timeout, node_txn[0].txid());
7846 let index = node_txn[1].input[0].previous_output.vout;
7847 let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7848 let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
7849 assert!(new_feerate * 100 > feerate_preimage * 125);
7850 assert_ne!(preimage, node_txn[1].txid());
7852 let index = node_txn[1].input[0].previous_output.vout;
7853 let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7854 let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
7855 assert!(new_feerate * 100 > feerate_timeout * 125);
7856 assert_ne!(timeout, node_txn[1].txid());
7858 let index = node_txn[0].input[0].previous_output.vout;
7859 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7860 let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
7861 assert!(new_feerate * 100 > feerate_preimage * 125);
7862 assert_ne!(preimage, node_txn[0].txid());
7867 nodes[1].node.get_and_clear_pending_events();
7868 nodes[1].node.get_and_clear_pending_msg_events();
7872 fn test_set_outpoints_partial_claiming() {
7873 // - remote party claim tx, new bump tx
7874 // - disconnect remote claiming tx, new bump
7875 // - disconnect tx, see no tx anymore
7876 let chanmon_cfgs = create_chanmon_cfgs(2);
7877 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7878 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7879 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7881 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7882 let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7883 let payment_preimage_2 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7885 // Remote commitment txn with 4 outputs: to_local, to_remote, 2 outgoing HTLC
7886 let remote_txn = get_local_commitment_txn!(nodes[1], chan.2);
7887 assert_eq!(remote_txn.len(), 3);
7888 assert_eq!(remote_txn[0].output.len(), 4);
7889 assert_eq!(remote_txn[0].input.len(), 1);
7890 assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
7891 check_spends!(remote_txn[1], remote_txn[0]);
7892 check_spends!(remote_txn[2], remote_txn[0]);
7894 // Connect blocks on node A to advance height towards TEST_FINAL_CLTV
7895 let prev_header_100 = connect_blocks(&nodes[1].block_notifier, 100, 0, false, Default::default());
7896 // Provide node A with both preimage
7897 nodes[0].node.claim_funds(payment_preimage_1, &None, 3_000_000);
7898 nodes[0].node.claim_funds(payment_preimage_2, &None, 3_000_000);
7899 check_added_monitors!(nodes[0], 2);
7900 nodes[0].node.get_and_clear_pending_events();
7901 nodes[0].node.get_and_clear_pending_msg_events();
7903 // Connect blocks on node A commitment transaction
7904 let header = BlockHeader { version: 0x20000000, prev_blockhash: prev_header_100, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7905 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 101);
7906 check_closed_broadcast!(nodes[0], false);
7907 check_added_monitors!(nodes[0], 1);
7908 // Verify node A broadcast tx claiming both HTLCs
7910 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7911 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-Success*2
7912 assert_eq!(node_txn.len(), 4);
7913 check_spends!(node_txn[0], remote_txn[0]);
7914 check_spends!(node_txn[1], chan.3);
7915 check_spends!(node_txn[2], node_txn[1]);
7916 check_spends!(node_txn[3], node_txn[1]);
7917 assert_eq!(node_txn[0].input.len(), 2);
7921 // Connect blocks on node B
7922 connect_blocks(&nodes[1].block_notifier, 135, 0, false, Default::default());
7923 check_closed_broadcast!(nodes[1], false);
7924 check_added_monitors!(nodes[1], 1);
7925 // Verify node B broadcast 2 HTLC-timeout txn
7926 let partial_claim_tx = {
7927 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7928 assert_eq!(node_txn.len(), 3);
7929 check_spends!(node_txn[1], node_txn[0]);
7930 check_spends!(node_txn[2], node_txn[0]);
7931 assert_eq!(node_txn[1].input.len(), 1);
7932 assert_eq!(node_txn[2].input.len(), 1);
7936 // Broadcast partial claim on node A, should regenerate a claiming tx with HTLC dropped
7937 let header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7938 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![partial_claim_tx.clone()] }, 102);
7940 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7941 assert_eq!(node_txn.len(), 1);
7942 check_spends!(node_txn[0], remote_txn[0]);
7943 assert_eq!(node_txn[0].input.len(), 1); //dropped HTLC
7946 nodes[0].node.get_and_clear_pending_msg_events();
7948 // Disconnect last block on node A, should regenerate a claiming tx with HTLC dropped
7949 nodes[0].block_notifier.block_disconnected(&header, 102);
7951 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7952 assert_eq!(node_txn.len(), 1);
7953 check_spends!(node_txn[0], remote_txn[0]);
7954 assert_eq!(node_txn[0].input.len(), 2); //resurrected HTLC
7958 //// Disconnect one more block and then reconnect multiple no transaction should be generated
7959 nodes[0].block_notifier.block_disconnected(&header, 101);
7960 connect_blocks(&nodes[1].block_notifier, 15, 101, false, prev_header_100);
7962 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7963 assert_eq!(node_txn.len(), 0);
7969 fn test_counterparty_raa_skip_no_crash() {
7970 // Previously, if our counterparty sent two RAAs in a row without us having provided a
7971 // commitment transaction, we would have happily carried on and provided them the next
7972 // commitment transaction based on one RAA forward. This would probably eventually have led to
7973 // channel closure, but it would not have resulted in funds loss. Still, our
7974 // EnforcingChannelKeys would have paniced as it doesn't like jumps into the future. Here, we
7975 // check simply that the channel is closed in response to such an RAA, but don't check whether
7976 // we decide to punish our counterparty for revoking their funds (as we don't currently
7978 let chanmon_cfgs = create_chanmon_cfgs(2);
7979 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7980 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7981 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7982 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
7984 let commitment_seed = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&channel_id).unwrap().local_keys.commitment_seed().clone();
7985 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
7986 let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
7987 &SecretKey::from_slice(&chan_utils::build_commitment_secret(&commitment_seed, INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
7988 let per_commitment_secret = chan_utils::build_commitment_secret(&commitment_seed, INITIAL_COMMITMENT_NUMBER);
7990 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
7991 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
7992 assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
7993 check_added_monitors!(nodes[1], 1);
7997 fn test_bump_txn_sanitize_tracking_maps() {
7998 // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
7999 // verify we clean then right after expiration of ANTI_REORG_DELAY.
8001 let chanmon_cfgs = create_chanmon_cfgs(2);
8002 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8003 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8004 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8006 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8007 // Lock HTLC in both directions
8008 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8009 route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
8011 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8012 assert_eq!(revoked_local_txn[0].input.len(), 1);
8013 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8015 // Revoke local commitment tx
8016 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 9_000_000);
8018 // Broadcast set of revoked txn on A
8019 let header_128 = connect_blocks(&nodes[0].block_notifier, 128, 0, false, Default::default());
8020 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8022 let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8023 nodes[0].block_notifier.block_connected(&Block { header: header_129, txdata: vec![revoked_local_txn[0].clone()] }, 129);
8024 check_closed_broadcast!(nodes[0], false);
8025 check_added_monitors!(nodes[0], 1);
8027 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8028 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
8029 check_spends!(node_txn[0], revoked_local_txn[0]);
8030 check_spends!(node_txn[1], revoked_local_txn[0]);
8031 check_spends!(node_txn[2], revoked_local_txn[0]);
8032 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
8036 let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8037 nodes[0].block_notifier.block_connected(&Block { header: header_130, txdata: penalty_txn }, 130);
8038 connect_blocks(&nodes[0].block_notifier, 5, 130, false, header_130.bitcoin_hash());
8040 let monitors = nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap();
8041 if let Some(monitor) = monitors.get(&OutPoint { txid: chan.3.txid(), index: 0 }) {
8042 assert!(monitor.onchain_tx_handler.pending_claim_requests.is_empty());
8043 assert!(monitor.onchain_tx_handler.claimable_outpoints.is_empty());
8049 fn test_override_channel_config() {
8050 let chanmon_cfgs = create_chanmon_cfgs(2);
8051 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8052 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8053 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8055 // Node0 initiates a channel to node1 using the override config.
8056 let mut override_config = UserConfig::default();
8057 override_config.own_channel_config.our_to_self_delay = 200;
8059 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
8061 // Assert the channel created by node0 is using the override config.
8062 let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8063 assert_eq!(res.channel_flags, 0);
8064 assert_eq!(res.to_self_delay, 200);
8068 fn test_override_0msat_htlc_minimum() {
8069 let mut zero_config = UserConfig::default();
8070 zero_config.own_channel_config.our_htlc_minimum_msat = 0;
8071 let chanmon_cfgs = create_chanmon_cfgs(2);
8072 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8073 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
8074 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8076 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
8077 let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8078 assert_eq!(res.htlc_minimum_msat, 1);
8080 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &res);
8081 let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8082 assert_eq!(res.htlc_minimum_msat, 1);
8086 fn test_simple_payment_secret() {
8087 // Simple test of sending a payment with a payment_secret present. This does not use any AMP
8088 // features, however.
8089 let chanmon_cfgs = create_chanmon_cfgs(3);
8090 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8091 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8092 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8094 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8095 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
8096 let logger = test_utils::TestLogger::new();
8098 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(&nodes[0]);
8099 let payment_secret = PaymentSecret([0xdb; 32]);
8100 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8101 let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[2].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
8102 send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2]]], 100000, payment_hash, Some(payment_secret.clone()));
8103 // Claiming with all the correct values but the wrong secret should result in nothing...
8104 assert_eq!(nodes[2].node.claim_funds(payment_preimage, &None, 100_000), false);
8105 assert_eq!(nodes[2].node.claim_funds(payment_preimage, &Some(PaymentSecret([42; 32])), 100_000), false);
8106 // ...but with the right secret we should be able to claim all the way back
8107 claim_payment_along_route_with_secret(&nodes[0], &[&[&nodes[1], &nodes[2]]], false, payment_preimage, Some(payment_secret.clone()), 100_000);
8111 fn test_simple_mpp() {
8112 // Simple test of sending a multi-path payment.
8113 let chanmon_cfgs = create_chanmon_cfgs(4);
8114 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8115 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8116 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8118 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8119 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8120 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8121 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8122 let logger = test_utils::TestLogger::new();
8124 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(&nodes[0]);
8125 let payment_secret = PaymentSecret([0xdb; 32]);
8126 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8127 let mut route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes[3].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
8128 let path = route.paths[0].clone();
8129 route.paths.push(path);
8130 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8131 route.paths[0][0].short_channel_id = chan_1_id;
8132 route.paths[0][1].short_channel_id = chan_3_id;
8133 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8134 route.paths[1][0].short_channel_id = chan_2_id;
8135 route.paths[1][1].short_channel_id = chan_4_id;
8136 send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, Some(payment_secret.clone()));
8137 // Claiming with all the correct values but the wrong secret should result in nothing...
8138 assert_eq!(nodes[3].node.claim_funds(payment_preimage, &None, 200_000), false);
8139 assert_eq!(nodes[3].node.claim_funds(payment_preimage, &Some(PaymentSecret([42; 32])), 200_000), false);
8140 // ...but with the right secret we should be able to claim all the way back
8141 claim_payment_along_route_with_secret(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage, Some(payment_secret), 200_000);
8145 fn test_update_err_monitor_lockdown() {
8146 // Our monitor will lock update of local commitment transaction if a broadcastion condition
8147 // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
8148 // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateErr.
8150 // This scenario may happen in a watchtower setup, where watchtower process a block height
8151 // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
8152 // commitment at same time.
8154 let chanmon_cfgs = create_chanmon_cfgs(2);
8155 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8156 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8157 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8159 // Create some initial channel
8160 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8161 let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8163 // Rebalance the network to generate htlc in the two directions
8164 send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000, 10_000_000);
8166 // Route a HTLC from node 0 to node 1 (but don't settle)
8167 let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8169 // Copy SimpleManyChannelMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
8170 let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
8171 let chain_monitor = chaininterface::ChainWatchInterfaceUtil::new(Network::Testnet);
8173 let monitors = nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap();
8174 let monitor = monitors.get(&outpoint).unwrap();
8175 let mut w = test_utils::TestVecWriter(Vec::new());
8176 monitor.write_for_disk(&mut w).unwrap();
8177 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingChannelKeys>)>::read(
8178 &mut ::std::io::Cursor::new(&w.0)).unwrap().1;
8179 assert!(new_monitor == *monitor);
8180 let watchtower = test_utils::TestChannelMonitor::new(&chain_monitor, &chanmon_cfgs[0].tx_broadcaster, &logger, &chanmon_cfgs[0].fee_estimator);
8181 assert!(watchtower.add_monitor(outpoint, new_monitor).is_ok());
8184 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8185 watchtower.simple_monitor.block_connected(&header, 200, &vec![], &vec![]);
8187 // Try to update ChannelMonitor
8188 assert!(nodes[1].node.claim_funds(preimage, &None, 9_000_000));
8189 check_added_monitors!(nodes[1], 1);
8190 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8191 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8192 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8193 if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8194 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8195 if let Err(_) = watchtower.simple_monitor.update_monitor(outpoint, update.clone()) {} else { assert!(false); }
8196 if let Ok(_) = nodes[0].chan_monitor.update_monitor(outpoint, update) {} else { assert!(false); }
8197 } else { assert!(false); }
8198 } else { assert!(false); };
8199 // Our local monitor is in-sync and hasn't processed yet timeout
8200 check_added_monitors!(nodes[0], 1);
8201 let events = nodes[0].node.get_and_clear_pending_events();
8202 assert_eq!(events.len(), 1);