Move private channel and short-conf tests to new module
[rust-lightning] / lightning / src / ln / priv_short_conf_tests.rs
1 // This file is Copyright its original authors, visible in version control
2 // history.
3 //
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
8 // licenses.
9
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
12 //! LSP).
13
14 use chain::Watch;
15 use chain::channelmonitor::ChannelMonitor;
16 use ln::channelmanager::{ChannelManager, ChannelManagerReadArgs, MIN_CLTV_EXPIRY_DELTA};
17 use routing::network_graph::RoutingFees;
18 use routing::router::{RouteHint, RouteHintHop};
19 use ln::features::InitFeatures;
20 use ln::msgs;
21 use ln::msgs::{ChannelMessageHandler, RoutingMessageHandler};
22 use util::enforcing_trait_impls::EnforcingSigner;
23 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider};
24 use util::config::UserConfig;
25 use util::ser::{Writeable, ReadableArgs};
26 use util::test_utils;
27
28 use prelude::*;
29 use core::default::Default;
30
31 use ln::functional_test_utils::*;
32
33 use bitcoin::hash_types::BlockHash;
34
35 #[test]
36 fn test_priv_forwarding_rejection() {
37         // If we have a private channel with outbound liquidity, and
38         // UserConfig::accept_forwards_to_priv_channels is set to false, we should reject any attempts
39         // to forward through that channel.
40         let chanmon_cfgs = create_chanmon_cfgs(3);
41         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
42         let mut no_announce_cfg = test_default_channel_config();
43         no_announce_cfg.accept_forwards_to_priv_channels = false;
44         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, Some(no_announce_cfg), None]);
45         let persister: test_utils::TestPersister;
46         let new_chain_monitor: test_utils::TestChainMonitor;
47         let nodes_1_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
48         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
49
50         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;
51         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;
52
53         // We should always be able to forward through nodes[1] as long as its out through a public
54         // channel:
55         send_payment(&nodes[2], &[&nodes[1], &nodes[0]], 10_000);
56
57         // ... however, if we send to nodes[2], we will have to pass the private channel from nodes[1]
58         // to nodes[2], which should be rejected:
59         let route_hint = RouteHint(vec![RouteHintHop {
60                 src_node_id: nodes[1].node.get_our_node_id(),
61                 short_channel_id: nodes[2].node.list_channels()[0].short_channel_id.unwrap(),
62                 fees: RoutingFees { base_msat: 1000, proportional_millionths: 0 },
63                 cltv_expiry_delta: MIN_CLTV_EXPIRY_DELTA,
64                 htlc_minimum_msat: None,
65                 htlc_maximum_msat: None,
66         }]);
67         let last_hops = vec![route_hint];
68         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);
69
70         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
71         check_added_monitors!(nodes[0], 1);
72         let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
73         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
74         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false, true);
75
76         let htlc_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
77         assert!(htlc_fail_updates.update_add_htlcs.is_empty());
78         assert_eq!(htlc_fail_updates.update_fail_htlcs.len(), 1);
79         assert!(htlc_fail_updates.update_fail_malformed_htlcs.is_empty());
80         assert!(htlc_fail_updates.update_fee.is_none());
81
82         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_fail_updates.update_fail_htlcs[0]);
83         commitment_signed_dance!(nodes[0], nodes[1], htlc_fail_updates.commitment_signed, true, true);
84         expect_payment_failed_with_update!(nodes[0], our_payment_hash, false, nodes[2].node.list_channels()[0].short_channel_id.unwrap(), true);
85
86         // Now disconnect nodes[1] from its peers and restart with accept_forwards_to_priv_channels set
87         // to true. Sadly there is currently no way to change it at runtime.
88
89         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
90         nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
91
92         let nodes_1_serialized = nodes[1].node.encode();
93         let mut monitor_a_serialized = test_utils::TestVecWriter(Vec::new());
94         let mut monitor_b_serialized = test_utils::TestVecWriter(Vec::new());
95         get_monitor!(nodes[1], chan_id_1).write(&mut monitor_a_serialized).unwrap();
96         get_monitor!(nodes[1], chan_id_2).write(&mut monitor_b_serialized).unwrap();
97
98         persister = test_utils::TestPersister::new();
99         let keys_manager = &chanmon_cfgs[1].keys_manager;
100         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);
101         nodes[1].chain_monitor = &new_chain_monitor;
102
103         let mut monitor_a_read = &monitor_a_serialized.0[..];
104         let mut monitor_b_read = &monitor_b_serialized.0[..];
105         let (_, mut monitor_a) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut monitor_a_read, keys_manager).unwrap();
106         let (_, mut monitor_b) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut monitor_b_read, keys_manager).unwrap();
107         assert!(monitor_a_read.is_empty());
108         assert!(monitor_b_read.is_empty());
109
110         no_announce_cfg.accept_forwards_to_priv_channels = true;
111
112         let mut nodes_1_read = &nodes_1_serialized[..];
113         let (_, nodes_1_deserialized_tmp) = {
114                 let mut channel_monitors = HashMap::new();
115                 channel_monitors.insert(monitor_a.get_funding_txo().0, &mut monitor_a);
116                 channel_monitors.insert(monitor_b.get_funding_txo().0, &mut monitor_b);
117                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_1_read, ChannelManagerReadArgs {
118                         default_config: no_announce_cfg,
119                         keys_manager,
120                         fee_estimator: node_cfgs[1].fee_estimator,
121                         chain_monitor: nodes[1].chain_monitor,
122                         tx_broadcaster: nodes[1].tx_broadcaster.clone(),
123                         logger: nodes[1].logger,
124                         channel_monitors,
125                 }).unwrap()
126         };
127         assert!(nodes_1_read.is_empty());
128         nodes_1_deserialized = nodes_1_deserialized_tmp;
129
130         assert!(nodes[1].chain_monitor.watch_channel(monitor_a.get_funding_txo().0, monitor_a).is_ok());
131         assert!(nodes[1].chain_monitor.watch_channel(monitor_b.get_funding_txo().0, monitor_b).is_ok());
132         check_added_monitors!(nodes[1], 2);
133         nodes[1].node = &nodes_1_deserialized;
134
135         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::known() });
136         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
137         let as_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
138         let bs_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
139         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish);
140         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
141         get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
142         get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
143
144         nodes[1].node.peer_connected(&nodes[2].node.get_our_node_id(), &msgs::Init { features: InitFeatures::known() });
145         nodes[2].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
146         let bs_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[2].node.get_our_node_id());
147         let cs_reestablish = get_event_msg!(nodes[2], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
148         nodes[2].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
149         nodes[1].node.handle_channel_reestablish(&nodes[2].node.get_our_node_id(), &cs_reestablish);
150         get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[2].node.get_our_node_id());
151         get_event_msg!(nodes[2], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
152
153         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
154         check_added_monitors!(nodes[0], 1);
155         pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], 10_000, our_payment_hash, our_payment_secret);
156         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], our_payment_preimage);
157 }
158
159 fn do_test_1_conf_open(connect_style: ConnectStyle) {
160         // Previously, if the minium_depth config was set to 1, we'd never send a funding_locked. This
161         // tests that we properly send one in that case.
162         let mut alice_config = UserConfig::default();
163         alice_config.own_channel_config.minimum_depth = 1;
164         alice_config.channel_options.announced_channel = true;
165         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
166         let mut bob_config = UserConfig::default();
167         bob_config.own_channel_config.minimum_depth = 1;
168         bob_config.channel_options.announced_channel = true;
169         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
170         let chanmon_cfgs = create_chanmon_cfgs(2);
171         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
172         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(alice_config), Some(bob_config)]);
173         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
174         *nodes[0].connect_style.borrow_mut() = connect_style;
175
176         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
177         mine_transaction(&nodes[1], &tx);
178         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()));
179         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
180
181         mine_transaction(&nodes[0], &tx);
182         let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
183         assert_eq!(as_msg_events.len(), 2);
184         let as_funding_locked = if let MessageSendEvent::SendFundingLocked { ref node_id, ref msg } = as_msg_events[0] {
185                 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
186                 msg.clone()
187         } else { panic!("Unexpected event"); };
188         if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = as_msg_events[1] {
189                 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
190         } else { panic!("Unexpected event"); }
191
192         nodes[1].node.handle_funding_locked(&nodes[0].node.get_our_node_id(), &as_funding_locked);
193         let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
194         assert_eq!(bs_msg_events.len(), 1);
195         if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = bs_msg_events[0] {
196                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
197         } else { panic!("Unexpected event"); }
198
199         send_payment(&nodes[0], &[&nodes[1]], 100_000);
200
201         // After 6 confirmations, as required by the spec, we'll send announcement_signatures and
202         // broadcast the channel_announcement (but not before exactly 6 confirmations).
203         connect_blocks(&nodes[0], 4);
204         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
205         connect_blocks(&nodes[0], 1);
206         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()));
207         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
208
209         connect_blocks(&nodes[1], 5);
210         let bs_announce_events = nodes[1].node.get_and_clear_pending_msg_events();
211         assert_eq!(bs_announce_events.len(), 2);
212         let bs_announcement_sigs = if let MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } = bs_announce_events[0] {
213                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
214                 msg.clone()
215         } else { panic!("Unexpected event"); };
216         let (bs_announcement, bs_update) = if let MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } = bs_announce_events[1] {
217                 (msg.clone(), update_msg.clone())
218         } else { panic!("Unexpected event"); };
219
220         nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
221         let as_announce_events = nodes[0].node.get_and_clear_pending_msg_events();
222         assert_eq!(as_announce_events.len(), 1);
223         let (announcement, as_update) = if let MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } = as_announce_events[0] {
224                 (msg.clone(), update_msg.clone())
225         } else { panic!("Unexpected event"); };
226         assert_eq!(announcement, bs_announcement);
227
228         for node in nodes {
229                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
230                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
231                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
232         }
233 }
234 #[test]
235 fn test_1_conf_open() {
236         do_test_1_conf_open(ConnectStyle::BestBlockFirst);
237         do_test_1_conf_open(ConnectStyle::TransactionsFirst);
238         do_test_1_conf_open(ConnectStyle::FullBlockViaListen);
239 }