1 // This file is Copyright its original authors, visible in version control
2 // history and in the source files from which this was generated.
4 // This file is licensed under the license available in the LICENSE or LICENSE.md
5 // file in the root of this repository or, if no such file exists, the same
6 // license as that which applies to the original source files from which this
7 // source was automatically generated.
9 //! The top-level routing/network map tracking logic lives here.
11 //! You probably want to create a P2PGossipSync and use that as your RoutingMessageHandler and then
12 //! interrogate it to get routes for your own payments.
14 use alloc::str::FromStr;
15 use core::ffi::c_void;
16 use core::convert::Infallible;
17 use bitcoin::hashes::Hash;
18 use crate::c_types::*;
19 #[cfg(feature="no-std")]
20 use alloc::{vec::Vec, boxed::Box};
23 use lightning::routing::router::RouteHop as nativeRouteHopImport;
24 pub(crate) type nativeRouteHop = nativeRouteHopImport;
30 /// A pointer to the opaque Rust object.
32 /// Nearly everywhere, inner must be non-null, however in places where
33 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
34 pub inner: *mut nativeRouteHop,
35 /// Indicates that this is the only struct which contains the same pointer.
37 /// Rust functions which take ownership of an object provided via an argument require
38 /// this to be true and invalidate the object pointed to by inner.
42 impl Drop for RouteHop {
44 if self.is_owned && !<*mut nativeRouteHop>::is_null(self.inner) {
45 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
49 /// Frees any resources used by the RouteHop, if is_owned is set and inner is non-NULL.
51 pub extern "C" fn RouteHop_free(this_obj: RouteHop) { }
53 /// Used only if an object of this type is returned as a trait impl by a method
54 pub(crate) extern "C" fn RouteHop_free_void(this_ptr: *mut c_void) {
55 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeRouteHop); }
59 pub(crate) fn get_native_ref(&self) -> &'static nativeRouteHop {
60 unsafe { &*ObjOps::untweak_ptr(self.inner) }
62 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeRouteHop {
63 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
65 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
66 pub(crate) fn take_inner(mut self) -> *mut nativeRouteHop {
67 assert!(self.is_owned);
68 let ret = ObjOps::untweak_ptr(self.inner);
69 self.inner = core::ptr::null_mut();
73 /// The node_id of the node at this hop.
75 pub extern "C" fn RouteHop_get_pubkey(this_ptr: &RouteHop) -> crate::c_types::PublicKey {
76 let mut inner_val = &mut this_ptr.get_native_mut_ref().pubkey;
77 crate::c_types::PublicKey::from_rust(&inner_val)
79 /// The node_id of the node at this hop.
81 pub extern "C" fn RouteHop_set_pubkey(this_ptr: &mut RouteHop, mut val: crate::c_types::PublicKey) {
82 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.pubkey = val.into_rust();
84 /// The node_announcement features of the node at this hop. For the last hop, these may be
85 /// amended to match the features present in the invoice this node generated.
87 pub extern "C" fn RouteHop_get_node_features(this_ptr: &RouteHop) -> crate::lightning::ln::features::NodeFeatures {
88 let mut inner_val = &mut this_ptr.get_native_mut_ref().node_features;
89 crate::lightning::ln::features::NodeFeatures { inner: unsafe { ObjOps::nonnull_ptr_to_inner((inner_val as *const lightning::ln::features::NodeFeatures<>) as *mut _) }, is_owned: false }
91 /// The node_announcement features of the node at this hop. For the last hop, these may be
92 /// amended to match the features present in the invoice this node generated.
94 pub extern "C" fn RouteHop_set_node_features(this_ptr: &mut RouteHop, mut val: crate::lightning::ln::features::NodeFeatures) {
95 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.node_features = *unsafe { Box::from_raw(val.take_inner()) };
97 /// The channel that should be used from the previous hop to reach this node.
99 pub extern "C" fn RouteHop_get_short_channel_id(this_ptr: &RouteHop) -> u64 {
100 let mut inner_val = &mut this_ptr.get_native_mut_ref().short_channel_id;
103 /// The channel that should be used from the previous hop to reach this node.
105 pub extern "C" fn RouteHop_set_short_channel_id(this_ptr: &mut RouteHop, mut val: u64) {
106 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.short_channel_id = val;
108 /// The channel_announcement features of the channel that should be used from the previous hop
109 /// to reach this node.
111 pub extern "C" fn RouteHop_get_channel_features(this_ptr: &RouteHop) -> crate::lightning::ln::features::ChannelFeatures {
112 let mut inner_val = &mut this_ptr.get_native_mut_ref().channel_features;
113 crate::lightning::ln::features::ChannelFeatures { inner: unsafe { ObjOps::nonnull_ptr_to_inner((inner_val as *const lightning::ln::features::ChannelFeatures<>) as *mut _) }, is_owned: false }
115 /// The channel_announcement features of the channel that should be used from the previous hop
116 /// to reach this node.
118 pub extern "C" fn RouteHop_set_channel_features(this_ptr: &mut RouteHop, mut val: crate::lightning::ln::features::ChannelFeatures) {
119 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.channel_features = *unsafe { Box::from_raw(val.take_inner()) };
121 /// The fee taken on this hop (for paying for the use of the *next* channel in the path).
122 /// For the last hop, this should be the full value of the payment (might be more than
123 /// requested if we had to match htlc_minimum_msat).
125 pub extern "C" fn RouteHop_get_fee_msat(this_ptr: &RouteHop) -> u64 {
126 let mut inner_val = &mut this_ptr.get_native_mut_ref().fee_msat;
129 /// The fee taken on this hop (for paying for the use of the *next* channel in the path).
130 /// For the last hop, this should be the full value of the payment (might be more than
131 /// requested if we had to match htlc_minimum_msat).
133 pub extern "C" fn RouteHop_set_fee_msat(this_ptr: &mut RouteHop, mut val: u64) {
134 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.fee_msat = val;
136 /// The CLTV delta added for this hop. For the last hop, this should be the full CLTV value
137 /// expected at the destination, in excess of the current block height.
139 pub extern "C" fn RouteHop_get_cltv_expiry_delta(this_ptr: &RouteHop) -> u32 {
140 let mut inner_val = &mut this_ptr.get_native_mut_ref().cltv_expiry_delta;
143 /// The CLTV delta added for this hop. For the last hop, this should be the full CLTV value
144 /// expected at the destination, in excess of the current block height.
146 pub extern "C" fn RouteHop_set_cltv_expiry_delta(this_ptr: &mut RouteHop, mut val: u32) {
147 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.cltv_expiry_delta = val;
149 /// Constructs a new RouteHop given each field
152 pub extern "C" fn RouteHop_new(mut pubkey_arg: crate::c_types::PublicKey, mut node_features_arg: crate::lightning::ln::features::NodeFeatures, mut short_channel_id_arg: u64, mut channel_features_arg: crate::lightning::ln::features::ChannelFeatures, mut fee_msat_arg: u64, mut cltv_expiry_delta_arg: u32) -> RouteHop {
153 RouteHop { inner: ObjOps::heap_alloc(nativeRouteHop {
154 pubkey: pubkey_arg.into_rust(),
155 node_features: *unsafe { Box::from_raw(node_features_arg.take_inner()) },
156 short_channel_id: short_channel_id_arg,
157 channel_features: *unsafe { Box::from_raw(channel_features_arg.take_inner()) },
158 fee_msat: fee_msat_arg,
159 cltv_expiry_delta: cltv_expiry_delta_arg,
162 impl Clone for RouteHop {
163 fn clone(&self) -> Self {
165 inner: if <*mut nativeRouteHop>::is_null(self.inner) { core::ptr::null_mut() } else {
166 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
172 /// Used only if an object of this type is returned as a trait impl by a method
173 pub(crate) extern "C" fn RouteHop_clone_void(this_ptr: *const c_void) -> *mut c_void {
174 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeRouteHop)).clone() })) as *mut c_void
177 /// Creates a copy of the RouteHop
178 pub extern "C" fn RouteHop_clone(orig: &RouteHop) -> RouteHop {
181 /// Checks if two RouteHops contain equal inner contents.
183 pub extern "C" fn RouteHop_hash(o: &RouteHop) -> u64 {
184 if o.inner.is_null() { return 0; }
185 // Note that we'd love to use alloc::collections::hash_map::DefaultHasher but it's not in core
187 let mut hasher = core::hash::SipHasher::new();
188 core::hash::Hash::hash(o.get_native_ref(), &mut hasher);
189 core::hash::Hasher::finish(&hasher)
191 /// Checks if two RouteHops contain equal inner contents.
192 /// This ignores pointers and is_owned flags and looks at the values in fields.
193 /// Two objects with NULL inner values will be considered "equal" here.
195 pub extern "C" fn RouteHop_eq(a: &RouteHop, b: &RouteHop) -> bool {
196 if a.inner == b.inner { return true; }
197 if a.inner.is_null() || b.inner.is_null() { return false; }
198 if a.get_native_ref() == b.get_native_ref() { true } else { false }
201 /// Serialize the RouteHop object into a byte array which can be read by RouteHop_read
202 pub extern "C" fn RouteHop_write(obj: &crate::lightning::routing::router::RouteHop) -> crate::c_types::derived::CVec_u8Z {
203 crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
206 pub(crate) extern "C" fn RouteHop_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
207 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeRouteHop) })
210 /// Read a RouteHop from a byte array, created by RouteHop_write
211 pub extern "C" fn RouteHop_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_RouteHopDecodeErrorZ {
212 let res: Result<lightning::routing::router::RouteHop, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj(ser);
213 let mut local_res = match res { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::lightning::routing::router::RouteHop { inner: ObjOps::heap_alloc(o), is_owned: true } }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::ln::msgs::DecodeError::native_into(e) }).into() };
217 use lightning::routing::router::Route as nativeRouteImport;
218 pub(crate) type nativeRoute = nativeRouteImport;
220 /// A route directs a payment from the sender (us) to the recipient. If the recipient supports MPP,
221 /// it can take multiple paths. Each path is composed of one or more hops through the network.
225 /// A pointer to the opaque Rust object.
227 /// Nearly everywhere, inner must be non-null, however in places where
228 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
229 pub inner: *mut nativeRoute,
230 /// Indicates that this is the only struct which contains the same pointer.
232 /// Rust functions which take ownership of an object provided via an argument require
233 /// this to be true and invalidate the object pointed to by inner.
237 impl Drop for Route {
239 if self.is_owned && !<*mut nativeRoute>::is_null(self.inner) {
240 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
244 /// Frees any resources used by the Route, if is_owned is set and inner is non-NULL.
246 pub extern "C" fn Route_free(this_obj: Route) { }
248 /// Used only if an object of this type is returned as a trait impl by a method
249 pub(crate) extern "C" fn Route_free_void(this_ptr: *mut c_void) {
250 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeRoute); }
254 pub(crate) fn get_native_ref(&self) -> &'static nativeRoute {
255 unsafe { &*ObjOps::untweak_ptr(self.inner) }
257 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeRoute {
258 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
260 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
261 pub(crate) fn take_inner(mut self) -> *mut nativeRoute {
262 assert!(self.is_owned);
263 let ret = ObjOps::untweak_ptr(self.inner);
264 self.inner = core::ptr::null_mut();
268 /// The list of routes taken for a single (potentially-)multi-part payment. The pubkey of the
269 /// last RouteHop in each path must be the same. Each entry represents a list of hops, NOT
270 /// INCLUDING our own, where the last hop is the destination. Thus, this must always be at
271 /// least length one. While the maximum length of any given path is variable, keeping the length
272 /// of any path less or equal to 19 should currently ensure it is viable.
274 pub extern "C" fn Route_get_paths(this_ptr: &Route) -> crate::c_types::derived::CVec_CVec_RouteHopZZ {
275 let mut inner_val = &mut this_ptr.get_native_mut_ref().paths;
276 let mut local_inner_val = Vec::new(); for item in inner_val.iter() { local_inner_val.push( { let mut local_inner_val_0 = Vec::new(); for item in item.iter() { local_inner_val_0.push( { crate::lightning::routing::router::RouteHop { inner: unsafe { ObjOps::nonnull_ptr_to_inner((item as *const lightning::routing::router::RouteHop<>) as *mut _) }, is_owned: false } }); }; local_inner_val_0.into() }); };
277 local_inner_val.into()
279 /// The list of routes taken for a single (potentially-)multi-part payment. The pubkey of the
280 /// last RouteHop in each path must be the same. Each entry represents a list of hops, NOT
281 /// INCLUDING our own, where the last hop is the destination. Thus, this must always be at
282 /// least length one. While the maximum length of any given path is variable, keeping the length
283 /// of any path less or equal to 19 should currently ensure it is viable.
285 pub extern "C" fn Route_set_paths(this_ptr: &mut Route, mut val: crate::c_types::derived::CVec_CVec_RouteHopZZ) {
286 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 }); };
287 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.paths = local_val;
289 /// The `payment_params` parameter passed to [`find_route`].
290 /// This is used by `ChannelManager` to track information which may be required for retries,
291 /// provided back to you via [`Event::PaymentPathFailed`].
293 /// [`Event::PaymentPathFailed`]: crate::util::events::Event::PaymentPathFailed
295 /// Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
297 pub extern "C" fn Route_get_payment_params(this_ptr: &Route) -> crate::lightning::routing::router::PaymentParameters {
298 let mut inner_val = &mut this_ptr.get_native_mut_ref().payment_params;
299 let mut local_inner_val = crate::lightning::routing::router::PaymentParameters { inner: unsafe { (if inner_val.is_none() { core::ptr::null() } else { ObjOps::nonnull_ptr_to_inner( { (inner_val.as_ref().unwrap()) }) } as *const lightning::routing::router::PaymentParameters<>) as *mut _ }, is_owned: false };
302 /// The `payment_params` parameter passed to [`find_route`].
303 /// This is used by `ChannelManager` to track information which may be required for retries,
304 /// provided back to you via [`Event::PaymentPathFailed`].
306 /// [`Event::PaymentPathFailed`]: crate::util::events::Event::PaymentPathFailed
308 /// Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
310 pub extern "C" fn Route_set_payment_params(this_ptr: &mut Route, mut val: crate::lightning::routing::router::PaymentParameters) {
311 let mut local_val = if val.inner.is_null() { None } else { Some( { *unsafe { Box::from_raw(val.take_inner()) } }) };
312 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.payment_params = local_val;
314 /// Constructs a new Route given each field
317 pub extern "C" fn Route_new(mut paths_arg: crate::c_types::derived::CVec_CVec_RouteHopZZ, mut payment_params_arg: crate::lightning::routing::router::PaymentParameters) -> Route {
318 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 }); };
319 let mut local_payment_params_arg = if payment_params_arg.inner.is_null() { None } else { Some( { *unsafe { Box::from_raw(payment_params_arg.take_inner()) } }) };
320 Route { inner: ObjOps::heap_alloc(nativeRoute {
321 paths: local_paths_arg,
322 payment_params: local_payment_params_arg,
325 impl Clone for Route {
326 fn clone(&self) -> Self {
328 inner: if <*mut nativeRoute>::is_null(self.inner) { core::ptr::null_mut() } else {
329 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
335 /// Used only if an object of this type is returned as a trait impl by a method
336 pub(crate) extern "C" fn Route_clone_void(this_ptr: *const c_void) -> *mut c_void {
337 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeRoute)).clone() })) as *mut c_void
340 /// Creates a copy of the Route
341 pub extern "C" fn Route_clone(orig: &Route) -> Route {
344 /// Checks if two Routes contain equal inner contents.
346 pub extern "C" fn Route_hash(o: &Route) -> u64 {
347 if o.inner.is_null() { return 0; }
348 // Note that we'd love to use alloc::collections::hash_map::DefaultHasher but it's not in core
350 let mut hasher = core::hash::SipHasher::new();
351 core::hash::Hash::hash(o.get_native_ref(), &mut hasher);
352 core::hash::Hasher::finish(&hasher)
354 /// Checks if two Routes contain equal inner contents.
355 /// This ignores pointers and is_owned flags and looks at the values in fields.
356 /// Two objects with NULL inner values will be considered "equal" here.
358 pub extern "C" fn Route_eq(a: &Route, b: &Route) -> bool {
359 if a.inner == b.inner { return true; }
360 if a.inner.is_null() || b.inner.is_null() { return false; }
361 if a.get_native_ref() == b.get_native_ref() { true } else { false }
363 /// Returns the total amount of fees paid on this [`Route`].
365 /// This doesn't include any extra payment made to the recipient, which can happen in excess of
366 /// the amount passed to [`find_route`]'s `params.final_value_msat`.
369 pub extern "C" fn Route_get_total_fees(this_arg: &crate::lightning::routing::router::Route) -> u64 {
370 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.get_total_fees();
374 /// Returns the total amount paid on this [`Route`], excluding the fees.
377 pub extern "C" fn Route_get_total_amount(this_arg: &crate::lightning::routing::router::Route) -> u64 {
378 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.get_total_amount();
383 /// Serialize the Route object into a byte array which can be read by Route_read
384 pub extern "C" fn Route_write(obj: &crate::lightning::routing::router::Route) -> crate::c_types::derived::CVec_u8Z {
385 crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
388 pub(crate) extern "C" fn Route_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
389 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeRoute) })
392 /// Read a Route from a byte array, created by Route_write
393 pub extern "C" fn Route_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_RouteDecodeErrorZ {
394 let res: Result<lightning::routing::router::Route, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj(ser);
395 let mut local_res = match res { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::lightning::routing::router::Route { inner: ObjOps::heap_alloc(o), is_owned: true } }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::ln::msgs::DecodeError::native_into(e) }).into() };
399 use lightning::routing::router::RouteParameters as nativeRouteParametersImport;
400 pub(crate) type nativeRouteParameters = nativeRouteParametersImport;
402 /// Parameters needed to find a [`Route`].
404 /// Passed to [`find_route`] and [`build_route_from_hops`], but also provided in
405 /// [`Event::PaymentPathFailed`] for retrying a failed payment path.
407 /// [`Event::PaymentPathFailed`]: crate::util::events::Event::PaymentPathFailed
410 pub struct RouteParameters {
411 /// A pointer to the opaque Rust object.
413 /// Nearly everywhere, inner must be non-null, however in places where
414 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
415 pub inner: *mut nativeRouteParameters,
416 /// Indicates that this is the only struct which contains the same pointer.
418 /// Rust functions which take ownership of an object provided via an argument require
419 /// this to be true and invalidate the object pointed to by inner.
423 impl Drop for RouteParameters {
425 if self.is_owned && !<*mut nativeRouteParameters>::is_null(self.inner) {
426 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
430 /// Frees any resources used by the RouteParameters, if is_owned is set and inner is non-NULL.
432 pub extern "C" fn RouteParameters_free(this_obj: RouteParameters) { }
434 /// Used only if an object of this type is returned as a trait impl by a method
435 pub(crate) extern "C" fn RouteParameters_free_void(this_ptr: *mut c_void) {
436 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeRouteParameters); }
439 impl RouteParameters {
440 pub(crate) fn get_native_ref(&self) -> &'static nativeRouteParameters {
441 unsafe { &*ObjOps::untweak_ptr(self.inner) }
443 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeRouteParameters {
444 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
446 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
447 pub(crate) fn take_inner(mut self) -> *mut nativeRouteParameters {
448 assert!(self.is_owned);
449 let ret = ObjOps::untweak_ptr(self.inner);
450 self.inner = core::ptr::null_mut();
454 /// The parameters of the failed payment path.
456 pub extern "C" fn RouteParameters_get_payment_params(this_ptr: &RouteParameters) -> crate::lightning::routing::router::PaymentParameters {
457 let mut inner_val = &mut this_ptr.get_native_mut_ref().payment_params;
458 crate::lightning::routing::router::PaymentParameters { inner: unsafe { ObjOps::nonnull_ptr_to_inner((inner_val as *const lightning::routing::router::PaymentParameters<>) as *mut _) }, is_owned: false }
460 /// The parameters of the failed payment path.
462 pub extern "C" fn RouteParameters_set_payment_params(this_ptr: &mut RouteParameters, mut val: crate::lightning::routing::router::PaymentParameters) {
463 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.payment_params = *unsafe { Box::from_raw(val.take_inner()) };
465 /// The amount in msats sent on the failed payment path.
467 pub extern "C" fn RouteParameters_get_final_value_msat(this_ptr: &RouteParameters) -> u64 {
468 let mut inner_val = &mut this_ptr.get_native_mut_ref().final_value_msat;
471 /// The amount in msats sent on the failed payment path.
473 pub extern "C" fn RouteParameters_set_final_value_msat(this_ptr: &mut RouteParameters, mut val: u64) {
474 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.final_value_msat = val;
476 /// The CLTV on the final hop of the failed payment path.
478 pub extern "C" fn RouteParameters_get_final_cltv_expiry_delta(this_ptr: &RouteParameters) -> u32 {
479 let mut inner_val = &mut this_ptr.get_native_mut_ref().final_cltv_expiry_delta;
482 /// The CLTV on the final hop of the failed payment path.
484 pub extern "C" fn RouteParameters_set_final_cltv_expiry_delta(this_ptr: &mut RouteParameters, mut val: u32) {
485 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.final_cltv_expiry_delta = val;
487 /// Constructs a new RouteParameters given each field
490 pub extern "C" fn RouteParameters_new(mut payment_params_arg: crate::lightning::routing::router::PaymentParameters, mut final_value_msat_arg: u64, mut final_cltv_expiry_delta_arg: u32) -> RouteParameters {
491 RouteParameters { inner: ObjOps::heap_alloc(nativeRouteParameters {
492 payment_params: *unsafe { Box::from_raw(payment_params_arg.take_inner()) },
493 final_value_msat: final_value_msat_arg,
494 final_cltv_expiry_delta: final_cltv_expiry_delta_arg,
497 impl Clone for RouteParameters {
498 fn clone(&self) -> Self {
500 inner: if <*mut nativeRouteParameters>::is_null(self.inner) { core::ptr::null_mut() } else {
501 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
507 /// Used only if an object of this type is returned as a trait impl by a method
508 pub(crate) extern "C" fn RouteParameters_clone_void(this_ptr: *const c_void) -> *mut c_void {
509 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeRouteParameters)).clone() })) as *mut c_void
512 /// Creates a copy of the RouteParameters
513 pub extern "C" fn RouteParameters_clone(orig: &RouteParameters) -> RouteParameters {
517 /// Serialize the RouteParameters object into a byte array which can be read by RouteParameters_read
518 pub extern "C" fn RouteParameters_write(obj: &crate::lightning::routing::router::RouteParameters) -> crate::c_types::derived::CVec_u8Z {
519 crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
522 pub(crate) extern "C" fn RouteParameters_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
523 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeRouteParameters) })
526 /// Read a RouteParameters from a byte array, created by RouteParameters_write
527 pub extern "C" fn RouteParameters_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_RouteParametersDecodeErrorZ {
528 let res: Result<lightning::routing::router::RouteParameters, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj(ser);
529 let mut local_res = match res { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::lightning::routing::router::RouteParameters { inner: ObjOps::heap_alloc(o), is_owned: true } }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::ln::msgs::DecodeError::native_into(e) }).into() };
532 /// Maximum total CTLV difference we allow for a full payment path.
535 pub static DEFAULT_MAX_TOTAL_CLTV_EXPIRY_DELTA: u32 = lightning::routing::router::DEFAULT_MAX_TOTAL_CLTV_EXPIRY_DELTA;
536 /// Maximum number of paths we allow an (MPP) payment to have.
539 pub static DEFAULT_MAX_PATH_COUNT: u8 = lightning::routing::router::DEFAULT_MAX_PATH_COUNT;
541 use lightning::routing::router::PaymentParameters as nativePaymentParametersImport;
542 pub(crate) type nativePaymentParameters = nativePaymentParametersImport;
544 /// The recipient of a payment.
547 pub struct PaymentParameters {
548 /// A pointer to the opaque Rust object.
550 /// Nearly everywhere, inner must be non-null, however in places where
551 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
552 pub inner: *mut nativePaymentParameters,
553 /// Indicates that this is the only struct which contains the same pointer.
555 /// Rust functions which take ownership of an object provided via an argument require
556 /// this to be true and invalidate the object pointed to by inner.
560 impl Drop for PaymentParameters {
562 if self.is_owned && !<*mut nativePaymentParameters>::is_null(self.inner) {
563 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
567 /// Frees any resources used by the PaymentParameters, if is_owned is set and inner is non-NULL.
569 pub extern "C" fn PaymentParameters_free(this_obj: PaymentParameters) { }
571 /// Used only if an object of this type is returned as a trait impl by a method
572 pub(crate) extern "C" fn PaymentParameters_free_void(this_ptr: *mut c_void) {
573 unsafe { let _ = Box::from_raw(this_ptr as *mut nativePaymentParameters); }
576 impl PaymentParameters {
577 pub(crate) fn get_native_ref(&self) -> &'static nativePaymentParameters {
578 unsafe { &*ObjOps::untweak_ptr(self.inner) }
580 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativePaymentParameters {
581 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
583 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
584 pub(crate) fn take_inner(mut self) -> *mut nativePaymentParameters {
585 assert!(self.is_owned);
586 let ret = ObjOps::untweak_ptr(self.inner);
587 self.inner = core::ptr::null_mut();
591 /// The node id of the payee.
593 pub extern "C" fn PaymentParameters_get_payee_pubkey(this_ptr: &PaymentParameters) -> crate::c_types::PublicKey {
594 let mut inner_val = &mut this_ptr.get_native_mut_ref().payee_pubkey;
595 crate::c_types::PublicKey::from_rust(&inner_val)
597 /// The node id of the payee.
599 pub extern "C" fn PaymentParameters_set_payee_pubkey(this_ptr: &mut PaymentParameters, mut val: crate::c_types::PublicKey) {
600 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.payee_pubkey = val.into_rust();
602 /// Features supported by the payee.
604 /// May be set from the payee's invoice or via [`for_keysend`]. May be `None` if the invoice
605 /// does not contain any features.
607 /// [`for_keysend`]: Self::for_keysend
609 /// Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
611 pub extern "C" fn PaymentParameters_get_features(this_ptr: &PaymentParameters) -> crate::lightning::ln::features::InvoiceFeatures {
612 let mut inner_val = &mut this_ptr.get_native_mut_ref().features;
613 let mut local_inner_val = crate::lightning::ln::features::InvoiceFeatures { inner: unsafe { (if inner_val.is_none() { core::ptr::null() } else { ObjOps::nonnull_ptr_to_inner( { (inner_val.as_ref().unwrap()) }) } as *const lightning::ln::features::InvoiceFeatures<>) as *mut _ }, is_owned: false };
616 /// Features supported by the payee.
618 /// May be set from the payee's invoice or via [`for_keysend`]. May be `None` if the invoice
619 /// does not contain any features.
621 /// [`for_keysend`]: Self::for_keysend
623 /// Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
625 pub extern "C" fn PaymentParameters_set_features(this_ptr: &mut PaymentParameters, mut val: crate::lightning::ln::features::InvoiceFeatures) {
626 let mut local_val = if val.inner.is_null() { None } else { Some( { *unsafe { Box::from_raw(val.take_inner()) } }) };
627 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.features = local_val;
629 /// Hints for routing to the payee, containing channels connecting the payee to public nodes.
631 pub extern "C" fn PaymentParameters_get_route_hints(this_ptr: &PaymentParameters) -> crate::c_types::derived::CVec_RouteHintZ {
632 let mut inner_val = &mut this_ptr.get_native_mut_ref().route_hints;
633 let mut local_inner_val = Vec::new(); for item in inner_val.iter() { local_inner_val.push( { crate::lightning::routing::router::RouteHint { inner: unsafe { ObjOps::nonnull_ptr_to_inner((item as *const lightning::routing::router::RouteHint<>) as *mut _) }, is_owned: false } }); };
634 local_inner_val.into()
636 /// Hints for routing to the payee, containing channels connecting the payee to public nodes.
638 pub extern "C" fn PaymentParameters_set_route_hints(this_ptr: &mut PaymentParameters, mut val: crate::c_types::derived::CVec_RouteHintZ) {
639 let mut local_val = Vec::new(); for mut item in val.into_rust().drain(..) { local_val.push( { *unsafe { Box::from_raw(item.take_inner()) } }); };
640 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.route_hints = local_val;
642 /// Expiration of a payment to the payee, in seconds relative to the UNIX epoch.
644 pub extern "C" fn PaymentParameters_get_expiry_time(this_ptr: &PaymentParameters) -> crate::c_types::derived::COption_u64Z {
645 let mut inner_val = &mut this_ptr.get_native_mut_ref().expiry_time;
646 let mut local_inner_val = if inner_val.is_none() { crate::c_types::derived::COption_u64Z::None } else { crate::c_types::derived::COption_u64Z::Some( { inner_val.unwrap() }) };
649 /// Expiration of a payment to the payee, in seconds relative to the UNIX epoch.
651 pub extern "C" fn PaymentParameters_set_expiry_time(this_ptr: &mut PaymentParameters, mut val: crate::c_types::derived::COption_u64Z) {
652 let mut local_val = if val.is_some() { Some( { val.take() }) } else { None };
653 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.expiry_time = local_val;
655 /// The maximum total CLTV delta we accept for the route.
656 /// Defaults to [`DEFAULT_MAX_TOTAL_CLTV_EXPIRY_DELTA`].
658 pub extern "C" fn PaymentParameters_get_max_total_cltv_expiry_delta(this_ptr: &PaymentParameters) -> u32 {
659 let mut inner_val = &mut this_ptr.get_native_mut_ref().max_total_cltv_expiry_delta;
662 /// The maximum total CLTV delta we accept for the route.
663 /// Defaults to [`DEFAULT_MAX_TOTAL_CLTV_EXPIRY_DELTA`].
665 pub extern "C" fn PaymentParameters_set_max_total_cltv_expiry_delta(this_ptr: &mut PaymentParameters, mut val: u32) {
666 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.max_total_cltv_expiry_delta = val;
668 /// The maximum number of paths that may be used by (MPP) payments.
669 /// Defaults to [`DEFAULT_MAX_PATH_COUNT`].
671 pub extern "C" fn PaymentParameters_get_max_path_count(this_ptr: &PaymentParameters) -> u8 {
672 let mut inner_val = &mut this_ptr.get_native_mut_ref().max_path_count;
675 /// The maximum number of paths that may be used by (MPP) payments.
676 /// Defaults to [`DEFAULT_MAX_PATH_COUNT`].
678 pub extern "C" fn PaymentParameters_set_max_path_count(this_ptr: &mut PaymentParameters, mut val: u8) {
679 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.max_path_count = val;
681 /// Selects the maximum share of a channel's total capacity which will be sent over a channel,
682 /// as a power of 1/2. A higher value prefers to send the payment using more MPP parts whereas
683 /// a lower value prefers to send larger MPP parts, potentially saturating channels and
684 /// increasing failure probability for those paths.
686 /// Note that this restriction will be relaxed during pathfinding after paths which meet this
687 /// restriction have been found. While paths which meet this criteria will be searched for, it
688 /// is ultimately up to the scorer to select them over other paths.
690 /// A value of 0 will allow payments up to and including a channel's total announced usable
691 /// capacity, a value of one will only use up to half its capacity, two 1/4, etc.
695 pub extern "C" fn PaymentParameters_get_max_channel_saturation_power_of_half(this_ptr: &PaymentParameters) -> u8 {
696 let mut inner_val = &mut this_ptr.get_native_mut_ref().max_channel_saturation_power_of_half;
699 /// Selects the maximum share of a channel's total capacity which will be sent over a channel,
700 /// as a power of 1/2. A higher value prefers to send the payment using more MPP parts whereas
701 /// a lower value prefers to send larger MPP parts, potentially saturating channels and
702 /// increasing failure probability for those paths.
704 /// Note that this restriction will be relaxed during pathfinding after paths which meet this
705 /// restriction have been found. While paths which meet this criteria will be searched for, it
706 /// is ultimately up to the scorer to select them over other paths.
708 /// A value of 0 will allow payments up to and including a channel's total announced usable
709 /// capacity, a value of one will only use up to half its capacity, two 1/4, etc.
713 pub extern "C" fn PaymentParameters_set_max_channel_saturation_power_of_half(this_ptr: &mut PaymentParameters, mut val: u8) {
714 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.max_channel_saturation_power_of_half = val;
716 /// A list of SCIDs which this payment was previously attempted over and which caused the
717 /// payment to fail. Future attempts for the same payment shouldn't be relayed through any of
720 /// Returns a copy of the field.
722 pub extern "C" fn PaymentParameters_get_previously_failed_channels(this_ptr: &PaymentParameters) -> crate::c_types::derived::CVec_u64Z {
723 let mut inner_val = this_ptr.get_native_mut_ref().previously_failed_channels.clone();
724 let mut local_inner_val = Vec::new(); for mut item in inner_val.drain(..) { local_inner_val.push( { item }); };
725 local_inner_val.into()
727 /// A list of SCIDs which this payment was previously attempted over and which caused the
728 /// payment to fail. Future attempts for the same payment shouldn't be relayed through any of
731 pub extern "C" fn PaymentParameters_set_previously_failed_channels(this_ptr: &mut PaymentParameters, mut val: crate::c_types::derived::CVec_u64Z) {
732 let mut local_val = Vec::new(); for mut item in val.into_rust().drain(..) { local_val.push( { item }); };
733 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.previously_failed_channels = local_val;
735 /// Constructs a new PaymentParameters given each field
738 pub extern "C" fn PaymentParameters_new(mut payee_pubkey_arg: crate::c_types::PublicKey, mut features_arg: crate::lightning::ln::features::InvoiceFeatures, mut route_hints_arg: crate::c_types::derived::CVec_RouteHintZ, mut expiry_time_arg: crate::c_types::derived::COption_u64Z, mut max_total_cltv_expiry_delta_arg: u32, mut max_path_count_arg: u8, mut max_channel_saturation_power_of_half_arg: u8, mut previously_failed_channels_arg: crate::c_types::derived::CVec_u64Z) -> PaymentParameters {
739 let mut local_features_arg = if features_arg.inner.is_null() { None } else { Some( { *unsafe { Box::from_raw(features_arg.take_inner()) } }) };
740 let mut local_route_hints_arg = Vec::new(); for mut item in route_hints_arg.into_rust().drain(..) { local_route_hints_arg.push( { *unsafe { Box::from_raw(item.take_inner()) } }); };
741 let mut local_expiry_time_arg = if expiry_time_arg.is_some() { Some( { expiry_time_arg.take() }) } else { None };
742 let mut local_previously_failed_channels_arg = Vec::new(); for mut item in previously_failed_channels_arg.into_rust().drain(..) { local_previously_failed_channels_arg.push( { item }); };
743 PaymentParameters { inner: ObjOps::heap_alloc(nativePaymentParameters {
744 payee_pubkey: payee_pubkey_arg.into_rust(),
745 features: local_features_arg,
746 route_hints: local_route_hints_arg,
747 expiry_time: local_expiry_time_arg,
748 max_total_cltv_expiry_delta: max_total_cltv_expiry_delta_arg,
749 max_path_count: max_path_count_arg,
750 max_channel_saturation_power_of_half: max_channel_saturation_power_of_half_arg,
751 previously_failed_channels: local_previously_failed_channels_arg,
754 impl Clone for PaymentParameters {
755 fn clone(&self) -> Self {
757 inner: if <*mut nativePaymentParameters>::is_null(self.inner) { core::ptr::null_mut() } else {
758 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
764 /// Used only if an object of this type is returned as a trait impl by a method
765 pub(crate) extern "C" fn PaymentParameters_clone_void(this_ptr: *const c_void) -> *mut c_void {
766 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativePaymentParameters)).clone() })) as *mut c_void
769 /// Creates a copy of the PaymentParameters
770 pub extern "C" fn PaymentParameters_clone(orig: &PaymentParameters) -> PaymentParameters {
773 /// Checks if two PaymentParameterss contain equal inner contents.
775 pub extern "C" fn PaymentParameters_hash(o: &PaymentParameters) -> u64 {
776 if o.inner.is_null() { return 0; }
777 // Note that we'd love to use alloc::collections::hash_map::DefaultHasher but it's not in core
779 let mut hasher = core::hash::SipHasher::new();
780 core::hash::Hash::hash(o.get_native_ref(), &mut hasher);
781 core::hash::Hasher::finish(&hasher)
783 /// Checks if two PaymentParameterss contain equal inner contents.
784 /// This ignores pointers and is_owned flags and looks at the values in fields.
785 /// Two objects with NULL inner values will be considered "equal" here.
787 pub extern "C" fn PaymentParameters_eq(a: &PaymentParameters, b: &PaymentParameters) -> bool {
788 if a.inner == b.inner { return true; }
789 if a.inner.is_null() || b.inner.is_null() { return false; }
790 if a.get_native_ref() == b.get_native_ref() { true } else { false }
793 /// Serialize the PaymentParameters object into a byte array which can be read by PaymentParameters_read
794 pub extern "C" fn PaymentParameters_write(obj: &crate::lightning::routing::router::PaymentParameters) -> crate::c_types::derived::CVec_u8Z {
795 crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
798 pub(crate) extern "C" fn PaymentParameters_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
799 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativePaymentParameters) })
802 /// Read a PaymentParameters from a byte array, created by PaymentParameters_write
803 pub extern "C" fn PaymentParameters_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_PaymentParametersDecodeErrorZ {
804 let res: Result<lightning::routing::router::PaymentParameters, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj(ser);
805 let mut local_res = match res { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::lightning::routing::router::PaymentParameters { inner: ObjOps::heap_alloc(o), is_owned: true } }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::ln::msgs::DecodeError::native_into(e) }).into() };
808 /// Creates a payee with the node id of the given `pubkey`.
811 pub extern "C" fn PaymentParameters_from_node_id(mut payee_pubkey: crate::c_types::PublicKey) -> crate::lightning::routing::router::PaymentParameters {
812 let mut ret = lightning::routing::router::PaymentParameters::from_node_id(payee_pubkey.into_rust());
813 crate::lightning::routing::router::PaymentParameters { inner: ObjOps::heap_alloc(ret), is_owned: true }
816 /// Creates a payee with the node id of the given `pubkey` to use for keysend payments.
819 pub extern "C" fn PaymentParameters_for_keysend(mut payee_pubkey: crate::c_types::PublicKey) -> crate::lightning::routing::router::PaymentParameters {
820 let mut ret = lightning::routing::router::PaymentParameters::for_keysend(payee_pubkey.into_rust());
821 crate::lightning::routing::router::PaymentParameters { inner: ObjOps::heap_alloc(ret), is_owned: true }
825 use lightning::routing::router::RouteHint as nativeRouteHintImport;
826 pub(crate) type nativeRouteHint = nativeRouteHintImport;
828 /// A list of hops along a payment path terminating with a channel to the recipient.
831 pub struct RouteHint {
832 /// A pointer to the opaque Rust object.
834 /// Nearly everywhere, inner must be non-null, however in places where
835 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
836 pub inner: *mut nativeRouteHint,
837 /// Indicates that this is the only struct which contains the same pointer.
839 /// Rust functions which take ownership of an object provided via an argument require
840 /// this to be true and invalidate the object pointed to by inner.
844 impl Drop for RouteHint {
846 if self.is_owned && !<*mut nativeRouteHint>::is_null(self.inner) {
847 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
851 /// Frees any resources used by the RouteHint, if is_owned is set and inner is non-NULL.
853 pub extern "C" fn RouteHint_free(this_obj: RouteHint) { }
855 /// Used only if an object of this type is returned as a trait impl by a method
856 pub(crate) extern "C" fn RouteHint_free_void(this_ptr: *mut c_void) {
857 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeRouteHint); }
861 pub(crate) fn get_native_ref(&self) -> &'static nativeRouteHint {
862 unsafe { &*ObjOps::untweak_ptr(self.inner) }
864 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeRouteHint {
865 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
867 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
868 pub(crate) fn take_inner(mut self) -> *mut nativeRouteHint {
869 assert!(self.is_owned);
870 let ret = ObjOps::untweak_ptr(self.inner);
871 self.inner = core::ptr::null_mut();
876 pub extern "C" fn RouteHint_get_a(this_ptr: &RouteHint) -> crate::c_types::derived::CVec_RouteHintHopZ {
877 let mut inner_val = &mut this_ptr.get_native_mut_ref().0;
878 let mut local_inner_val = Vec::new(); for item in inner_val.iter() { local_inner_val.push( { crate::lightning::routing::router::RouteHintHop { inner: unsafe { ObjOps::nonnull_ptr_to_inner((item as *const lightning::routing::router::RouteHintHop<>) as *mut _) }, is_owned: false } }); };
879 local_inner_val.into()
882 pub extern "C" fn RouteHint_set_a(this_ptr: &mut RouteHint, mut val: crate::c_types::derived::CVec_RouteHintHopZ) {
883 let mut local_val = Vec::new(); for mut item in val.into_rust().drain(..) { local_val.push( { *unsafe { Box::from_raw(item.take_inner()) } }); };
884 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.0 = local_val;
886 /// Constructs a new RouteHint given each field
889 pub extern "C" fn RouteHint_new(mut a_arg: crate::c_types::derived::CVec_RouteHintHopZ) -> RouteHint {
890 let mut local_a_arg = Vec::new(); for mut item in a_arg.into_rust().drain(..) { local_a_arg.push( { *unsafe { Box::from_raw(item.take_inner()) } }); };
891 RouteHint { inner: ObjOps::heap_alloc(lightning::routing::router::RouteHint (
895 impl Clone for RouteHint {
896 fn clone(&self) -> Self {
898 inner: if <*mut nativeRouteHint>::is_null(self.inner) { core::ptr::null_mut() } else {
899 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
905 /// Used only if an object of this type is returned as a trait impl by a method
906 pub(crate) extern "C" fn RouteHint_clone_void(this_ptr: *const c_void) -> *mut c_void {
907 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeRouteHint)).clone() })) as *mut c_void
910 /// Creates a copy of the RouteHint
911 pub extern "C" fn RouteHint_clone(orig: &RouteHint) -> RouteHint {
914 /// Checks if two RouteHints contain equal inner contents.
916 pub extern "C" fn RouteHint_hash(o: &RouteHint) -> u64 {
917 if o.inner.is_null() { return 0; }
918 // Note that we'd love to use alloc::collections::hash_map::DefaultHasher but it's not in core
920 let mut hasher = core::hash::SipHasher::new();
921 core::hash::Hash::hash(o.get_native_ref(), &mut hasher);
922 core::hash::Hasher::finish(&hasher)
924 /// Checks if two RouteHints contain equal inner contents.
925 /// This ignores pointers and is_owned flags and looks at the values in fields.
926 /// Two objects with NULL inner values will be considered "equal" here.
928 pub extern "C" fn RouteHint_eq(a: &RouteHint, b: &RouteHint) -> bool {
929 if a.inner == b.inner { return true; }
930 if a.inner.is_null() || b.inner.is_null() { return false; }
931 if a.get_native_ref() == b.get_native_ref() { true } else { false }
934 /// Serialize the RouteHint object into a byte array which can be read by RouteHint_read
935 pub extern "C" fn RouteHint_write(obj: &crate::lightning::routing::router::RouteHint) -> crate::c_types::derived::CVec_u8Z {
936 crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
939 pub(crate) extern "C" fn RouteHint_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
940 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeRouteHint) })
943 /// Read a RouteHint from a byte array, created by RouteHint_write
944 pub extern "C" fn RouteHint_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_RouteHintDecodeErrorZ {
945 let res: Result<lightning::routing::router::RouteHint, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj(ser);
946 let mut local_res = match res { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::lightning::routing::router::RouteHint { inner: ObjOps::heap_alloc(o), is_owned: true } }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::ln::msgs::DecodeError::native_into(e) }).into() };
950 use lightning::routing::router::RouteHintHop as nativeRouteHintHopImport;
951 pub(crate) type nativeRouteHintHop = nativeRouteHintHopImport;
953 /// A channel descriptor for a hop along a payment path.
956 pub struct RouteHintHop {
957 /// A pointer to the opaque Rust object.
959 /// Nearly everywhere, inner must be non-null, however in places where
960 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
961 pub inner: *mut nativeRouteHintHop,
962 /// Indicates that this is the only struct which contains the same pointer.
964 /// Rust functions which take ownership of an object provided via an argument require
965 /// this to be true and invalidate the object pointed to by inner.
969 impl Drop for RouteHintHop {
971 if self.is_owned && !<*mut nativeRouteHintHop>::is_null(self.inner) {
972 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
976 /// Frees any resources used by the RouteHintHop, if is_owned is set and inner is non-NULL.
978 pub extern "C" fn RouteHintHop_free(this_obj: RouteHintHop) { }
980 /// Used only if an object of this type is returned as a trait impl by a method
981 pub(crate) extern "C" fn RouteHintHop_free_void(this_ptr: *mut c_void) {
982 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeRouteHintHop); }
986 pub(crate) fn get_native_ref(&self) -> &'static nativeRouteHintHop {
987 unsafe { &*ObjOps::untweak_ptr(self.inner) }
989 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeRouteHintHop {
990 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
992 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
993 pub(crate) fn take_inner(mut self) -> *mut nativeRouteHintHop {
994 assert!(self.is_owned);
995 let ret = ObjOps::untweak_ptr(self.inner);
996 self.inner = core::ptr::null_mut();
1000 /// The node_id of the non-target end of the route
1002 pub extern "C" fn RouteHintHop_get_src_node_id(this_ptr: &RouteHintHop) -> crate::c_types::PublicKey {
1003 let mut inner_val = &mut this_ptr.get_native_mut_ref().src_node_id;
1004 crate::c_types::PublicKey::from_rust(&inner_val)
1006 /// The node_id of the non-target end of the route
1008 pub extern "C" fn RouteHintHop_set_src_node_id(this_ptr: &mut RouteHintHop, mut val: crate::c_types::PublicKey) {
1009 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.src_node_id = val.into_rust();
1011 /// The short_channel_id of this channel
1013 pub extern "C" fn RouteHintHop_get_short_channel_id(this_ptr: &RouteHintHop) -> u64 {
1014 let mut inner_val = &mut this_ptr.get_native_mut_ref().short_channel_id;
1017 /// The short_channel_id of this channel
1019 pub extern "C" fn RouteHintHop_set_short_channel_id(this_ptr: &mut RouteHintHop, mut val: u64) {
1020 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.short_channel_id = val;
1022 /// The fees which must be paid to use this channel
1024 pub extern "C" fn RouteHintHop_get_fees(this_ptr: &RouteHintHop) -> crate::lightning::routing::gossip::RoutingFees {
1025 let mut inner_val = &mut this_ptr.get_native_mut_ref().fees;
1026 crate::lightning::routing::gossip::RoutingFees { inner: unsafe { ObjOps::nonnull_ptr_to_inner((inner_val as *const lightning::routing::gossip::RoutingFees<>) as *mut _) }, is_owned: false }
1028 /// The fees which must be paid to use this channel
1030 pub extern "C" fn RouteHintHop_set_fees(this_ptr: &mut RouteHintHop, mut val: crate::lightning::routing::gossip::RoutingFees) {
1031 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.fees = *unsafe { Box::from_raw(val.take_inner()) };
1033 /// The difference in CLTV values between this node and the next node.
1035 pub extern "C" fn RouteHintHop_get_cltv_expiry_delta(this_ptr: &RouteHintHop) -> u16 {
1036 let mut inner_val = &mut this_ptr.get_native_mut_ref().cltv_expiry_delta;
1039 /// The difference in CLTV values between this node and the next node.
1041 pub extern "C" fn RouteHintHop_set_cltv_expiry_delta(this_ptr: &mut RouteHintHop, mut val: u16) {
1042 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.cltv_expiry_delta = val;
1044 /// The minimum value, in msat, which must be relayed to the next hop.
1046 pub extern "C" fn RouteHintHop_get_htlc_minimum_msat(this_ptr: &RouteHintHop) -> crate::c_types::derived::COption_u64Z {
1047 let mut inner_val = &mut this_ptr.get_native_mut_ref().htlc_minimum_msat;
1048 let mut local_inner_val = if inner_val.is_none() { crate::c_types::derived::COption_u64Z::None } else { crate::c_types::derived::COption_u64Z::Some( { inner_val.unwrap() }) };
1051 /// The minimum value, in msat, which must be relayed to the next hop.
1053 pub extern "C" fn RouteHintHop_set_htlc_minimum_msat(this_ptr: &mut RouteHintHop, mut val: crate::c_types::derived::COption_u64Z) {
1054 let mut local_val = if val.is_some() { Some( { val.take() }) } else { None };
1055 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.htlc_minimum_msat = local_val;
1057 /// The maximum value in msat available for routing with a single HTLC.
1059 pub extern "C" fn RouteHintHop_get_htlc_maximum_msat(this_ptr: &RouteHintHop) -> crate::c_types::derived::COption_u64Z {
1060 let mut inner_val = &mut this_ptr.get_native_mut_ref().htlc_maximum_msat;
1061 let mut local_inner_val = if inner_val.is_none() { crate::c_types::derived::COption_u64Z::None } else { crate::c_types::derived::COption_u64Z::Some( { inner_val.unwrap() }) };
1064 /// The maximum value in msat available for routing with a single HTLC.
1066 pub extern "C" fn RouteHintHop_set_htlc_maximum_msat(this_ptr: &mut RouteHintHop, mut val: crate::c_types::derived::COption_u64Z) {
1067 let mut local_val = if val.is_some() { Some( { val.take() }) } else { None };
1068 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.htlc_maximum_msat = local_val;
1070 /// Constructs a new RouteHintHop given each field
1073 pub extern "C" fn RouteHintHop_new(mut src_node_id_arg: crate::c_types::PublicKey, mut short_channel_id_arg: u64, mut fees_arg: crate::lightning::routing::gossip::RoutingFees, mut cltv_expiry_delta_arg: u16, mut htlc_minimum_msat_arg: crate::c_types::derived::COption_u64Z, mut htlc_maximum_msat_arg: crate::c_types::derived::COption_u64Z) -> RouteHintHop {
1074 let mut local_htlc_minimum_msat_arg = if htlc_minimum_msat_arg.is_some() { Some( { htlc_minimum_msat_arg.take() }) } else { None };
1075 let mut local_htlc_maximum_msat_arg = if htlc_maximum_msat_arg.is_some() { Some( { htlc_maximum_msat_arg.take() }) } else { None };
1076 RouteHintHop { inner: ObjOps::heap_alloc(nativeRouteHintHop {
1077 src_node_id: src_node_id_arg.into_rust(),
1078 short_channel_id: short_channel_id_arg,
1079 fees: *unsafe { Box::from_raw(fees_arg.take_inner()) },
1080 cltv_expiry_delta: cltv_expiry_delta_arg,
1081 htlc_minimum_msat: local_htlc_minimum_msat_arg,
1082 htlc_maximum_msat: local_htlc_maximum_msat_arg,
1083 }), is_owned: true }
1085 impl Clone for RouteHintHop {
1086 fn clone(&self) -> Self {
1088 inner: if <*mut nativeRouteHintHop>::is_null(self.inner) { core::ptr::null_mut() } else {
1089 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
1095 /// Used only if an object of this type is returned as a trait impl by a method
1096 pub(crate) extern "C" fn RouteHintHop_clone_void(this_ptr: *const c_void) -> *mut c_void {
1097 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeRouteHintHop)).clone() })) as *mut c_void
1100 /// Creates a copy of the RouteHintHop
1101 pub extern "C" fn RouteHintHop_clone(orig: &RouteHintHop) -> RouteHintHop {
1104 /// Checks if two RouteHintHops contain equal inner contents.
1106 pub extern "C" fn RouteHintHop_hash(o: &RouteHintHop) -> u64 {
1107 if o.inner.is_null() { return 0; }
1108 // Note that we'd love to use alloc::collections::hash_map::DefaultHasher but it's not in core
1109 #[allow(deprecated)]
1110 let mut hasher = core::hash::SipHasher::new();
1111 core::hash::Hash::hash(o.get_native_ref(), &mut hasher);
1112 core::hash::Hasher::finish(&hasher)
1114 /// Checks if two RouteHintHops contain equal inner contents.
1115 /// This ignores pointers and is_owned flags and looks at the values in fields.
1116 /// Two objects with NULL inner values will be considered "equal" here.
1118 pub extern "C" fn RouteHintHop_eq(a: &RouteHintHop, b: &RouteHintHop) -> bool {
1119 if a.inner == b.inner { return true; }
1120 if a.inner.is_null() || b.inner.is_null() { return false; }
1121 if a.get_native_ref() == b.get_native_ref() { true } else { false }
1124 /// Serialize the RouteHintHop object into a byte array which can be read by RouteHintHop_read
1125 pub extern "C" fn RouteHintHop_write(obj: &crate::lightning::routing::router::RouteHintHop) -> crate::c_types::derived::CVec_u8Z {
1126 crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
1129 pub(crate) extern "C" fn RouteHintHop_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
1130 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeRouteHintHop) })
1133 /// Read a RouteHintHop from a byte array, created by RouteHintHop_write
1134 pub extern "C" fn RouteHintHop_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_RouteHintHopDecodeErrorZ {
1135 let res: Result<lightning::routing::router::RouteHintHop, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj(ser);
1136 let mut local_res = match res { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::lightning::routing::router::RouteHintHop { inner: ObjOps::heap_alloc(o), is_owned: true } }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::ln::msgs::DecodeError::native_into(e) }).into() };
1139 /// Finds a route from us (payer) to the given target node (payee).
1141 /// If the payee provided features in their invoice, they should be provided via `params.payee`.
1142 /// Without this, MPP will only be used if the payee's features are available in the network graph.
1144 /// Private routing paths between a public node and the target may be included in `params.payee`.
1146 /// If some channels aren't announced, it may be useful to fill in `first_hops` with the results
1147 /// from [`ChannelManager::list_usable_channels`]. If it is filled in, the view of these channels
1148 /// from `network_graph` will be ignored, and only those in `first_hops` will be used.
1150 /// The fees on channels from us to the next hop are ignored as they are assumed to all be equal.
1151 /// However, the enabled/disabled bit on such channels as well as the `htlc_minimum_msat` /
1152 /// `htlc_maximum_msat` *are* checked as they may change based on the receiving node.
1156 /// May be used to re-compute a [`Route`] when handling a [`Event::PaymentPathFailed`]. Any
1157 /// adjustments to the [`NetworkGraph`] and channel scores should be made prior to calling this
1162 /// Panics if first_hops contains channels without short_channel_ids;
1163 /// [`ChannelManager::list_usable_channels`] will never include such channels.
1165 /// [`ChannelManager::list_usable_channels`]: crate::ln::channelmanager::ChannelManager::list_usable_channels
1166 /// [`Event::PaymentPathFailed`]: crate::util::events::Event::PaymentPathFailed
1167 /// [`NetworkGraph`]: crate::routing::gossip::NetworkGraph
1169 /// Note that first_hops (or a relevant inner pointer) may be NULL or all-0s to represent None
1171 pub extern "C" fn find_route(mut our_node_pubkey: crate::c_types::PublicKey, route_params: &crate::lightning::routing::router::RouteParameters, network_graph: &crate::lightning::routing::gossip::NetworkGraph, first_hops: *mut crate::c_types::derived::CVec_ChannelDetailsZ, mut logger: crate::lightning::util::logger::Logger, scorer: &crate::lightning::routing::scoring::Score, random_seed_bytes: *const [u8; 32]) -> crate::c_types::derived::CResult_RouteLightningErrorZ {
1172 let mut local_first_hops_base = if first_hops == core::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( { item.get_native_ref() }); }; local_first_hops_0 }) }; let mut local_first_hops = local_first_hops_base.as_ref().map(|a| &a[..]);
1173 let mut ret = lightning::routing::router::find_route::<crate::lightning::util::logger::Logger, crate::lightning::util::logger::Logger, crate::lightning::routing::scoring::Score>(&our_node_pubkey.into_rust(), route_params.get_native_ref(), network_graph.get_native_ref(), local_first_hops, logger, scorer, unsafe { &*random_seed_bytes});
1174 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::lightning::routing::router::Route { inner: ObjOps::heap_alloc(o), is_owned: true } }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::ln::msgs::LightningError { inner: ObjOps::heap_alloc(e), is_owned: true } }).into() };
1178 /// Construct a route from us (payer) to the target node (payee) via the given hops (which should
1179 /// exclude the payer, but include the payee). This may be useful, e.g., for probing the chosen path.
1181 /// Re-uses logic from `find_route`, so the restrictions described there also apply here.
1183 pub extern "C" fn build_route_from_hops(mut our_node_pubkey: crate::c_types::PublicKey, mut hops: crate::c_types::derived::CVec_PublicKeyZ, route_params: &crate::lightning::routing::router::RouteParameters, network_graph: &crate::lightning::routing::gossip::NetworkGraph, mut logger: crate::lightning::util::logger::Logger, random_seed_bytes: *const [u8; 32]) -> crate::c_types::derived::CResult_RouteLightningErrorZ {
1184 let mut local_hops = Vec::new(); for mut item in hops.into_rust().drain(..) { local_hops.push( { item.into_rust() }); };
1185 let mut ret = lightning::routing::router::build_route_from_hops::<crate::lightning::util::logger::Logger, crate::lightning::util::logger::Logger>(&our_node_pubkey.into_rust(), &local_hops[..], route_params.get_native_ref(), network_graph.get_native_ref(), logger, unsafe { &*random_seed_bytes});
1186 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::lightning::routing::router::Route { inner: ObjOps::heap_alloc(o), is_owned: true } }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::ln::msgs::LightningError { inner: ObjOps::heap_alloc(e), is_owned: true } }).into() };