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 /// The node_id of the node at this hop.
50 pub extern "C" fn RouteHop_get_pubkey(this_ptr: &RouteHop) -> crate::c_types::PublicKey {
51 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.pubkey;
52 crate::c_types::PublicKey::from_rust(&(*inner_val))
54 /// The node_id of the node at this hop.
56 pub extern "C" fn RouteHop_set_pubkey(this_ptr: &mut RouteHop, mut val: crate::c_types::PublicKey) {
57 unsafe { &mut *this_ptr.inner }.pubkey = val.into_rust();
59 /// The node_announcement features of the node at this hop. For the last hop, these may be
60 /// amended to match the features present in the invoice this node generated.
62 pub extern "C" fn RouteHop_get_node_features(this_ptr: &RouteHop) -> crate::ln::features::NodeFeatures {
63 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.node_features;
64 crate::ln::features::NodeFeatures { inner: unsafe { ( (&((*inner_val)) as *const _) as *mut _) }, is_owned: false }
66 /// The node_announcement features of the node at this hop. For the last hop, these may be
67 /// amended to match the features present in the invoice this node generated.
69 pub extern "C" fn RouteHop_set_node_features(this_ptr: &mut RouteHop, mut val: crate::ln::features::NodeFeatures) {
70 unsafe { &mut *this_ptr.inner }.node_features = *unsafe { Box::from_raw(val.take_inner()) };
72 /// The channel that should be used from the previous hop to reach this node.
74 pub extern "C" fn RouteHop_get_short_channel_id(this_ptr: &RouteHop) -> u64 {
75 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.short_channel_id;
78 /// The channel that should be used from the previous hop to reach this node.
80 pub extern "C" fn RouteHop_set_short_channel_id(this_ptr: &mut RouteHop, mut val: u64) {
81 unsafe { &mut *this_ptr.inner }.short_channel_id = val;
83 /// The channel_announcement features of the channel that should be used from the previous hop
84 /// to reach this node.
86 pub extern "C" fn RouteHop_get_channel_features(this_ptr: &RouteHop) -> crate::ln::features::ChannelFeatures {
87 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.channel_features;
88 crate::ln::features::ChannelFeatures { inner: unsafe { ( (&((*inner_val)) as *const _) as *mut _) }, is_owned: false }
90 /// The channel_announcement features of the channel that should be used from the previous hop
91 /// to reach this node.
93 pub extern "C" fn RouteHop_set_channel_features(this_ptr: &mut RouteHop, mut val: crate::ln::features::ChannelFeatures) {
94 unsafe { &mut *this_ptr.inner }.channel_features = *unsafe { Box::from_raw(val.take_inner()) };
96 /// The fee taken on this hop. For the last hop, this should be the full value of the payment.
98 pub extern "C" fn RouteHop_get_fee_msat(this_ptr: &RouteHop) -> u64 {
99 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.fee_msat;
102 /// The fee taken on this hop. For the last hop, this should be the full value of the payment.
104 pub extern "C" fn RouteHop_set_fee_msat(this_ptr: &mut RouteHop, mut val: u64) {
105 unsafe { &mut *this_ptr.inner }.fee_msat = val;
107 /// The CLTV delta added for this hop. For the last hop, this should be the full CLTV value
108 /// expected at the destination, in excess of the current block height.
110 pub extern "C" fn RouteHop_get_cltv_expiry_delta(this_ptr: &RouteHop) -> u32 {
111 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.cltv_expiry_delta;
114 /// The CLTV delta added for this hop. For the last hop, this should be the full CLTV value
115 /// expected at the destination, in excess of the current block height.
117 pub extern "C" fn RouteHop_set_cltv_expiry_delta(this_ptr: &mut RouteHop, mut val: u32) {
118 unsafe { &mut *this_ptr.inner }.cltv_expiry_delta = val;
122 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 {
123 RouteHop { inner: Box::into_raw(Box::new(nativeRouteHop {
124 pubkey: pubkey_arg.into_rust(),
125 node_features: *unsafe { Box::from_raw(node_features_arg.take_inner()) },
126 short_channel_id: short_channel_id_arg,
127 channel_features: *unsafe { Box::from_raw(channel_features_arg.take_inner()) },
128 fee_msat: fee_msat_arg,
129 cltv_expiry_delta: cltv_expiry_delta_arg,
130 })), is_owned: true }
132 impl Clone for RouteHop {
133 fn clone(&self) -> Self {
135 inner: if self.inner.is_null() { std::ptr::null_mut() } else {
136 Box::into_raw(Box::new(unsafe { &*self.inner }.clone())) },
142 /// Used only if an object of this type is returned as a trait impl by a method
143 pub(crate) extern "C" fn RouteHop_clone_void(this_ptr: *const c_void) -> *mut c_void {
144 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeRouteHop)).clone() })) as *mut c_void
147 pub extern "C" fn RouteHop_clone(orig: &RouteHop) -> RouteHop {
151 use lightning::routing::router::Route as nativeRouteImport;
152 type nativeRoute = nativeRouteImport;
154 /// A route directs a payment from the sender (us) to the recipient. If the recipient supports MPP,
155 /// it can take multiple paths. Each path is composed of one or more hops through the network.
159 /// Nearly everywhere, inner must be non-null, however in places where
160 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
161 pub inner: *mut nativeRoute,
165 impl Drop for Route {
167 if self.is_owned && !self.inner.is_null() {
168 let _ = unsafe { Box::from_raw(self.inner) };
173 pub extern "C" fn Route_free(this_ptr: Route) { }
175 /// Used only if an object of this type is returned as a trait impl by a method
176 extern "C" fn Route_free_void(this_ptr: *mut c_void) {
177 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeRoute); }
180 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
182 pub(crate) fn take_inner(mut self) -> *mut nativeRoute {
183 assert!(self.is_owned);
184 let ret = self.inner;
185 self.inner = std::ptr::null_mut();
189 /// The list of routes taken for a single (potentially-)multi-part payment. The pubkey of the
190 /// last RouteHop in each path must be the same.
191 /// Each entry represents a list of hops, NOT INCLUDING our own, where the last hop is the
192 /// destination. Thus, this must always be at least length one. While the maximum length of any
193 /// given path is variable, keeping the length of any path to less than 20 should currently
194 /// ensure it is viable.
196 pub extern "C" fn Route_set_paths(this_ptr: &mut Route, mut val: crate::c_types::derived::CVec_CVec_RouteHopZZ) {
197 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 }); };
198 unsafe { &mut *this_ptr.inner }.paths = local_val;
202 pub extern "C" fn Route_new(mut paths_arg: crate::c_types::derived::CVec_CVec_RouteHopZZ) -> Route {
203 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 }); };
204 Route { inner: Box::into_raw(Box::new(nativeRoute {
205 paths: local_paths_arg,
206 })), is_owned: true }
208 impl Clone for Route {
209 fn clone(&self) -> Self {
211 inner: if self.inner.is_null() { std::ptr::null_mut() } else {
212 Box::into_raw(Box::new(unsafe { &*self.inner }.clone())) },
218 /// Used only if an object of this type is returned as a trait impl by a method
219 pub(crate) extern "C" fn Route_clone_void(this_ptr: *const c_void) -> *mut c_void {
220 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeRoute)).clone() })) as *mut c_void
223 pub extern "C" fn Route_clone(orig: &Route) -> Route {
227 pub extern "C" fn Route_write(obj: &Route) -> crate::c_types::derived::CVec_u8Z {
228 crate::c_types::serialize_obj(unsafe { &*unsafe { &*obj }.inner })
231 pub(crate) extern "C" fn Route_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
232 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeRoute) })
235 pub extern "C" fn Route_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_RouteDecodeErrorZ {
236 let res = crate::c_types::deserialize_obj(ser);
237 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 } }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::ln::msgs::DecodeError { inner: Box::into_raw(Box::new(e)), is_owned: true } }).into() };
241 use lightning::routing::router::RouteHint as nativeRouteHintImport;
242 type nativeRouteHint = nativeRouteHintImport;
244 /// A channel descriptor which provides a last-hop route to get_route
247 pub struct RouteHint {
248 /// Nearly everywhere, inner must be non-null, however in places where
249 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
250 pub inner: *mut nativeRouteHint,
254 impl Drop for RouteHint {
256 if self.is_owned && !self.inner.is_null() {
257 let _ = unsafe { Box::from_raw(self.inner) };
262 pub extern "C" fn RouteHint_free(this_ptr: RouteHint) { }
264 /// Used only if an object of this type is returned as a trait impl by a method
265 extern "C" fn RouteHint_free_void(this_ptr: *mut c_void) {
266 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeRouteHint); }
269 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
271 pub(crate) fn take_inner(mut self) -> *mut nativeRouteHint {
272 assert!(self.is_owned);
273 let ret = self.inner;
274 self.inner = std::ptr::null_mut();
278 /// The node_id of the non-target end of the route
280 pub extern "C" fn RouteHint_get_src_node_id(this_ptr: &RouteHint) -> crate::c_types::PublicKey {
281 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.src_node_id;
282 crate::c_types::PublicKey::from_rust(&(*inner_val))
284 /// The node_id of the non-target end of the route
286 pub extern "C" fn RouteHint_set_src_node_id(this_ptr: &mut RouteHint, mut val: crate::c_types::PublicKey) {
287 unsafe { &mut *this_ptr.inner }.src_node_id = val.into_rust();
289 /// The short_channel_id of this channel
291 pub extern "C" fn RouteHint_get_short_channel_id(this_ptr: &RouteHint) -> u64 {
292 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.short_channel_id;
295 /// The short_channel_id of this channel
297 pub extern "C" fn RouteHint_set_short_channel_id(this_ptr: &mut RouteHint, mut val: u64) {
298 unsafe { &mut *this_ptr.inner }.short_channel_id = val;
300 /// The fees which must be paid to use this channel
302 pub extern "C" fn RouteHint_get_fees(this_ptr: &RouteHint) -> crate::routing::network_graph::RoutingFees {
303 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.fees;
304 crate::routing::network_graph::RoutingFees { inner: unsafe { ( (&((*inner_val)) as *const _) as *mut _) }, is_owned: false }
306 /// The fees which must be paid to use this channel
308 pub extern "C" fn RouteHint_set_fees(this_ptr: &mut RouteHint, mut val: crate::routing::network_graph::RoutingFees) {
309 unsafe { &mut *this_ptr.inner }.fees = *unsafe { Box::from_raw(val.take_inner()) };
311 /// The difference in CLTV values between this node and the next node.
313 pub extern "C" fn RouteHint_get_cltv_expiry_delta(this_ptr: &RouteHint) -> u16 {
314 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.cltv_expiry_delta;
317 /// The difference in CLTV values between this node and the next node.
319 pub extern "C" fn RouteHint_set_cltv_expiry_delta(this_ptr: &mut RouteHint, mut val: u16) {
320 unsafe { &mut *this_ptr.inner }.cltv_expiry_delta = val;
322 /// The minimum value, in msat, which must be relayed to the next hop.
324 pub extern "C" fn RouteHint_get_htlc_minimum_msat(this_ptr: &RouteHint) -> u64 {
325 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.htlc_minimum_msat;
328 /// The minimum value, in msat, which must be relayed to the next hop.
330 pub extern "C" fn RouteHint_set_htlc_minimum_msat(this_ptr: &mut RouteHint, mut val: u64) {
331 unsafe { &mut *this_ptr.inner }.htlc_minimum_msat = val;
335 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 {
336 RouteHint { inner: Box::into_raw(Box::new(nativeRouteHint {
337 src_node_id: src_node_id_arg.into_rust(),
338 short_channel_id: short_channel_id_arg,
339 fees: *unsafe { Box::from_raw(fees_arg.take_inner()) },
340 cltv_expiry_delta: cltv_expiry_delta_arg,
341 htlc_minimum_msat: htlc_minimum_msat_arg,
342 })), is_owned: true }
344 impl Clone for RouteHint {
345 fn clone(&self) -> Self {
347 inner: if self.inner.is_null() { std::ptr::null_mut() } else {
348 Box::into_raw(Box::new(unsafe { &*self.inner }.clone())) },
354 /// Used only if an object of this type is returned as a trait impl by a method
355 pub(crate) extern "C" fn RouteHint_clone_void(this_ptr: *const c_void) -> *mut c_void {
356 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeRouteHint)).clone() })) as *mut c_void
359 pub extern "C" fn RouteHint_clone(orig: &RouteHint) -> RouteHint {
362 /// Gets a route from us to the given target node.
364 /// Extra routing hops between known nodes and the target will be used if they are included in
367 /// If some channels aren't announced, it may be useful to fill in a first_hops with the
368 /// results from a local ChannelManager::list_usable_channels() call. If it is filled in, our
369 /// view of our local channels (from net_graph_msg_handler) will be ignored, and only those in first_hops
372 /// Panics if first_hops contains channels without short_channel_ids
373 /// (ChannelManager::list_usable_channels will never include such channels).
375 /// The fees on channels from us to next-hops are ignored (as they are assumed to all be
376 /// equal), however the enabled/disabled bit on such channels as well as the htlc_minimum_msat
377 /// *is* checked as they may change based on the receiving node.
379 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 {
380 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[..]);
381 let mut local_last_hops = Vec::new(); for mut item in last_hops.as_slice().iter() { local_last_hops.push( { unsafe { &*item.inner } }); };
382 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);
383 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 } }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::ln::msgs::LightningError { inner: Box::into_raw(Box::new(e)), is_owned: true } }).into() };