1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! Tests that test ChannelManager behavior with fewer confirmations required than the default and
11 //! other behavior that exists only on private channels or with a semi-trusted counterparty (eg
15 use chain::channelmonitor::ChannelMonitor;
16 use chain::keysinterface::{Recipient, KeysInterface};
17 use ln::channelmanager::{ChannelManager, ChannelManagerReadArgs, MIN_CLTV_EXPIRY_DELTA};
18 use routing::network_graph::RoutingFees;
19 use routing::router::{RouteHint, RouteHintHop};
20 use ln::features::InitFeatures;
22 use ln::msgs::{ChannelMessageHandler, RoutingMessageHandler, OptionalField};
23 use util::enforcing_trait_impls::EnforcingSigner;
24 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider};
25 use util::config::UserConfig;
26 use util::ser::{Writeable, ReadableArgs};
30 use core::default::Default;
32 use ln::functional_test_utils::*;
34 use bitcoin::blockdata::constants::genesis_block;
35 use bitcoin::hash_types::BlockHash;
36 use bitcoin::hashes::Hash;
37 use bitcoin::hashes::sha256d::Hash as Sha256dHash;
38 use bitcoin::network::constants::Network;
39 use bitcoin::secp256k1::Secp256k1;
42 fn test_priv_forwarding_rejection() {
43 // If we have a private channel with outbound liquidity, and
44 // UserConfig::accept_forwards_to_priv_channels is set to false, we should reject any attempts
45 // to forward through that channel.
46 let chanmon_cfgs = create_chanmon_cfgs(3);
47 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
48 let mut no_announce_cfg = test_default_channel_config();
49 no_announce_cfg.accept_forwards_to_priv_channels = false;
50 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, Some(no_announce_cfg), None]);
51 let persister: test_utils::TestPersister;
52 let new_chain_monitor: test_utils::TestChainMonitor;
53 let nodes_1_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
54 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
56 let chan_id_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known()).2;
57 let chan_id_2 = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 2, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known()).0.channel_id;
59 // We should always be able to forward through nodes[1] as long as its out through a public
61 send_payment(&nodes[2], &[&nodes[1], &nodes[0]], 10_000);
63 // ... however, if we send to nodes[2], we will have to pass the private channel from nodes[1]
64 // to nodes[2], which should be rejected:
65 let route_hint = RouteHint(vec![RouteHintHop {
66 src_node_id: nodes[1].node.get_our_node_id(),
67 short_channel_id: nodes[2].node.list_channels()[0].short_channel_id.unwrap(),
68 fees: RoutingFees { base_msat: 1000, proportional_millionths: 0 },
69 cltv_expiry_delta: MIN_CLTV_EXPIRY_DELTA,
70 htlc_minimum_msat: None,
71 htlc_maximum_msat: None,
73 let last_hops = vec![route_hint];
74 let (route, our_payment_hash, our_payment_preimage, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], last_hops, 10_000, TEST_FINAL_CLTV);
76 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
77 check_added_monitors!(nodes[0], 1);
78 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
79 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
80 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false, true);
82 let htlc_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
83 assert!(htlc_fail_updates.update_add_htlcs.is_empty());
84 assert_eq!(htlc_fail_updates.update_fail_htlcs.len(), 1);
85 assert!(htlc_fail_updates.update_fail_malformed_htlcs.is_empty());
86 assert!(htlc_fail_updates.update_fee.is_none());
88 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_fail_updates.update_fail_htlcs[0]);
89 commitment_signed_dance!(nodes[0], nodes[1], htlc_fail_updates.commitment_signed, true, true);
90 expect_payment_failed_with_update!(nodes[0], our_payment_hash, false, nodes[2].node.list_channels()[0].short_channel_id.unwrap(), true);
92 // Now disconnect nodes[1] from its peers and restart with accept_forwards_to_priv_channels set
93 // to true. Sadly there is currently no way to change it at runtime.
95 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
96 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
98 let nodes_1_serialized = nodes[1].node.encode();
99 let mut monitor_a_serialized = test_utils::TestVecWriter(Vec::new());
100 let mut monitor_b_serialized = test_utils::TestVecWriter(Vec::new());
101 get_monitor!(nodes[1], chan_id_1).write(&mut monitor_a_serialized).unwrap();
102 get_monitor!(nodes[1], chan_id_2).write(&mut monitor_b_serialized).unwrap();
104 persister = test_utils::TestPersister::new();
105 let keys_manager = &chanmon_cfgs[1].keys_manager;
106 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[1].chain_source), nodes[1].tx_broadcaster.clone(), nodes[1].logger, node_cfgs[1].fee_estimator, &persister, keys_manager);
107 nodes[1].chain_monitor = &new_chain_monitor;
109 let mut monitor_a_read = &monitor_a_serialized.0[..];
110 let mut monitor_b_read = &monitor_b_serialized.0[..];
111 let (_, mut monitor_a) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut monitor_a_read, keys_manager).unwrap();
112 let (_, mut monitor_b) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut monitor_b_read, keys_manager).unwrap();
113 assert!(monitor_a_read.is_empty());
114 assert!(monitor_b_read.is_empty());
116 no_announce_cfg.accept_forwards_to_priv_channels = true;
118 let mut nodes_1_read = &nodes_1_serialized[..];
119 let (_, nodes_1_deserialized_tmp) = {
120 let mut channel_monitors = HashMap::new();
121 channel_monitors.insert(monitor_a.get_funding_txo().0, &mut monitor_a);
122 channel_monitors.insert(monitor_b.get_funding_txo().0, &mut monitor_b);
123 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_1_read, ChannelManagerReadArgs {
124 default_config: no_announce_cfg,
126 fee_estimator: node_cfgs[1].fee_estimator,
127 chain_monitor: nodes[1].chain_monitor,
128 tx_broadcaster: nodes[1].tx_broadcaster.clone(),
129 logger: nodes[1].logger,
133 assert!(nodes_1_read.is_empty());
134 nodes_1_deserialized = nodes_1_deserialized_tmp;
136 assert!(nodes[1].chain_monitor.watch_channel(monitor_a.get_funding_txo().0, monitor_a).is_ok());
137 assert!(nodes[1].chain_monitor.watch_channel(monitor_b.get_funding_txo().0, monitor_b).is_ok());
138 check_added_monitors!(nodes[1], 2);
139 nodes[1].node = &nodes_1_deserialized;
141 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::known(), remote_network_address: None });
142 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty(), remote_network_address: None });
143 let as_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
144 let bs_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
145 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish);
146 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
147 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
148 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
150 nodes[1].node.peer_connected(&nodes[2].node.get_our_node_id(), &msgs::Init { features: InitFeatures::known(), remote_network_address: None });
151 nodes[2].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty(), remote_network_address: None });
152 let bs_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[2].node.get_our_node_id());
153 let cs_reestablish = get_event_msg!(nodes[2], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
154 nodes[2].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
155 nodes[1].node.handle_channel_reestablish(&nodes[2].node.get_our_node_id(), &cs_reestablish);
156 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[2].node.get_our_node_id());
157 get_event_msg!(nodes[2], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
159 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
160 check_added_monitors!(nodes[0], 1);
161 pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], 10_000, our_payment_hash, our_payment_secret);
162 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], our_payment_preimage);
165 fn do_test_1_conf_open(connect_style: ConnectStyle) {
166 // Previously, if the minium_depth config was set to 1, we'd never send a funding_locked. This
167 // tests that we properly send one in that case.
168 let mut alice_config = UserConfig::default();
169 alice_config.own_channel_config.minimum_depth = 1;
170 alice_config.channel_options.announced_channel = true;
171 alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
172 let mut bob_config = UserConfig::default();
173 bob_config.own_channel_config.minimum_depth = 1;
174 bob_config.channel_options.announced_channel = true;
175 bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
176 let chanmon_cfgs = create_chanmon_cfgs(2);
177 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
178 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(alice_config), Some(bob_config)]);
179 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
180 *nodes[0].connect_style.borrow_mut() = connect_style;
182 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
183 mine_transaction(&nodes[1], &tx);
184 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()));
185 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
187 mine_transaction(&nodes[0], &tx);
188 let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
189 assert_eq!(as_msg_events.len(), 2);
190 let as_funding_locked = if let MessageSendEvent::SendFundingLocked { ref node_id, ref msg } = as_msg_events[0] {
191 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
193 } else { panic!("Unexpected event"); };
194 if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = as_msg_events[1] {
195 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
196 } else { panic!("Unexpected event"); }
198 nodes[1].node.handle_funding_locked(&nodes[0].node.get_our_node_id(), &as_funding_locked);
199 let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
200 assert_eq!(bs_msg_events.len(), 1);
201 if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = bs_msg_events[0] {
202 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
203 } else { panic!("Unexpected event"); }
205 send_payment(&nodes[0], &[&nodes[1]], 100_000);
207 // After 6 confirmations, as required by the spec, we'll send announcement_signatures and
208 // broadcast the channel_announcement (but not before exactly 6 confirmations).
209 connect_blocks(&nodes[0], 4);
210 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
211 connect_blocks(&nodes[0], 1);
212 nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &get_event_msg!(nodes[0], MessageSendEvent::SendAnnouncementSignatures, nodes[1].node.get_our_node_id()));
213 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
215 connect_blocks(&nodes[1], 5);
216 let bs_announce_events = nodes[1].node.get_and_clear_pending_msg_events();
217 assert_eq!(bs_announce_events.len(), 2);
218 let bs_announcement_sigs = if let MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } = bs_announce_events[0] {
219 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
221 } else { panic!("Unexpected event"); };
222 let (bs_announcement, bs_update) = if let MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } = bs_announce_events[1] {
223 (msg.clone(), update_msg.clone())
224 } else { panic!("Unexpected event"); };
226 nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
227 let as_announce_events = nodes[0].node.get_and_clear_pending_msg_events();
228 assert_eq!(as_announce_events.len(), 1);
229 let (announcement, as_update) = if let MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } = as_announce_events[0] {
230 (msg.clone(), update_msg.clone())
231 } else { panic!("Unexpected event"); };
232 assert_eq!(announcement, bs_announcement);
235 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
236 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
237 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
241 fn test_1_conf_open() {
242 do_test_1_conf_open(ConnectStyle::BestBlockFirst);
243 do_test_1_conf_open(ConnectStyle::TransactionsFirst);
244 do_test_1_conf_open(ConnectStyle::FullBlockViaListen);
248 fn test_routed_scid_alias() {
249 // Trivially test sending a payment which is routed through an SCID alias.
250 let chanmon_cfgs = create_chanmon_cfgs(3);
251 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
252 let mut no_announce_cfg = test_default_channel_config();
253 no_announce_cfg.accept_forwards_to_priv_channels = true;
254 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, Some(no_announce_cfg), None]);
255 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
257 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known()).2;
258 let mut as_funding_locked = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 2, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known()).0;
260 let last_hop = nodes[2].node.list_usable_channels();
261 let hop_hints = vec![RouteHint(vec![RouteHintHop {
262 src_node_id: nodes[1].node.get_our_node_id(),
263 short_channel_id: last_hop[0].inbound_scid_alias.unwrap(),
265 base_msat: last_hop[0].counterparty.forwarding_info.as_ref().unwrap().fee_base_msat,
266 proportional_millionths: last_hop[0].counterparty.forwarding_info.as_ref().unwrap().fee_proportional_millionths,
268 cltv_expiry_delta: last_hop[0].counterparty.forwarding_info.as_ref().unwrap().cltv_expiry_delta,
269 htlc_maximum_msat: None,
270 htlc_minimum_msat: None,
272 let (route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], hop_hints, 100_000, 42);
273 assert_eq!(route.paths[0][1].short_channel_id, last_hop[0].inbound_scid_alias.unwrap());
274 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
275 check_added_monitors!(nodes[0], 1);
277 pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], 100_000, payment_hash, payment_secret);
278 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
280 // Now test that if a peer sends us a second funding_locked after the channel is operational we
281 // will use the new alias.
282 as_funding_locked.short_channel_id_alias = Some(0xdeadbeef);
283 nodes[2].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &as_funding_locked);
284 // Note that we always respond to a funding_locked with a channel_update. Not a lot of reason
285 // to bother updating that code, so just drop the message here.
286 get_event_msg!(nodes[2], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
287 let updated_channel_info = nodes[2].node.list_usable_channels();
288 assert_eq!(updated_channel_info.len(), 1);
289 assert_eq!(updated_channel_info[0].inbound_scid_alias.unwrap(), 0xdeadbeef);
290 // Note that because we never send a duplicate funding_locked we can't send a payment through
291 // the 0xdeadbeef SCID alias.
295 fn test_scid_privacy_on_pub_channel() {
296 // Tests rejecting the scid_privacy feature for public channels and that we don't ever try to
298 let chanmon_cfgs = create_chanmon_cfgs(2);
299 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
300 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
301 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
303 let mut scid_privacy_cfg = test_default_channel_config();
304 scid_privacy_cfg.channel_options.announced_channel = true;
305 scid_privacy_cfg.own_channel_config.negotiate_scid_privacy = true;
306 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, Some(scid_privacy_cfg)).unwrap();
307 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
309 assert!(!open_channel.channel_type.as_ref().unwrap().supports_scid_privacy()); // we ignore `negotiate_scid_privacy` on pub channels
310 open_channel.channel_type.as_mut().unwrap().set_scid_privacy_required();
311 assert_eq!(open_channel.channel_flags & 1, 1); // The `announce_channel` bit is set.
313 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
314 let err = get_err_msg!(nodes[1], nodes[0].node.get_our_node_id());
315 assert_eq!(err.data, "SCID Alias/Privacy Channel Type cannot be set on a public channel");
319 fn test_scid_privacy_negotiation() {
320 // Tests of the negotiation of SCID alias and falling back to non-SCID-alias if our
321 // counterparty doesn't support it.
322 let chanmon_cfgs = create_chanmon_cfgs(2);
323 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
324 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
325 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
327 let mut scid_privacy_cfg = test_default_channel_config();
328 scid_privacy_cfg.channel_options.announced_channel = false;
329 scid_privacy_cfg.own_channel_config.negotiate_scid_privacy = true;
330 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, Some(scid_privacy_cfg)).unwrap();
332 let init_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
333 assert!(init_open_channel.channel_type.as_ref().unwrap().supports_scid_privacy());
334 assert!(nodes[0].node.list_channels()[0].channel_type.is_none()); // channel_type is none until counterparty accepts
336 // now simulate nodes[1] responding with an Error message, indicating it doesn't understand
338 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage {
339 channel_id: init_open_channel.temporary_channel_id,
340 data: "Yo, no SCID aliases, no privacy here!".to_string()
342 assert!(nodes[0].node.list_channels()[0].channel_type.is_none()); // channel_type is none until counterparty accepts
344 let second_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
345 assert!(!second_open_channel.channel_type.as_ref().unwrap().supports_scid_privacy());
346 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &second_open_channel);
347 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id()));
349 let events = nodes[0].node.get_and_clear_pending_events();
350 assert_eq!(events.len(), 1);
352 Event::FundingGenerationReady { .. } => {},
353 _ => panic!("Unexpected event"),
356 assert!(!nodes[0].node.list_channels()[0].channel_type.as_ref().unwrap().supports_scid_privacy());
357 assert!(!nodes[1].node.list_channels()[0].channel_type.as_ref().unwrap().supports_scid_privacy());
361 fn test_inbound_scid_privacy() {
362 // Tests accepting channels with the scid_privacy feature and rejecting forwards using the
363 // channel's real SCID as required by the channel feature.
364 let chanmon_cfgs = create_chanmon_cfgs(3);
365 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
366 let mut accept_forward_cfg = test_default_channel_config();
367 accept_forward_cfg.accept_forwards_to_priv_channels = true;
368 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, Some(accept_forward_cfg), None]);
369 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
371 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0, InitFeatures::known(), InitFeatures::known());
373 let mut no_announce_cfg = test_default_channel_config();
374 no_announce_cfg.channel_options.announced_channel = false;
375 no_announce_cfg.own_channel_config.negotiate_scid_privacy = true;
376 nodes[1].node.create_channel(nodes[2].node.get_our_node_id(), 100_000, 10_000, 42, Some(no_announce_cfg)).unwrap();
377 let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[2].node.get_our_node_id());
379 assert!(open_channel.channel_type.as_ref().unwrap().requires_scid_privacy());
381 nodes[2].node.handle_open_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &open_channel);
382 let accept_channel = get_event_msg!(nodes[2], MessageSendEvent::SendAcceptChannel, nodes[1].node.get_our_node_id());
383 nodes[1].node.handle_accept_channel(&nodes[2].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
385 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[1], 100_000, 42);
386 nodes[1].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
387 nodes[2].node.handle_funding_created(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendFundingCreated, nodes[2].node.get_our_node_id()));
388 check_added_monitors!(nodes[2], 1);
390 let cs_funding_signed = get_event_msg!(nodes[2], MessageSendEvent::SendFundingSigned, nodes[1].node.get_our_node_id());
391 nodes[1].node.handle_funding_signed(&nodes[2].node.get_our_node_id(), &cs_funding_signed);
392 check_added_monitors!(nodes[1], 1);
394 let conf_height = core::cmp::max(nodes[1].best_block_info().1 + 1, nodes[2].best_block_info().1 + 1);
395 confirm_transaction_at(&nodes[1], &tx, conf_height);
396 connect_blocks(&nodes[1], CHAN_CONFIRM_DEPTH - 1);
397 confirm_transaction_at(&nodes[2], &tx, conf_height);
398 connect_blocks(&nodes[2], CHAN_CONFIRM_DEPTH - 1);
399 let bs_funding_locked = get_event_msg!(nodes[1], MessageSendEvent::SendFundingLocked, nodes[2].node.get_our_node_id());
400 nodes[1].node.handle_funding_locked(&nodes[2].node.get_our_node_id(), &get_event_msg!(nodes[2], MessageSendEvent::SendFundingLocked, nodes[1].node.get_our_node_id()));
401 let bs_update = get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[2].node.get_our_node_id());
402 nodes[2].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &bs_funding_locked);
403 let cs_update = get_event_msg!(nodes[2], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
405 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &cs_update);
406 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &bs_update);
408 // Now we can pay just fine using the SCID alias nodes[2] gave to nodes[1]...
410 let last_hop = nodes[2].node.list_usable_channels();
411 let mut hop_hints = vec![RouteHint(vec![RouteHintHop {
412 src_node_id: nodes[1].node.get_our_node_id(),
413 short_channel_id: last_hop[0].inbound_scid_alias.unwrap(),
415 base_msat: last_hop[0].counterparty.forwarding_info.as_ref().unwrap().fee_base_msat,
416 proportional_millionths: last_hop[0].counterparty.forwarding_info.as_ref().unwrap().fee_proportional_millionths,
418 cltv_expiry_delta: last_hop[0].counterparty.forwarding_info.as_ref().unwrap().cltv_expiry_delta,
419 htlc_maximum_msat: None,
420 htlc_minimum_msat: None,
422 let (route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], hop_hints.clone(), 100_000, 42);
423 assert_eq!(route.paths[0][1].short_channel_id, last_hop[0].inbound_scid_alias.unwrap());
424 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
425 check_added_monitors!(nodes[0], 1);
427 pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], 100_000, payment_hash, payment_secret);
428 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
430 // ... but if we try to pay using the real SCID, nodes[1] will just tell us they don't know
431 // what channel we're talking about.
432 hop_hints[0].0[0].short_channel_id = last_hop[0].short_channel_id.unwrap();
434 let (route_2, payment_hash_2, _, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[2], hop_hints, 100_000, 42);
435 assert_eq!(route_2.paths[0][1].short_channel_id, last_hop[0].short_channel_id.unwrap());
436 nodes[0].node.send_payment(&route_2, payment_hash_2, &Some(payment_secret_2)).unwrap();
437 check_added_monitors!(nodes[0], 1);
439 let payment_event = SendEvent::from_node(&nodes[0]);
440 assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
441 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
442 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, true, true);
444 nodes[1].logger.assert_log_regex("lightning::ln::channelmanager".to_string(), regex::Regex::new(r"Refusing to forward over real channel SCID as our counterparty requested").unwrap(), 1);
446 let mut updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
447 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
448 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, false);
450 expect_payment_failed_conditions!(nodes[0], payment_hash_2, false,
451 PaymentFailedConditions::new().blamed_scid(last_hop[0].short_channel_id.unwrap())
452 .blamed_chan_closed(true).expected_htlc_error_data(0x4000|10, &[0; 0]));
456 fn test_scid_alias_returned() {
457 // Tests that when we fail an HTLC (in this case due to attempting to forward more than the
458 // channel's available balance) we use the correct (in this case the aliased) SCID in the
459 // channel_update which is returned in the onion to the sender.
460 let chanmon_cfgs = create_chanmon_cfgs(3);
461 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
462 let mut accept_forward_cfg = test_default_channel_config();
463 accept_forward_cfg.accept_forwards_to_priv_channels = true;
464 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, Some(accept_forward_cfg), None]);
465 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
467 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 10_000_000, 0, InitFeatures::known(), InitFeatures::known());
468 create_unannounced_chan_between_nodes_with_value(&nodes, 1, 2, 10_000, 0, InitFeatures::known(), InitFeatures::known());
470 let last_hop = nodes[2].node.list_usable_channels();
471 let mut hop_hints = vec![RouteHint(vec![RouteHintHop {
472 src_node_id: nodes[1].node.get_our_node_id(),
473 short_channel_id: last_hop[0].inbound_scid_alias.unwrap(),
475 base_msat: last_hop[0].counterparty.forwarding_info.as_ref().unwrap().fee_base_msat,
476 proportional_millionths: last_hop[0].counterparty.forwarding_info.as_ref().unwrap().fee_proportional_millionths,
478 cltv_expiry_delta: last_hop[0].counterparty.forwarding_info.as_ref().unwrap().cltv_expiry_delta,
479 htlc_maximum_msat: None,
480 htlc_minimum_msat: None,
482 let (mut route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], hop_hints, 10_000, 42);
483 assert_eq!(route.paths[0][1].short_channel_id, nodes[2].node.list_usable_channels()[0].inbound_scid_alias.unwrap());
485 route.paths[0][1].fee_msat = 10_000_000; // Overshoot the last channel's value
487 // Route the HTLC through to the destination.
488 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
489 check_added_monitors!(nodes[0], 1);
490 let as_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
491 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_updates.update_add_htlcs[0]);
492 commitment_signed_dance!(nodes[1], nodes[0], &as_updates.commitment_signed, false, true);
494 expect_pending_htlcs_forwardable!(nodes[1]);
495 expect_pending_htlcs_forwardable!(nodes[1]);
496 check_added_monitors!(nodes[1], 1);
498 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
499 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
500 commitment_signed_dance!(nodes[0], nodes[1], bs_updates.commitment_signed, false, true);
502 // Build the expected channel update
503 let contents = msgs::UnsignedChannelUpdate {
504 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
505 short_channel_id: last_hop[0].inbound_scid_alias.unwrap(),
508 cltv_expiry_delta: accept_forward_cfg.channel_options.cltv_expiry_delta,
509 htlc_minimum_msat: 1_000,
510 htlc_maximum_msat: OptionalField::Present(1_000_000), // Defaults to 10% of the channel value
511 fee_base_msat: last_hop[0].counterparty.forwarding_info.as_ref().unwrap().fee_base_msat,
512 fee_proportional_millionths: last_hop[0].counterparty.forwarding_info.as_ref().unwrap().fee_proportional_millionths,
513 excess_data: Vec::new(),
515 let msg_hash = Sha256dHash::hash(&contents.encode()[..]);
516 let signature = Secp256k1::new().sign(&hash_to_message!(&msg_hash[..]), &nodes[1].keys_manager.get_node_secret(Recipient::Node).unwrap());
517 let msg = msgs::ChannelUpdate { signature, contents };
519 expect_payment_failed_conditions!(nodes[0], payment_hash, false,
520 PaymentFailedConditions::new().blamed_scid(last_hop[0].inbound_scid_alias.unwrap())
521 .blamed_chan_closed(false).expected_htlc_error_data(0x1000|7, &msg.encode_with_len()));
523 route.paths[0][1].fee_msat = 10_000; // Reset to the correct payment amount
524 route.paths[0][0].fee_msat = 0; // But set fee paid to the middle hop to 0
526 // Route the HTLC through to the destination.
527 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
528 check_added_monitors!(nodes[0], 1);
529 let as_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
530 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_updates.update_add_htlcs[0]);
531 commitment_signed_dance!(nodes[1], nodes[0], &as_updates.commitment_signed, false, true);
533 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
534 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
535 commitment_signed_dance!(nodes[0], nodes[1], bs_updates.commitment_signed, false, true);
537 let mut err_data = Vec::new();
538 err_data.extend_from_slice(&10_000u64.to_be_bytes());
539 err_data.extend_from_slice(&msg.encode_with_len());
540 expect_payment_failed_conditions!(nodes[0], payment_hash, false,
541 PaymentFailedConditions::new().blamed_scid(last_hop[0].inbound_scid_alias.unwrap())
542 .blamed_chan_closed(false).expected_htlc_error_data(0x1000|12, &err_data));