1 //! The top-level routing/network map tracking logic lives here.
3 //! You probably want to create a NetGraphMsgHandler and use that as your RoutingMessageHandler and then
4 //! interrogate it to get routes for your own payments.
7 use bitcoin::hashes::Hash;
11 use lightning::routing::router::RouteHop as nativeRouteHopImport;
12 type nativeRouteHop = nativeRouteHopImport;
18 /// Nearly everywhere, inner must be non-null, however in places where
19 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
20 pub inner: *mut nativeRouteHop,
24 impl Drop for RouteHop {
26 if self.is_owned && !self.inner.is_null() {
27 let _ = unsafe { Box::from_raw(self.inner) };
32 pub extern "C" fn RouteHop_free(this_ptr: RouteHop) { }
34 /// Used only if an object of this type is returned as a trait impl by a method
35 extern "C" fn RouteHop_free_void(this_ptr: *mut c_void) {
36 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeRouteHop); }
39 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
41 pub(crate) fn take_inner(mut self) -> *mut nativeRouteHop {
42 assert!(self.is_owned);
44 self.inner = std::ptr::null_mut();
48 impl Clone for RouteHop {
49 fn clone(&self) -> Self {
51 inner: Box::into_raw(Box::new(unsafe { &*self.inner }.clone())),
57 /// Used only if an object of this type is returned as a trait impl by a method
58 pub(crate) extern "C" fn RouteHop_clone_void(this_ptr: *const c_void) -> *mut c_void {
59 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeRouteHop)).clone() })) as *mut c_void
62 pub extern "C" fn RouteHop_clone(orig: &RouteHop) -> RouteHop {
63 RouteHop { inner: Box::into_raw(Box::new(unsafe { &*orig.inner }.clone())), is_owned: true }
65 /// The node_id of the node at this hop.
67 pub extern "C" fn RouteHop_get_pubkey(this_ptr: &RouteHop) -> crate::c_types::PublicKey {
68 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.pubkey;
69 crate::c_types::PublicKey::from_rust(&(*inner_val))
71 /// The node_id of the node at this hop.
73 pub extern "C" fn RouteHop_set_pubkey(this_ptr: &mut RouteHop, mut val: crate::c_types::PublicKey) {
74 unsafe { &mut *this_ptr.inner }.pubkey = val.into_rust();
76 /// The node_announcement features of the node at this hop. For the last hop, these may be
77 /// amended to match the features present in the invoice this node generated.
79 pub extern "C" fn RouteHop_get_node_features(this_ptr: &RouteHop) -> crate::ln::features::NodeFeatures {
80 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.node_features;
81 crate::ln::features::NodeFeatures { inner: unsafe { ( (&((*inner_val)) as *const _) as *mut _) }, is_owned: false }
83 /// The node_announcement features of the node at this hop. For the last hop, these may be
84 /// amended to match the features present in the invoice this node generated.
86 pub extern "C" fn RouteHop_set_node_features(this_ptr: &mut RouteHop, mut val: crate::ln::features::NodeFeatures) {
87 unsafe { &mut *this_ptr.inner }.node_features = *unsafe { Box::from_raw(val.take_inner()) };
89 /// The channel that should be used from the previous hop to reach this node.
91 pub extern "C" fn RouteHop_get_short_channel_id(this_ptr: &RouteHop) -> u64 {
92 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.short_channel_id;
95 /// The channel that should be used from the previous hop to reach this node.
97 pub extern "C" fn RouteHop_set_short_channel_id(this_ptr: &mut RouteHop, mut val: u64) {
98 unsafe { &mut *this_ptr.inner }.short_channel_id = val;
100 /// The channel_announcement features of the channel that should be used from the previous hop
101 /// to reach this node.
103 pub extern "C" fn RouteHop_get_channel_features(this_ptr: &RouteHop) -> crate::ln::features::ChannelFeatures {
104 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.channel_features;
105 crate::ln::features::ChannelFeatures { inner: unsafe { ( (&((*inner_val)) as *const _) as *mut _) }, is_owned: false }
107 /// The channel_announcement features of the channel that should be used from the previous hop
108 /// to reach this node.
110 pub extern "C" fn RouteHop_set_channel_features(this_ptr: &mut RouteHop, mut val: crate::ln::features::ChannelFeatures) {
111 unsafe { &mut *this_ptr.inner }.channel_features = *unsafe { Box::from_raw(val.take_inner()) };
113 /// The fee taken on this hop. For the last hop, this should be the full value of the payment.
115 pub extern "C" fn RouteHop_get_fee_msat(this_ptr: &RouteHop) -> u64 {
116 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.fee_msat;
119 /// The fee taken on this hop. For the last hop, this should be the full value of the payment.
121 pub extern "C" fn RouteHop_set_fee_msat(this_ptr: &mut RouteHop, mut val: u64) {
122 unsafe { &mut *this_ptr.inner }.fee_msat = val;
124 /// The CLTV delta added for this hop. For the last hop, this should be the full CLTV value
125 /// expected at the destination, in excess of the current block height.
127 pub extern "C" fn RouteHop_get_cltv_expiry_delta(this_ptr: &RouteHop) -> u32 {
128 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.cltv_expiry_delta;
131 /// The CLTV delta added for this hop. For the last hop, this should be the full CLTV value
132 /// expected at the destination, in excess of the current block height.
134 pub extern "C" fn RouteHop_set_cltv_expiry_delta(this_ptr: &mut RouteHop, mut val: u32) {
135 unsafe { &mut *this_ptr.inner }.cltv_expiry_delta = val;
139 pub extern "C" fn RouteHop_new(mut pubkey_arg: crate::c_types::PublicKey, mut node_features_arg: crate::ln::features::NodeFeatures, mut short_channel_id_arg: u64, mut channel_features_arg: crate::ln::features::ChannelFeatures, mut fee_msat_arg: u64, mut cltv_expiry_delta_arg: u32) -> RouteHop {
140 RouteHop { inner: Box::into_raw(Box::new(nativeRouteHop {
141 pubkey: pubkey_arg.into_rust(),
142 node_features: *unsafe { Box::from_raw(node_features_arg.take_inner()) },
143 short_channel_id: short_channel_id_arg,
144 channel_features: *unsafe { Box::from_raw(channel_features_arg.take_inner()) },
145 fee_msat: fee_msat_arg,
146 cltv_expiry_delta: cltv_expiry_delta_arg,
147 })), is_owned: true }
150 use lightning::routing::router::Route as nativeRouteImport;
151 type nativeRoute = nativeRouteImport;
153 /// A route directs a payment from the sender (us) to the recipient. If the recipient supports MPP,
154 /// it can take multiple paths. Each path is composed of one or more hops through the network.
158 /// Nearly everywhere, inner must be non-null, however in places where
159 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
160 pub inner: *mut nativeRoute,
164 impl Drop for Route {
166 if self.is_owned && !self.inner.is_null() {
167 let _ = unsafe { Box::from_raw(self.inner) };
172 pub extern "C" fn Route_free(this_ptr: Route) { }
174 /// Used only if an object of this type is returned as a trait impl by a method
175 extern "C" fn Route_free_void(this_ptr: *mut c_void) {
176 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeRoute); }
179 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
181 pub(crate) fn take_inner(mut self) -> *mut nativeRoute {
182 assert!(self.is_owned);
183 let ret = self.inner;
184 self.inner = std::ptr::null_mut();
188 impl Clone for Route {
189 fn clone(&self) -> Self {
191 inner: Box::into_raw(Box::new(unsafe { &*self.inner }.clone())),
197 /// Used only if an object of this type is returned as a trait impl by a method
198 pub(crate) extern "C" fn Route_clone_void(this_ptr: *const c_void) -> *mut c_void {
199 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeRoute)).clone() })) as *mut c_void
202 pub extern "C" fn Route_clone(orig: &Route) -> Route {
203 Route { inner: Box::into_raw(Box::new(unsafe { &*orig.inner }.clone())), is_owned: true }
205 /// The list of routes taken for a single (potentially-)multi-part payment. The pubkey of the
206 /// last RouteHop in each path must be the same.
207 /// Each entry represents a list of hops, NOT INCLUDING our own, where the last hop is the
208 /// destination. Thus, this must always be at least length one. While the maximum length of any
209 /// given path is variable, keeping the length of any path to less than 20 should currently
210 /// ensure it is viable.
212 pub extern "C" fn Route_set_paths(this_ptr: &mut Route, mut val: crate::c_types::derived::CVec_CVec_RouteHopZZ) {
213 let mut local_val = Vec::new(); for mut item in val.into_rust().drain(..) { local_val.push( { let mut local_val_0 = Vec::new(); for mut item in item.into_rust().drain(..) { local_val_0.push( { *unsafe { Box::from_raw(item.take_inner()) } }); }; local_val_0 }); };
214 unsafe { &mut *this_ptr.inner }.paths = local_val;
218 pub extern "C" fn Route_new(mut paths_arg: crate::c_types::derived::CVec_CVec_RouteHopZZ) -> Route {
219 let mut local_paths_arg = Vec::new(); for mut item in paths_arg.into_rust().drain(..) { local_paths_arg.push( { let mut local_paths_arg_0 = Vec::new(); for mut item in item.into_rust().drain(..) { local_paths_arg_0.push( { *unsafe { Box::from_raw(item.take_inner()) } }); }; local_paths_arg_0 }); };
220 Route { inner: Box::into_raw(Box::new(nativeRoute {
221 paths: local_paths_arg,
222 })), is_owned: true }
225 pub extern "C" fn Route_write(obj: *const Route) -> crate::c_types::derived::CVec_u8Z {
226 crate::c_types::serialize_obj(unsafe { &*unsafe { &*obj }.inner })
229 pub(crate) extern "C" fn Route_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
230 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeRoute) })
233 pub extern "C" fn Route_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_RouteDecodeErrorZ {
234 let res = crate::c_types::deserialize_obj(ser);
235 let mut local_res = match res { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::routing::router::Route { inner: Box::into_raw(Box::new(o)), is_owned: true } }), Err(mut e) => crate::c_types::CResultTempl::err( { crate::ln::msgs::DecodeError { inner: Box::into_raw(Box::new(e)), is_owned: true } }) };
239 use lightning::routing::router::RouteHint as nativeRouteHintImport;
240 type nativeRouteHint = nativeRouteHintImport;
242 /// A channel descriptor which provides a last-hop route to get_route
245 pub struct RouteHint {
246 /// Nearly everywhere, inner must be non-null, however in places where
247 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
248 pub inner: *mut nativeRouteHint,
252 impl Drop for RouteHint {
254 if self.is_owned && !self.inner.is_null() {
255 let _ = unsafe { Box::from_raw(self.inner) };
260 pub extern "C" fn RouteHint_free(this_ptr: RouteHint) { }
262 /// Used only if an object of this type is returned as a trait impl by a method
263 extern "C" fn RouteHint_free_void(this_ptr: *mut c_void) {
264 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeRouteHint); }
267 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
269 pub(crate) fn take_inner(mut self) -> *mut nativeRouteHint {
270 assert!(self.is_owned);
271 let ret = self.inner;
272 self.inner = std::ptr::null_mut();
276 impl Clone for RouteHint {
277 fn clone(&self) -> Self {
279 inner: Box::into_raw(Box::new(unsafe { &*self.inner }.clone())),
285 /// Used only if an object of this type is returned as a trait impl by a method
286 pub(crate) extern "C" fn RouteHint_clone_void(this_ptr: *const c_void) -> *mut c_void {
287 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeRouteHint)).clone() })) as *mut c_void
290 pub extern "C" fn RouteHint_clone(orig: &RouteHint) -> RouteHint {
291 RouteHint { inner: Box::into_raw(Box::new(unsafe { &*orig.inner }.clone())), is_owned: true }
293 /// The node_id of the non-target end of the route
295 pub extern "C" fn RouteHint_get_src_node_id(this_ptr: &RouteHint) -> crate::c_types::PublicKey {
296 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.src_node_id;
297 crate::c_types::PublicKey::from_rust(&(*inner_val))
299 /// The node_id of the non-target end of the route
301 pub extern "C" fn RouteHint_set_src_node_id(this_ptr: &mut RouteHint, mut val: crate::c_types::PublicKey) {
302 unsafe { &mut *this_ptr.inner }.src_node_id = val.into_rust();
304 /// The short_channel_id of this channel
306 pub extern "C" fn RouteHint_get_short_channel_id(this_ptr: &RouteHint) -> u64 {
307 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.short_channel_id;
310 /// The short_channel_id of this channel
312 pub extern "C" fn RouteHint_set_short_channel_id(this_ptr: &mut RouteHint, mut val: u64) {
313 unsafe { &mut *this_ptr.inner }.short_channel_id = val;
315 /// The fees which must be paid to use this channel
317 pub extern "C" fn RouteHint_get_fees(this_ptr: &RouteHint) -> crate::routing::network_graph::RoutingFees {
318 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.fees;
319 crate::routing::network_graph::RoutingFees { inner: unsafe { ( (&((*inner_val)) as *const _) as *mut _) }, is_owned: false }
321 /// The fees which must be paid to use this channel
323 pub extern "C" fn RouteHint_set_fees(this_ptr: &mut RouteHint, mut val: crate::routing::network_graph::RoutingFees) {
324 unsafe { &mut *this_ptr.inner }.fees = *unsafe { Box::from_raw(val.take_inner()) };
326 /// The difference in CLTV values between this node and the next node.
328 pub extern "C" fn RouteHint_get_cltv_expiry_delta(this_ptr: &RouteHint) -> u16 {
329 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.cltv_expiry_delta;
332 /// The difference in CLTV values between this node and the next node.
334 pub extern "C" fn RouteHint_set_cltv_expiry_delta(this_ptr: &mut RouteHint, mut val: u16) {
335 unsafe { &mut *this_ptr.inner }.cltv_expiry_delta = val;
337 /// The minimum value, in msat, which must be relayed to the next hop.
339 pub extern "C" fn RouteHint_get_htlc_minimum_msat(this_ptr: &RouteHint) -> u64 {
340 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.htlc_minimum_msat;
343 /// The minimum value, in msat, which must be relayed to the next hop.
345 pub extern "C" fn RouteHint_set_htlc_minimum_msat(this_ptr: &mut RouteHint, mut val: u64) {
346 unsafe { &mut *this_ptr.inner }.htlc_minimum_msat = val;
350 pub extern "C" fn RouteHint_new(mut src_node_id_arg: crate::c_types::PublicKey, mut short_channel_id_arg: u64, mut fees_arg: crate::routing::network_graph::RoutingFees, mut cltv_expiry_delta_arg: u16, mut htlc_minimum_msat_arg: u64) -> RouteHint {
351 RouteHint { inner: Box::into_raw(Box::new(nativeRouteHint {
352 src_node_id: src_node_id_arg.into_rust(),
353 short_channel_id: short_channel_id_arg,
354 fees: *unsafe { Box::from_raw(fees_arg.take_inner()) },
355 cltv_expiry_delta: cltv_expiry_delta_arg,
356 htlc_minimum_msat: htlc_minimum_msat_arg,
357 })), is_owned: true }
359 /// Gets a route from us to the given target node.
361 /// Extra routing hops between known nodes and the target will be used if they are included in
364 /// If some channels aren't announced, it may be useful to fill in a first_hops with the
365 /// results from a local ChannelManager::list_usable_channels() call. If it is filled in, our
366 /// view of our local channels (from net_graph_msg_handler) will be ignored, and only those in first_hops
369 /// Panics if first_hops contains channels without short_channel_ids
370 /// (ChannelManager::list_usable_channels will never include such channels).
372 /// The fees on channels from us to next-hops are ignored (as they are assumed to all be
373 /// equal), however the enabled/disabled bit on such channels as well as the htlc_minimum_msat
374 /// *is* checked as they may change based on the receiving node.
376 pub extern "C" fn get_route(mut our_node_id: crate::c_types::PublicKey, network: &crate::routing::network_graph::NetworkGraph, mut target: crate::c_types::PublicKey, first_hops: *mut crate::c_types::derived::CVec_ChannelDetailsZ, mut last_hops: crate::c_types::derived::CVec_RouteHintZ, mut final_value_msat: u64, mut final_cltv: u32, mut logger: crate::util::logger::Logger) -> crate::c_types::derived::CResult_RouteLightningErrorZ {
377 let mut local_first_hops_base = if first_hops == std::ptr::null_mut() { None } else { Some( { let mut local_first_hops_0 = Vec::new(); for mut item in unsafe { &mut *first_hops }.as_slice().iter() { local_first_hops_0.push( { unsafe { &*item.inner } }); }; local_first_hops_0 }) }; let mut local_first_hops = local_first_hops_base.as_ref().map(|a| &a[..]);
378 let mut local_last_hops = Vec::new(); for mut item in last_hops.as_slice().iter() { local_last_hops.push( { unsafe { &*item.inner } }); };
379 let mut ret = lightning::routing::router::get_route(&our_node_id.into_rust(), unsafe { &*network.inner }, &target.into_rust(), local_first_hops, &local_last_hops[..], final_value_msat, final_cltv, logger);
380 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::routing::router::Route { inner: Box::into_raw(Box::new(o)), is_owned: true } }), Err(mut e) => crate::c_types::CResultTempl::err( { crate::ln::msgs::LightningError { inner: Box::into_raw(Box::new(e)), is_owned: true } }) };