_ Git - ldk-c-bindings/blob - lightning-c-bindings/src/lightning/routing/router.rs

   1 // This file is Copyright its original authors, visible in version control
   2 // history and in the source files from which this was generated.
   3 //
   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.
   8
   9 //! The top-level routing/network map tracking logic lives here.
  10 //!
  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.
  13
  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};
  21
  22
  23 use lightning::routing::router::RouteHop as nativeRouteHopImport;
  24 pub(crate) type nativeRouteHop = nativeRouteHopImport;
  25
  26 /// A hop in a route
  27 #[must_use]
  28 #[repr(C)]
  29 pub struct RouteHop {
  30         /// A pointer to the opaque Rust object.
  31
  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.
  36
  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.
  39         pub is_owned: bool,
  40 }
  41
  42 impl Drop for RouteHop {
  43         fn drop(&mut self) {
  44                 if self.is_owned && !<*mut nativeRouteHop>::is_null(self.inner) {
  45                         let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
  46                 }
  47         }
  48 }
  49 /// Frees any resources used by the RouteHop, if is_owned is set and inner is non-NULL.
  50 #[no_mangle]
  51 pub extern "C" fn RouteHop_free(this_obj: RouteHop) { }
  52 #[allow(unused)]
  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); }
  56 }
  57 #[allow(unused)]
  58 impl RouteHop {
  59         pub(crate) fn get_native_ref(&self) -> &'static nativeRouteHop {
  60                 unsafe { &*ObjOps::untweak_ptr(self.inner) }
  61         }
  62         pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeRouteHop {
  63                 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
  64         }
  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();
  70                 ret
  71         }
  72 }
  73 /// The node_id of the node at this hop.
  74 #[no_mangle]
  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)
  78 }
  79 /// The node_id of the node at this hop.
  80 #[no_mangle]
  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();
  83 }
  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.
  86 #[no_mangle]
  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 }
  90 }
  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.
  93 #[no_mangle]
  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()) };
  96 }
  97 /// The channel that should be used from the previous hop to reach this node.
  98 #[no_mangle]
  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;
 101         *inner_val
 102 }
 103 /// The channel that should be used from the previous hop to reach this node.
 104 #[no_mangle]
 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;
 107 }
 108 /// The channel_announcement features of the channel that should be used from the previous hop
 109 /// to reach this node.
 110 #[no_mangle]
 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 }
 114 }
 115 /// The channel_announcement features of the channel that should be used from the previous hop
 116 /// to reach this node.
 117 #[no_mangle]
 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()) };
 120 }
 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).
 124 #[no_mangle]
 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;
 127         *inner_val
 128 }
 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).
 132 #[no_mangle]
 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;
 135 }
 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.
 138 #[no_mangle]
 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;
 141         *inner_val
 142 }
 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.
 145 #[no_mangle]
 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;
 148 }
 149 /// Constructs a new RouteHop given each field
 150 #[must_use]
 151 #[no_mangle]
 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,
 160         }), is_owned: true }
 161 }
 162 impl Clone for RouteHop {
 163         fn clone(&self) -> Self {
 164                 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()) },
 167                         is_owned: true,
 168                 }
 169         }
 170 }
 171 #[allow(unused)]
 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
 175 }
 176 #[no_mangle]
 177 /// Creates a copy of the RouteHop
 178 pub extern "C" fn RouteHop_clone(orig: &RouteHop) -> RouteHop {
 179         orig.clone()
 180 }
 181 /// Checks if two RouteHops contain equal inner contents.
 182 #[no_mangle]
 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
 186         #[allow(deprecated)]
 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)
 190 }
 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.
 194 #[no_mangle]
 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 }
 199 }
 200 #[no_mangle]
 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())
 204 }
 205 #[no_mangle]
 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) })
 208 }
 209 #[no_mangle]
 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 { inner: ObjOps::heap_alloc(e), is_owned: true } }).into() };
 214         local_res
 215 }
 216
 217 use lightning::routing::router::Route as nativeRouteImport;
 218 pub(crate) type nativeRoute = nativeRouteImport;
 219
 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.
 222 #[must_use]
 223 #[repr(C)]
 224 pub struct Route {
 225         /// A pointer to the opaque Rust object.
 226
 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.
 231
 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.
 234         pub is_owned: bool,
 235 }
 236
 237 impl Drop for Route {
 238         fn drop(&mut self) {
 239                 if self.is_owned && !<*mut nativeRoute>::is_null(self.inner) {
 240                         let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
 241                 }
 242         }
 243 }
 244 /// Frees any resources used by the Route, if is_owned is set and inner is non-NULL.
 245 #[no_mangle]
 246 pub extern "C" fn Route_free(this_obj: Route) { }
 247 #[allow(unused)]
 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); }
 251 }
 252 #[allow(unused)]
 253 impl Route {
 254         pub(crate) fn get_native_ref(&self) -> &'static nativeRoute {
 255                 unsafe { &*ObjOps::untweak_ptr(self.inner) }
 256         }
 257         pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeRoute {
 258                 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
 259         }
 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();
 265                 ret
 266         }
 267 }
 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.
 273 #[no_mangle]
 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()
 278 }
 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.
 284 #[no_mangle]
 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;
 288 }
 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`].
 292 ///
 293 /// [`Event::PaymentPathFailed`]: crate::util::events::Event::PaymentPathFailed
 294 ///
 295 /// Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
 296 #[no_mangle]
 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 };
 300         local_inner_val
 301 }
 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`].
 305 ///
 306 /// [`Event::PaymentPathFailed`]: crate::util::events::Event::PaymentPathFailed
 307 ///
 308 /// Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
 309 #[no_mangle]
 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;
 313 }
 314 /// Constructs a new Route given each field
 315 #[must_use]
 316 #[no_mangle]
 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,
 323         }), is_owned: true }
 324 }
 325 impl Clone for Route {
 326         fn clone(&self) -> Self {
 327                 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()) },
 330                         is_owned: true,
 331                 }
 332         }
 333 }
 334 #[allow(unused)]
 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
 338 }
 339 #[no_mangle]
 340 /// Creates a copy of the Route
 341 pub extern "C" fn Route_clone(orig: &Route) -> Route {
 342         orig.clone()
 343 }
 344 /// Checks if two Routes contain equal inner contents.
 345 #[no_mangle]
 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
 349         #[allow(deprecated)]
 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)
 353 }
 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.
 357 #[no_mangle]
 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 }
 362 }
 363 /// Returns the total amount of fees paid on this [`Route`].
 364 ///
 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`.
 367 #[must_use]
 368 #[no_mangle]
 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();
 371         ret
 372 }
 373
 374 /// Returns the total amount paid on this [`Route`], excluding the fees.
 375 #[must_use]
 376 #[no_mangle]
 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();
 379         ret
 380 }
 381
 382 #[no_mangle]
 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())
 386 }
 387 #[no_mangle]
 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) })
 390 }
 391 #[no_mangle]
 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 { inner: ObjOps::heap_alloc(e), is_owned: true } }).into() };
 396         local_res
 397 }
 398
 399 use lightning::routing::router::RouteParameters as nativeRouteParametersImport;
 400 pub(crate) type nativeRouteParameters = nativeRouteParametersImport;
 401
 402 /// Parameters needed to find a [`Route`].
 403 ///
 404 /// Passed to [`find_route`] and [`build_route_from_hops`], but also provided in
 405 /// [`Event::PaymentPathFailed`] for retrying a failed payment path.
 406 ///
 407 /// [`Event::PaymentPathFailed`]: crate::util::events::Event::PaymentPathFailed
 408 #[must_use]
 409 #[repr(C)]
 410 pub struct RouteParameters {
 411         /// A pointer to the opaque Rust object.
 412
 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.
 417
 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.
 420         pub is_owned: bool,
 421 }
 422
 423 impl Drop for RouteParameters {
 424         fn drop(&mut self) {
 425                 if self.is_owned && !<*mut nativeRouteParameters>::is_null(self.inner) {
 426                         let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
 427                 }
 428         }
 429 }
 430 /// Frees any resources used by the RouteParameters, if is_owned is set and inner is non-NULL.
 431 #[no_mangle]
 432 pub extern "C" fn RouteParameters_free(this_obj: RouteParameters) { }
 433 #[allow(unused)]
 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); }
 437 }
 438 #[allow(unused)]
 439 impl RouteParameters {
 440         pub(crate) fn get_native_ref(&self) -> &'static nativeRouteParameters {
 441                 unsafe { &*ObjOps::untweak_ptr(self.inner) }
 442         }
 443         pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeRouteParameters {
 444                 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
 445         }
 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();
 451                 ret
 452         }
 453 }
 454 /// The parameters of the failed payment path.
 455 #[no_mangle]
 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 }
 459 }
 460 /// The parameters of the failed payment path.
 461 #[no_mangle]
 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()) };
 464 }
 465 /// The amount in msats sent on the failed payment path.
 466 #[no_mangle]
 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;
 469         *inner_val
 470 }
 471 /// The amount in msats sent on the failed payment path.
 472 #[no_mangle]
 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;
 475 }
 476 /// The CLTV on the final hop of the failed payment path.
 477 #[no_mangle]
 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;
 480         *inner_val
 481 }
 482 /// The CLTV on the final hop of the failed payment path.
 483 #[no_mangle]
 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;
 486 }
 487 /// Constructs a new RouteParameters given each field
 488 #[must_use]
 489 #[no_mangle]
 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,
 495         }), is_owned: true }
 496 }
 497 impl Clone for RouteParameters {
 498         fn clone(&self) -> Self {
 499                 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()) },
 502                         is_owned: true,
 503                 }
 504         }
 505 }
 506 #[allow(unused)]
 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
 510 }
 511 #[no_mangle]
 512 /// Creates a copy of the RouteParameters
 513 pub extern "C" fn RouteParameters_clone(orig: &RouteParameters) -> RouteParameters {
 514         orig.clone()
 515 }
 516 #[no_mangle]
 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())
 520 }
 521 #[no_mangle]
 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) })
 524 }
 525 #[no_mangle]
 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 { inner: ObjOps::heap_alloc(e), is_owned: true } }).into() };
 530         local_res
 531 }
 532 /// Maximum total CTLV difference we allow for a full payment path.
 533
 534 #[no_mangle]
 535 pub static DEFAULT_MAX_TOTAL_CLTV_EXPIRY_DELTA: u32 = lightning::routing::router::DEFAULT_MAX_TOTAL_CLTV_EXPIRY_DELTA;
 536
 537 use lightning::routing::router::PaymentParameters as nativePaymentParametersImport;
 538 pub(crate) type nativePaymentParameters = nativePaymentParametersImport;
 539
 540 /// The recipient of a payment.
 541 #[must_use]
 542 #[repr(C)]
 543 pub struct PaymentParameters {
 544         /// A pointer to the opaque Rust object.
 545
 546         /// Nearly everywhere, inner must be non-null, however in places where
 547         /// the Rust equivalent takes an Option, it may be set to null to indicate None.
 548         pub inner: *mut nativePaymentParameters,
 549         /// Indicates that this is the only struct which contains the same pointer.
 550
 551         /// Rust functions which take ownership of an object provided via an argument require
 552         /// this to be true and invalidate the object pointed to by inner.
 553         pub is_owned: bool,
 554 }
 555
 556 impl Drop for PaymentParameters {
 557         fn drop(&mut self) {
 558                 if self.is_owned && !<*mut nativePaymentParameters>::is_null(self.inner) {
 559                         let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
 560                 }
 561         }
 562 }
 563 /// Frees any resources used by the PaymentParameters, if is_owned is set and inner is non-NULL.
 564 #[no_mangle]
 565 pub extern "C" fn PaymentParameters_free(this_obj: PaymentParameters) { }
 566 #[allow(unused)]
 567 /// Used only if an object of this type is returned as a trait impl by a method
 568 pub(crate) extern "C" fn PaymentParameters_free_void(this_ptr: *mut c_void) {
 569         unsafe { let _ = Box::from_raw(this_ptr as *mut nativePaymentParameters); }
 570 }
 571 #[allow(unused)]
 572 impl PaymentParameters {
 573         pub(crate) fn get_native_ref(&self) -> &'static nativePaymentParameters {
 574                 unsafe { &*ObjOps::untweak_ptr(self.inner) }
 575         }
 576         pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativePaymentParameters {
 577                 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
 578         }
 579         /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
 580         pub(crate) fn take_inner(mut self) -> *mut nativePaymentParameters {
 581                 assert!(self.is_owned);
 582                 let ret = ObjOps::untweak_ptr(self.inner);
 583                 self.inner = core::ptr::null_mut();
 584                 ret
 585         }
 586 }
 587 /// The node id of the payee.
 588 #[no_mangle]
 589 pub extern "C" fn PaymentParameters_get_payee_pubkey(this_ptr: &PaymentParameters) -> crate::c_types::PublicKey {
 590         let mut inner_val = &mut this_ptr.get_native_mut_ref().payee_pubkey;
 591         crate::c_types::PublicKey::from_rust(&inner_val)
 592 }
 593 /// The node id of the payee.
 594 #[no_mangle]
 595 pub extern "C" fn PaymentParameters_set_payee_pubkey(this_ptr: &mut PaymentParameters, mut val: crate::c_types::PublicKey) {
 596         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.payee_pubkey = val.into_rust();
 597 }
 598 /// Features supported by the payee.
 599 ///
 600 /// May be set from the payee's invoice or via [`for_keysend`]. May be `None` if the invoice
 601 /// does not contain any features.
 602 ///
 603 /// [`for_keysend`]: Self::for_keysend
 604 ///
 605 /// Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
 606 #[no_mangle]
 607 pub extern "C" fn PaymentParameters_get_features(this_ptr: &PaymentParameters) -> crate::lightning::ln::features::InvoiceFeatures {
 608         let mut inner_val = &mut this_ptr.get_native_mut_ref().features;
 609         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 };
 610         local_inner_val
 611 }
 612 /// Features supported by the payee.
 613 ///
 614 /// May be set from the payee's invoice or via [`for_keysend`]. May be `None` if the invoice
 615 /// does not contain any features.
 616 ///
 617 /// [`for_keysend`]: Self::for_keysend
 618 ///
 619 /// Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
 620 #[no_mangle]
 621 pub extern "C" fn PaymentParameters_set_features(this_ptr: &mut PaymentParameters, mut val: crate::lightning::ln::features::InvoiceFeatures) {
 622         let mut local_val = if val.inner.is_null() { None } else { Some( { *unsafe { Box::from_raw(val.take_inner()) } }) };
 623         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.features = local_val;
 624 }
 625 /// Hints for routing to the payee, containing channels connecting the payee to public nodes.
 626 #[no_mangle]
 627 pub extern "C" fn PaymentParameters_get_route_hints(this_ptr: &PaymentParameters) -> crate::c_types::derived::CVec_RouteHintZ {
 628         let mut inner_val = &mut this_ptr.get_native_mut_ref().route_hints;
 629         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 } }); };
 630         local_inner_val.into()
 631 }
 632 /// Hints for routing to the payee, containing channels connecting the payee to public nodes.
 633 #[no_mangle]
 634 pub extern "C" fn PaymentParameters_set_route_hints(this_ptr: &mut PaymentParameters, mut val: crate::c_types::derived::CVec_RouteHintZ) {
 635         let mut local_val = Vec::new(); for mut item in val.into_rust().drain(..) { local_val.push( { *unsafe { Box::from_raw(item.take_inner()) } }); };
 636         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.route_hints = local_val;
 637 }
 638 /// Expiration of a payment to the payee, in seconds relative to the UNIX epoch.
 639 #[no_mangle]
 640 pub extern "C" fn PaymentParameters_get_expiry_time(this_ptr: &PaymentParameters) -> crate::c_types::derived::COption_u64Z {
 641         let mut inner_val = &mut this_ptr.get_native_mut_ref().expiry_time;
 642         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() }) };
 643         local_inner_val
 644 }
 645 /// Expiration of a payment to the payee, in seconds relative to the UNIX epoch.
 646 #[no_mangle]
 647 pub extern "C" fn PaymentParameters_set_expiry_time(this_ptr: &mut PaymentParameters, mut val: crate::c_types::derived::COption_u64Z) {
 648         let mut local_val = if val.is_some() { Some( { val.take() }) } else { None };
 649         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.expiry_time = local_val;
 650 }
 651 /// The maximum total CLTV delta we accept for the route.
 652 #[no_mangle]
 653 pub extern "C" fn PaymentParameters_get_max_total_cltv_expiry_delta(this_ptr: &PaymentParameters) -> u32 {
 654         let mut inner_val = &mut this_ptr.get_native_mut_ref().max_total_cltv_expiry_delta;
 655         *inner_val
 656 }
 657 /// The maximum total CLTV delta we accept for the route.
 658 #[no_mangle]
 659 pub extern "C" fn PaymentParameters_set_max_total_cltv_expiry_delta(this_ptr: &mut PaymentParameters, mut val: u32) {
 660         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.max_total_cltv_expiry_delta = val;
 661 }
 662 /// Constructs a new PaymentParameters given each field
 663 #[must_use]
 664 #[no_mangle]
 665 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) -> PaymentParameters {
 666         let mut local_features_arg = if features_arg.inner.is_null() { None } else { Some( { *unsafe { Box::from_raw(features_arg.take_inner()) } }) };
 667         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()) } }); };
 668         let mut local_expiry_time_arg = if expiry_time_arg.is_some() { Some( { expiry_time_arg.take() }) } else { None };
 669         PaymentParameters { inner: ObjOps::heap_alloc(nativePaymentParameters {
 670                 payee_pubkey: payee_pubkey_arg.into_rust(),
 671                 features: local_features_arg,
 672                 route_hints: local_route_hints_arg,
 673                 expiry_time: local_expiry_time_arg,
 674                 max_total_cltv_expiry_delta: max_total_cltv_expiry_delta_arg,
 675         }), is_owned: true }
 676 }
 677 impl Clone for PaymentParameters {
 678         fn clone(&self) -> Self {
 679                 Self {
 680                         inner: if <*mut nativePaymentParameters>::is_null(self.inner) { core::ptr::null_mut() } else {
 681                                 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
 682                         is_owned: true,
 683                 }
 684         }
 685 }
 686 #[allow(unused)]
 687 /// Used only if an object of this type is returned as a trait impl by a method
 688 pub(crate) extern "C" fn PaymentParameters_clone_void(this_ptr: *const c_void) -> *mut c_void {
 689         Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativePaymentParameters)).clone() })) as *mut c_void
 690 }
 691 #[no_mangle]
 692 /// Creates a copy of the PaymentParameters
 693 pub extern "C" fn PaymentParameters_clone(orig: &PaymentParameters) -> PaymentParameters {
 694         orig.clone()
 695 }
 696 /// Checks if two PaymentParameterss contain equal inner contents.
 697 #[no_mangle]
 698 pub extern "C" fn PaymentParameters_hash(o: &PaymentParameters) -> u64 {
 699         if o.inner.is_null() { return 0; }
 700         // Note that we'd love to use alloc::collections::hash_map::DefaultHasher but it's not in core
 701         #[allow(deprecated)]
 702         let mut hasher = core::hash::SipHasher::new();
 703         core::hash::Hash::hash(o.get_native_ref(), &mut hasher);
 704         core::hash::Hasher::finish(&hasher)
 705 }
 706 /// Checks if two PaymentParameterss contain equal inner contents.
 707 /// This ignores pointers and is_owned flags and looks at the values in fields.
 708 /// Two objects with NULL inner values will be considered "equal" here.
 709 #[no_mangle]
 710 pub extern "C" fn PaymentParameters_eq(a: &PaymentParameters, b: &PaymentParameters) -> bool {
 711         if a.inner == b.inner { return true; }
 712         if a.inner.is_null() || b.inner.is_null() { return false; }
 713         if a.get_native_ref() == b.get_native_ref() { true } else { false }
 714 }
 715 #[no_mangle]
 716 /// Serialize the PaymentParameters object into a byte array which can be read by PaymentParameters_read
 717 pub extern "C" fn PaymentParameters_write(obj: &crate::lightning::routing::router::PaymentParameters) -> crate::c_types::derived::CVec_u8Z {
 718         crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
 719 }
 720 #[no_mangle]
 721 pub(crate) extern "C" fn PaymentParameters_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
 722         crate::c_types::serialize_obj(unsafe { &*(obj as *const nativePaymentParameters) })
 723 }
 724 #[no_mangle]
 725 /// Read a PaymentParameters from a byte array, created by PaymentParameters_write
 726 pub extern "C" fn PaymentParameters_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_PaymentParametersDecodeErrorZ {
 727         let res: Result<lightning::routing::router::PaymentParameters, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj(ser);
 728         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 { inner: ObjOps::heap_alloc(e), is_owned: true } }).into() };
 729         local_res
 730 }
 731 /// Creates a payee with the node id of the given `pubkey`.
 732 #[must_use]
 733 #[no_mangle]
 734 pub extern "C" fn PaymentParameters_from_node_id(mut payee_pubkey: crate::c_types::PublicKey) -> crate::lightning::routing::router::PaymentParameters {
 735         let mut ret = lightning::routing::router::PaymentParameters::from_node_id(payee_pubkey.into_rust());
 736         crate::lightning::routing::router::PaymentParameters { inner: ObjOps::heap_alloc(ret), is_owned: true }
 737 }
 738
 739 /// Creates a payee with the node id of the given `pubkey` to use for keysend payments.
 740 #[must_use]
 741 #[no_mangle]
 742 pub extern "C" fn PaymentParameters_for_keysend(mut payee_pubkey: crate::c_types::PublicKey) -> crate::lightning::routing::router::PaymentParameters {
 743         let mut ret = lightning::routing::router::PaymentParameters::for_keysend(payee_pubkey.into_rust());
 744         crate::lightning::routing::router::PaymentParameters { inner: ObjOps::heap_alloc(ret), is_owned: true }
 745 }
 746
 747
 748 use lightning::routing::router::RouteHint as nativeRouteHintImport;
 749 pub(crate) type nativeRouteHint = nativeRouteHintImport;
 750
 751 /// A list of hops along a payment path terminating with a channel to the recipient.
 752 #[must_use]
 753 #[repr(C)]
 754 pub struct RouteHint {
 755         /// A pointer to the opaque Rust object.
 756
 757         /// Nearly everywhere, inner must be non-null, however in places where
 758         /// the Rust equivalent takes an Option, it may be set to null to indicate None.
 759         pub inner: *mut nativeRouteHint,
 760         /// Indicates that this is the only struct which contains the same pointer.
 761
 762         /// Rust functions which take ownership of an object provided via an argument require
 763         /// this to be true and invalidate the object pointed to by inner.
 764         pub is_owned: bool,
 765 }
 766
 767 impl Drop for RouteHint {
 768         fn drop(&mut self) {
 769                 if self.is_owned && !<*mut nativeRouteHint>::is_null(self.inner) {
 770                         let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
 771                 }
 772         }
 773 }
 774 /// Frees any resources used by the RouteHint, if is_owned is set and inner is non-NULL.
 775 #[no_mangle]
 776 pub extern "C" fn RouteHint_free(this_obj: RouteHint) { }
 777 #[allow(unused)]
 778 /// Used only if an object of this type is returned as a trait impl by a method
 779 pub(crate) extern "C" fn RouteHint_free_void(this_ptr: *mut c_void) {
 780         unsafe { let _ = Box::from_raw(this_ptr as *mut nativeRouteHint); }
 781 }
 782 #[allow(unused)]
 783 impl RouteHint {
 784         pub(crate) fn get_native_ref(&self) -> &'static nativeRouteHint {
 785                 unsafe { &*ObjOps::untweak_ptr(self.inner) }
 786         }
 787         pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeRouteHint {
 788                 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
 789         }
 790         /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
 791         pub(crate) fn take_inner(mut self) -> *mut nativeRouteHint {
 792                 assert!(self.is_owned);
 793                 let ret = ObjOps::untweak_ptr(self.inner);
 794                 self.inner = core::ptr::null_mut();
 795                 ret
 796         }
 797 }
 798 #[no_mangle]
 799 pub extern "C" fn RouteHint_get_a(this_ptr: &RouteHint) -> crate::c_types::derived::CVec_RouteHintHopZ {
 800         let mut inner_val = &mut this_ptr.get_native_mut_ref().0;
 801         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 } }); };
 802         local_inner_val.into()
 803 }
 804 #[no_mangle]
 805 pub extern "C" fn RouteHint_set_a(this_ptr: &mut RouteHint, mut val: crate::c_types::derived::CVec_RouteHintHopZ) {
 806         let mut local_val = Vec::new(); for mut item in val.into_rust().drain(..) { local_val.push( { *unsafe { Box::from_raw(item.take_inner()) } }); };
 807         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.0 = local_val;
 808 }
 809 /// Constructs a new RouteHint given each field
 810 #[must_use]
 811 #[no_mangle]
 812 pub extern "C" fn RouteHint_new(mut a_arg: crate::c_types::derived::CVec_RouteHintHopZ) -> RouteHint {
 813         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()) } }); };
 814         RouteHint { inner: ObjOps::heap_alloc(lightning::routing::router::RouteHint (
 815                 local_a_arg,
 816         )), is_owned: true }
 817 }
 818 impl Clone for RouteHint {
 819         fn clone(&self) -> Self {
 820                 Self {
 821                         inner: if <*mut nativeRouteHint>::is_null(self.inner) { core::ptr::null_mut() } else {
 822                                 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
 823                         is_owned: true,
 824                 }
 825         }
 826 }
 827 #[allow(unused)]
 828 /// Used only if an object of this type is returned as a trait impl by a method
 829 pub(crate) extern "C" fn RouteHint_clone_void(this_ptr: *const c_void) -> *mut c_void {
 830         Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeRouteHint)).clone() })) as *mut c_void
 831 }
 832 #[no_mangle]
 833 /// Creates a copy of the RouteHint
 834 pub extern "C" fn RouteHint_clone(orig: &RouteHint) -> RouteHint {
 835         orig.clone()
 836 }
 837 /// Checks if two RouteHints contain equal inner contents.
 838 #[no_mangle]
 839 pub extern "C" fn RouteHint_hash(o: &RouteHint) -> u64 {
 840         if o.inner.is_null() { return 0; }
 841         // Note that we'd love to use alloc::collections::hash_map::DefaultHasher but it's not in core
 842         #[allow(deprecated)]
 843         let mut hasher = core::hash::SipHasher::new();
 844         core::hash::Hash::hash(o.get_native_ref(), &mut hasher);
 845         core::hash::Hasher::finish(&hasher)
 846 }
 847 /// Checks if two RouteHints contain equal inner contents.
 848 /// This ignores pointers and is_owned flags and looks at the values in fields.
 849 /// Two objects with NULL inner values will be considered "equal" here.
 850 #[no_mangle]
 851 pub extern "C" fn RouteHint_eq(a: &RouteHint, b: &RouteHint) -> bool {
 852         if a.inner == b.inner { return true; }
 853         if a.inner.is_null() || b.inner.is_null() { return false; }
 854         if a.get_native_ref() == b.get_native_ref() { true } else { false }
 855 }
 856 #[no_mangle]
 857 /// Serialize the RouteHint object into a byte array which can be read by RouteHint_read
 858 pub extern "C" fn RouteHint_write(obj: &crate::lightning::routing::router::RouteHint) -> crate::c_types::derived::CVec_u8Z {
 859         crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
 860 }
 861 #[no_mangle]
 862 pub(crate) extern "C" fn RouteHint_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
 863         crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeRouteHint) })
 864 }
 865 #[no_mangle]
 866 /// Read a RouteHint from a byte array, created by RouteHint_write
 867 pub extern "C" fn RouteHint_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_RouteHintDecodeErrorZ {
 868         let res: Result<lightning::routing::router::RouteHint, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj(ser);
 869         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 { inner: ObjOps::heap_alloc(e), is_owned: true } }).into() };
 870         local_res
 871 }
 872
 873 use lightning::routing::router::RouteHintHop as nativeRouteHintHopImport;
 874 pub(crate) type nativeRouteHintHop = nativeRouteHintHopImport;
 875
 876 /// A channel descriptor for a hop along a payment path.
 877 #[must_use]
 878 #[repr(C)]
 879 pub struct RouteHintHop {
 880         /// A pointer to the opaque Rust object.
 881
 882         /// Nearly everywhere, inner must be non-null, however in places where
 883         /// the Rust equivalent takes an Option, it may be set to null to indicate None.
 884         pub inner: *mut nativeRouteHintHop,
 885         /// Indicates that this is the only struct which contains the same pointer.
 886
 887         /// Rust functions which take ownership of an object provided via an argument require
 888         /// this to be true and invalidate the object pointed to by inner.
 889         pub is_owned: bool,
 890 }
 891
 892 impl Drop for RouteHintHop {
 893         fn drop(&mut self) {
 894                 if self.is_owned && !<*mut nativeRouteHintHop>::is_null(self.inner) {
 895                         let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
 896                 }
 897         }
 898 }
 899 /// Frees any resources used by the RouteHintHop, if is_owned is set and inner is non-NULL.
 900 #[no_mangle]
 901 pub extern "C" fn RouteHintHop_free(this_obj: RouteHintHop) { }
 902 #[allow(unused)]
 903 /// Used only if an object of this type is returned as a trait impl by a method
 904 pub(crate) extern "C" fn RouteHintHop_free_void(this_ptr: *mut c_void) {
 905         unsafe { let _ = Box::from_raw(this_ptr as *mut nativeRouteHintHop); }
 906 }
 907 #[allow(unused)]
 908 impl RouteHintHop {
 909         pub(crate) fn get_native_ref(&self) -> &'static nativeRouteHintHop {
 910                 unsafe { &*ObjOps::untweak_ptr(self.inner) }
 911         }
 912         pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeRouteHintHop {
 913                 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
 914         }
 915         /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
 916         pub(crate) fn take_inner(mut self) -> *mut nativeRouteHintHop {
 917                 assert!(self.is_owned);
 918                 let ret = ObjOps::untweak_ptr(self.inner);
 919                 self.inner = core::ptr::null_mut();
 920                 ret
 921         }
 922 }
 923 /// The node_id of the non-target end of the route
 924 #[no_mangle]
 925 pub extern "C" fn RouteHintHop_get_src_node_id(this_ptr: &RouteHintHop) -> crate::c_types::PublicKey {
 926         let mut inner_val = &mut this_ptr.get_native_mut_ref().src_node_id;
 927         crate::c_types::PublicKey::from_rust(&inner_val)
 928 }
 929 /// The node_id of the non-target end of the route
 930 #[no_mangle]
 931 pub extern "C" fn RouteHintHop_set_src_node_id(this_ptr: &mut RouteHintHop, mut val: crate::c_types::PublicKey) {
 932         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.src_node_id = val.into_rust();
 933 }
 934 /// The short_channel_id of this channel
 935 #[no_mangle]
 936 pub extern "C" fn RouteHintHop_get_short_channel_id(this_ptr: &RouteHintHop) -> u64 {
 937         let mut inner_val = &mut this_ptr.get_native_mut_ref().short_channel_id;
 938         *inner_val
 939 }
 940 /// The short_channel_id of this channel
 941 #[no_mangle]
 942 pub extern "C" fn RouteHintHop_set_short_channel_id(this_ptr: &mut RouteHintHop, mut val: u64) {
 943         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.short_channel_id = val;
 944 }
 945 /// The fees which must be paid to use this channel
 946 #[no_mangle]
 947 pub extern "C" fn RouteHintHop_get_fees(this_ptr: &RouteHintHop) -> crate::lightning::routing::gossip::RoutingFees {
 948         let mut inner_val = &mut this_ptr.get_native_mut_ref().fees;
 949         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 }
 950 }
 951 /// The fees which must be paid to use this channel
 952 #[no_mangle]
 953 pub extern "C" fn RouteHintHop_set_fees(this_ptr: &mut RouteHintHop, mut val: crate::lightning::routing::gossip::RoutingFees) {
 954         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.fees = *unsafe { Box::from_raw(val.take_inner()) };
 955 }
 956 /// The difference in CLTV values between this node and the next node.
 957 #[no_mangle]
 958 pub extern "C" fn RouteHintHop_get_cltv_expiry_delta(this_ptr: &RouteHintHop) -> u16 {
 959         let mut inner_val = &mut this_ptr.get_native_mut_ref().cltv_expiry_delta;
 960         *inner_val
 961 }
 962 /// The difference in CLTV values between this node and the next node.
 963 #[no_mangle]
 964 pub extern "C" fn RouteHintHop_set_cltv_expiry_delta(this_ptr: &mut RouteHintHop, mut val: u16) {
 965         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.cltv_expiry_delta = val;
 966 }
 967 /// The minimum value, in msat, which must be relayed to the next hop.
 968 #[no_mangle]
 969 pub extern "C" fn RouteHintHop_get_htlc_minimum_msat(this_ptr: &RouteHintHop) -> crate::c_types::derived::COption_u64Z {
 970         let mut inner_val = &mut this_ptr.get_native_mut_ref().htlc_minimum_msat;
 971         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() }) };
 972         local_inner_val
 973 }
 974 /// The minimum value, in msat, which must be relayed to the next hop.
 975 #[no_mangle]
 976 pub extern "C" fn RouteHintHop_set_htlc_minimum_msat(this_ptr: &mut RouteHintHop, mut val: crate::c_types::derived::COption_u64Z) {
 977         let mut local_val = if val.is_some() { Some( { val.take() }) } else { None };
 978         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.htlc_minimum_msat = local_val;
 979 }
 980 /// The maximum value in msat available for routing with a single HTLC.
 981 #[no_mangle]
 982 pub extern "C" fn RouteHintHop_get_htlc_maximum_msat(this_ptr: &RouteHintHop) -> crate::c_types::derived::COption_u64Z {
 983         let mut inner_val = &mut this_ptr.get_native_mut_ref().htlc_maximum_msat;
 984         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() }) };
 985         local_inner_val
 986 }
 987 /// The maximum value in msat available for routing with a single HTLC.
 988 #[no_mangle]
 989 pub extern "C" fn RouteHintHop_set_htlc_maximum_msat(this_ptr: &mut RouteHintHop, mut val: crate::c_types::derived::COption_u64Z) {
 990         let mut local_val = if val.is_some() { Some( { val.take() }) } else { None };
 991         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.htlc_maximum_msat = local_val;
 992 }
 993 /// Constructs a new RouteHintHop given each field
 994 #[must_use]
 995 #[no_mangle]
 996 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 {
 997         let mut local_htlc_minimum_msat_arg = if htlc_minimum_msat_arg.is_some() { Some( { htlc_minimum_msat_arg.take() }) } else { None };
 998         let mut local_htlc_maximum_msat_arg = if htlc_maximum_msat_arg.is_some() { Some( { htlc_maximum_msat_arg.take() }) } else { None };
 999         RouteHintHop { inner: ObjOps::heap_alloc(nativeRouteHintHop {
1000                 src_node_id: src_node_id_arg.into_rust(),
1001                 short_channel_id: short_channel_id_arg,
1002                 fees: *unsafe { Box::from_raw(fees_arg.take_inner()) },
1003                 cltv_expiry_delta: cltv_expiry_delta_arg,
1004                 htlc_minimum_msat: local_htlc_minimum_msat_arg,
1005                 htlc_maximum_msat: local_htlc_maximum_msat_arg,
1006         }), is_owned: true }
1007 }
1008 impl Clone for RouteHintHop {
1009         fn clone(&self) -> Self {
1010                 Self {
1011                         inner: if <*mut nativeRouteHintHop>::is_null(self.inner) { core::ptr::null_mut() } else {
1012                                 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
1013                         is_owned: true,
1014                 }
1015         }
1016 }
1017 #[allow(unused)]
1018 /// Used only if an object of this type is returned as a trait impl by a method
1019 pub(crate) extern "C" fn RouteHintHop_clone_void(this_ptr: *const c_void) -> *mut c_void {
1020         Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeRouteHintHop)).clone() })) as *mut c_void
1021 }
1022 #[no_mangle]
1023 /// Creates a copy of the RouteHintHop
1024 pub extern "C" fn RouteHintHop_clone(orig: &RouteHintHop) -> RouteHintHop {
1025         orig.clone()
1026 }
1027 /// Checks if two RouteHintHops contain equal inner contents.
1028 #[no_mangle]
1029 pub extern "C" fn RouteHintHop_hash(o: &RouteHintHop) -> u64 {
1030         if o.inner.is_null() { return 0; }
1031         // Note that we'd love to use alloc::collections::hash_map::DefaultHasher but it's not in core
1032         #[allow(deprecated)]
1033         let mut hasher = core::hash::SipHasher::new();
1034         core::hash::Hash::hash(o.get_native_ref(), &mut hasher);
1035         core::hash::Hasher::finish(&hasher)
1036 }
1037 /// Checks if two RouteHintHops contain equal inner contents.
1038 /// This ignores pointers and is_owned flags and looks at the values in fields.
1039 /// Two objects with NULL inner values will be considered "equal" here.
1040 #[no_mangle]
1041 pub extern "C" fn RouteHintHop_eq(a: &RouteHintHop, b: &RouteHintHop) -> bool {
1042         if a.inner == b.inner { return true; }
1043         if a.inner.is_null() || b.inner.is_null() { return false; }
1044         if a.get_native_ref() == b.get_native_ref() { true } else { false }
1045 }
1046 #[no_mangle]
1047 /// Serialize the RouteHintHop object into a byte array which can be read by RouteHintHop_read
1048 pub extern "C" fn RouteHintHop_write(obj: &crate::lightning::routing::router::RouteHintHop) -> crate::c_types::derived::CVec_u8Z {
1049         crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
1050 }
1051 #[no_mangle]
1052 pub(crate) extern "C" fn RouteHintHop_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
1053         crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeRouteHintHop) })
1054 }
1055 #[no_mangle]
1056 /// Read a RouteHintHop from a byte array, created by RouteHintHop_write
1057 pub extern "C" fn RouteHintHop_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_RouteHintHopDecodeErrorZ {
1058         let res: Result<lightning::routing::router::RouteHintHop, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj(ser);
1059         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 { inner: ObjOps::heap_alloc(e), is_owned: true } }).into() };
1060         local_res
1061 }
1062 /// Finds a route from us (payer) to the given target node (payee).
1063 ///
1064 /// If the payee provided features in their invoice, they should be provided via `params.payee`.
1065 /// Without this, MPP will only be used if the payee's features are available in the network graph.
1066 ///
1067 /// Private routing paths between a public node and the target may be included in `params.payee`.
1068 ///
1069 /// If some channels aren't announced, it may be useful to fill in `first_hops` with the results
1070 /// from [`ChannelManager::list_usable_channels`]. If it is filled in, the view of these channels
1071 /// from `network_graph` will be ignored, and only those in `first_hops` will be used.
1072 ///
1073 /// The fees on channels from us to the next hop are ignored as they are assumed to all be equal.
1074 /// However, the enabled/disabled bit on such channels as well as the `htlc_minimum_msat` /
1075 /// `htlc_maximum_msat` *are* checked as they may change based on the receiving node.
1076 ///
1077 /// # Note
1078 ///
1079 /// May be used to re-compute a [`Route`] when handling a [`Event::PaymentPathFailed`]. Any
1080 /// adjustments to the [`NetworkGraph`] and channel scores should be made prior to calling this
1081 /// function.
1082 ///
1083 /// # Panics
1084 ///
1085 /// Panics if first_hops contains channels without short_channel_ids;
1086 /// [`ChannelManager::list_usable_channels`] will never include such channels.
1087 ///
1088 /// [`ChannelManager::list_usable_channels`]: crate::ln::channelmanager::ChannelManager::list_usable_channels
1089 /// [`Event::PaymentPathFailed`]: crate::util::events::Event::PaymentPathFailed
1090 /// [`NetworkGraph`]: crate::routing::gossip::NetworkGraph
1091 ///
1092 /// Note that first_hops (or a relevant inner pointer) may be NULL or all-0s to represent None
1093 #[no_mangle]
1094 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::ReadOnlyNetworkGraph, 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 {
1095         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[..]);
1096         let mut ret = lightning::routing::router::find_route::<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});
1097         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() };
1098         local_ret
1099 }
1100
1101 /// Construct a route from us (payer) to the target node (payee) via the given hops (which should
1102 /// exclude the payer, but include the payee). This may be useful, e.g., for probing the chosen path.
1103 ///
1104 /// Re-uses logic from `find_route`, so the restrictions described there also apply here.
1105 #[no_mangle]
1106 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::ReadOnlyNetworkGraph, mut logger: crate::lightning::util::logger::Logger, random_seed_bytes: *const [u8; 32]) -> crate::c_types::derived::CResult_RouteLightningErrorZ {
1107         let mut local_hops = Vec::new(); for mut item in hops.into_rust().drain(..) { local_hops.push( { item.into_rust() }); };
1108         let mut ret = lightning::routing::router::build_route_from_hops::<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});
1109         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() };
1110         local_ret
1111 }
1112