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

   1 //! The top-level routing/network map tracking logic lives here.
   2 //!
   3 //! You probably want to create a NetGraphMsgHandler and use that as your RoutingMessageHandler and then
   4 //! interrogate it to get routes for your own payments.
   5
   6 use std::ffi::c_void;
   7 use bitcoin::hashes::Hash;
   8 use crate::c_types::*;
   9
  10
  11 use lightning::routing::router::RouteHop as nativeRouteHopImport;
  12 type nativeRouteHop = nativeRouteHopImport;
  13
  14 /// A hop in a route
  15 #[must_use]
  16 #[repr(C)]
  17 pub struct RouteHop {
  18         /// A pointer to the opaque Rust object.
  19
  20         /// Nearly everywhere, inner must be non-null, however in places where
  21         /// the Rust equivalent takes an Option, it may be set to null to indicate None.
  22         pub inner: *mut nativeRouteHop,
  23         /// Indicates that this is the only struct which contains the same pointer.
  24
  25         /// Rust functions which take ownership of an object provided via an argument require
  26         /// this to be true and invalidate the object pointed to by inner.
  27         pub is_owned: bool,
  28 }
  29
  30 impl Drop for RouteHop {
  31         fn drop(&mut self) {
  32                 if self.is_owned && !<*mut nativeRouteHop>::is_null(self.inner) {
  33                         let _ = unsafe { Box::from_raw(self.inner) };
  34                 }
  35         }
  36 }
  37 /// Frees any resources used by the RouteHop, if is_owned is set and inner is non-NULL.
  38 #[no_mangle]
  39 pub extern "C" fn RouteHop_free(this_obj: RouteHop) { }
  40 #[allow(unused)]
  41 /// Used only if an object of this type is returned as a trait impl by a method
  42 extern "C" fn RouteHop_free_void(this_ptr: *mut c_void) {
  43         unsafe { let _ = Box::from_raw(this_ptr as *mut nativeRouteHop); }
  44 }
  45 #[allow(unused)]
  46 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
  47 impl RouteHop {
  48         pub(crate) fn take_inner(mut self) -> *mut nativeRouteHop {
  49                 assert!(self.is_owned);
  50                 let ret = self.inner;
  51                 self.inner = std::ptr::null_mut();
  52                 ret
  53         }
  54 }
  55 /// The node_id of the node at this hop.
  56 #[no_mangle]
  57 pub extern "C" fn RouteHop_get_pubkey(this_ptr: &RouteHop) -> crate::c_types::PublicKey {
  58         let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.pubkey;
  59         crate::c_types::PublicKey::from_rust(&(*inner_val))
  60 }
  61 /// The node_id of the node at this hop.
  62 #[no_mangle]
  63 pub extern "C" fn RouteHop_set_pubkey(this_ptr: &mut RouteHop, mut val: crate::c_types::PublicKey) {
  64         unsafe { &mut *this_ptr.inner }.pubkey = val.into_rust();
  65 }
  66 /// The node_announcement features of the node at this hop. For the last hop, these may be
  67 /// amended to match the features present in the invoice this node generated.
  68 #[no_mangle]
  69 pub extern "C" fn RouteHop_get_node_features(this_ptr: &RouteHop) -> crate::ln::features::NodeFeatures {
  70         let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.node_features;
  71         crate::ln::features::NodeFeatures { inner: unsafe { ( (&((*inner_val)) as *const _) as *mut _) }, is_owned: false }
  72 }
  73 /// The node_announcement features of the node at this hop. For the last hop, these may be
  74 /// amended to match the features present in the invoice this node generated.
  75 #[no_mangle]
  76 pub extern "C" fn RouteHop_set_node_features(this_ptr: &mut RouteHop, mut val: crate::ln::features::NodeFeatures) {
  77         unsafe { &mut *this_ptr.inner }.node_features = *unsafe { Box::from_raw(val.take_inner()) };
  78 }
  79 /// The channel that should be used from the previous hop to reach this node.
  80 #[no_mangle]
  81 pub extern "C" fn RouteHop_get_short_channel_id(this_ptr: &RouteHop) -> u64 {
  82         let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.short_channel_id;
  83         (*inner_val)
  84 }
  85 /// The channel that should be used from the previous hop to reach this node.
  86 #[no_mangle]
  87 pub extern "C" fn RouteHop_set_short_channel_id(this_ptr: &mut RouteHop, mut val: u64) {
  88         unsafe { &mut *this_ptr.inner }.short_channel_id = val;
  89 }
  90 /// The channel_announcement features of the channel that should be used from the previous hop
  91 /// to reach this node.
  92 #[no_mangle]
  93 pub extern "C" fn RouteHop_get_channel_features(this_ptr: &RouteHop) -> crate::ln::features::ChannelFeatures {
  94         let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.channel_features;
  95         crate::ln::features::ChannelFeatures { inner: unsafe { ( (&((*inner_val)) as *const _) as *mut _) }, is_owned: false }
  96 }
  97 /// The channel_announcement features of the channel that should be used from the previous hop
  98 /// to reach this node.
  99 #[no_mangle]
 100 pub extern "C" fn RouteHop_set_channel_features(this_ptr: &mut RouteHop, mut val: crate::ln::features::ChannelFeatures) {
 101         unsafe { &mut *this_ptr.inner }.channel_features = *unsafe { Box::from_raw(val.take_inner()) };
 102 }
 103 /// The fee taken on this hop (for paying for the use of the *next* channel in the path).
 104 /// For the last hop, this should be the full value of the payment (might be more than
 105 /// requested if we had to match htlc_minimum_msat).
 106 #[no_mangle]
 107 pub extern "C" fn RouteHop_get_fee_msat(this_ptr: &RouteHop) -> u64 {
 108         let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.fee_msat;
 109         (*inner_val)
 110 }
 111 /// The fee taken on this hop (for paying for the use of the *next* channel in the path).
 112 /// For the last hop, this should be the full value of the payment (might be more than
 113 /// requested if we had to match htlc_minimum_msat).
 114 #[no_mangle]
 115 pub extern "C" fn RouteHop_set_fee_msat(this_ptr: &mut RouteHop, mut val: u64) {
 116         unsafe { &mut *this_ptr.inner }.fee_msat = val;
 117 }
 118 /// The CLTV delta added for this hop. For the last hop, this should be the full CLTV value
 119 /// expected at the destination, in excess of the current block height.
 120 #[no_mangle]
 121 pub extern "C" fn RouteHop_get_cltv_expiry_delta(this_ptr: &RouteHop) -> u32 {
 122         let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.cltv_expiry_delta;
 123         (*inner_val)
 124 }
 125 /// The CLTV delta added for this hop. For the last hop, this should be the full CLTV value
 126 /// expected at the destination, in excess of the current block height.
 127 #[no_mangle]
 128 pub extern "C" fn RouteHop_set_cltv_expiry_delta(this_ptr: &mut RouteHop, mut val: u32) {
 129         unsafe { &mut *this_ptr.inner }.cltv_expiry_delta = val;
 130 }
 131 /// Constructs a new RouteHop given each field
 132 #[must_use]
 133 #[no_mangle]
 134 pub extern "C" fn RouteHop_new(mut pubkey_arg: crate::c_types::PublicKey, mut node_features_arg: crate::ln::features::NodeFeatures, mut short_channel_id_arg: u64, mut channel_features_arg: crate::ln::features::ChannelFeatures, mut fee_msat_arg: u64, mut cltv_expiry_delta_arg: u32) -> RouteHop {
 135         RouteHop { inner: Box::into_raw(Box::new(nativeRouteHop {
 136                 pubkey: pubkey_arg.into_rust(),
 137                 node_features: *unsafe { Box::from_raw(node_features_arg.take_inner()) },
 138                 short_channel_id: short_channel_id_arg,
 139                 channel_features: *unsafe { Box::from_raw(channel_features_arg.take_inner()) },
 140                 fee_msat: fee_msat_arg,
 141                 cltv_expiry_delta: cltv_expiry_delta_arg,
 142         })), is_owned: true }
 143 }
 144 impl Clone for RouteHop {
 145         fn clone(&self) -> Self {
 146                 Self {
 147                         inner: if <*mut nativeRouteHop>::is_null(self.inner) { std::ptr::null_mut() } else {
 148                                 Box::into_raw(Box::new(unsafe { &*self.inner }.clone())) },
 149                         is_owned: true,
 150                 }
 151         }
 152 }
 153 #[allow(unused)]
 154 /// Used only if an object of this type is returned as a trait impl by a method
 155 pub(crate) extern "C" fn RouteHop_clone_void(this_ptr: *const c_void) -> *mut c_void {
 156         Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeRouteHop)).clone() })) as *mut c_void
 157 }
 158 #[no_mangle]
 159 /// Creates a copy of the RouteHop
 160 pub extern "C" fn RouteHop_clone(orig: &RouteHop) -> RouteHop {
 161         orig.clone()
 162 }
 163
 164 use lightning::routing::router::Route as nativeRouteImport;
 165 type nativeRoute = nativeRouteImport;
 166
 167 /// A route directs a payment from the sender (us) to the recipient. If the recipient supports MPP,
 168 /// it can take multiple paths. Each path is composed of one or more hops through the network.
 169 #[must_use]
 170 #[repr(C)]
 171 pub struct Route {
 172         /// A pointer to the opaque Rust object.
 173
 174         /// Nearly everywhere, inner must be non-null, however in places where
 175         /// the Rust equivalent takes an Option, it may be set to null to indicate None.
 176         pub inner: *mut nativeRoute,
 177         /// Indicates that this is the only struct which contains the same pointer.
 178
 179         /// Rust functions which take ownership of an object provided via an argument require
 180         /// this to be true and invalidate the object pointed to by inner.
 181         pub is_owned: bool,
 182 }
 183
 184 impl Drop for Route {
 185         fn drop(&mut self) {
 186                 if self.is_owned && !<*mut nativeRoute>::is_null(self.inner) {
 187                         let _ = unsafe { Box::from_raw(self.inner) };
 188                 }
 189         }
 190 }
 191 /// Frees any resources used by the Route, if is_owned is set and inner is non-NULL.
 192 #[no_mangle]
 193 pub extern "C" fn Route_free(this_obj: Route) { }
 194 #[allow(unused)]
 195 /// Used only if an object of this type is returned as a trait impl by a method
 196 extern "C" fn Route_free_void(this_ptr: *mut c_void) {
 197         unsafe { let _ = Box::from_raw(this_ptr as *mut nativeRoute); }
 198 }
 199 #[allow(unused)]
 200 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
 201 impl Route {
 202         pub(crate) fn take_inner(mut self) -> *mut nativeRoute {
 203                 assert!(self.is_owned);
 204                 let ret = self.inner;
 205                 self.inner = std::ptr::null_mut();
 206                 ret
 207         }
 208 }
 209 /// The list of routes taken for a single (potentially-)multi-part payment. The pubkey of the
 210 /// last RouteHop in each path must be the same.
 211 /// Each entry represents a list of hops, NOT INCLUDING our own, where the last hop is the
 212 /// destination. Thus, this must always be at least length one. While the maximum length of any
 213 /// given path is variable, keeping the length of any path to less than 20 should currently
 214 /// ensure it is viable.
 215 #[no_mangle]
 216 pub extern "C" fn Route_set_paths(this_ptr: &mut Route, mut val: crate::c_types::derived::CVec_CVec_RouteHopZZ) {
 217         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 }); };
 218         unsafe { &mut *this_ptr.inner }.paths = local_val;
 219 }
 220 /// Constructs a new Route given each field
 221 #[must_use]
 222 #[no_mangle]
 223 pub extern "C" fn Route_new(mut paths_arg: crate::c_types::derived::CVec_CVec_RouteHopZZ) -> Route {
 224         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 }); };
 225         Route { inner: Box::into_raw(Box::new(nativeRoute {
 226                 paths: local_paths_arg,
 227         })), is_owned: true }
 228 }
 229 impl Clone for Route {
 230         fn clone(&self) -> Self {
 231                 Self {
 232                         inner: if <*mut nativeRoute>::is_null(self.inner) { std::ptr::null_mut() } else {
 233                                 Box::into_raw(Box::new(unsafe { &*self.inner }.clone())) },
 234                         is_owned: true,
 235                 }
 236         }
 237 }
 238 #[allow(unused)]
 239 /// Used only if an object of this type is returned as a trait impl by a method
 240 pub(crate) extern "C" fn Route_clone_void(this_ptr: *const c_void) -> *mut c_void {
 241         Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeRoute)).clone() })) as *mut c_void
 242 }
 243 #[no_mangle]
 244 /// Creates a copy of the Route
 245 pub extern "C" fn Route_clone(orig: &Route) -> Route {
 246         orig.clone()
 247 }
 248 #[no_mangle]
 249 /// Serialize the Route object into a byte array which can be read by Route_read
 250 pub extern "C" fn Route_write(obj: &Route) -> crate::c_types::derived::CVec_u8Z {
 251         crate::c_types::serialize_obj(unsafe { &*unsafe { &*obj }.inner })
 252 }
 253 #[no_mangle]
 254 pub(crate) extern "C" fn Route_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
 255         crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeRoute) })
 256 }
 257 #[no_mangle]
 258 /// Read a Route from a byte array, created by Route_write
 259 pub extern "C" fn Route_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_RouteDecodeErrorZ {
 260         let res = crate::c_types::deserialize_obj(ser);
 261         let mut local_res = match res { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::routing::router::Route { inner: Box::into_raw(Box::new(o)), is_owned: true } }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::ln::msgs::DecodeError { inner: Box::into_raw(Box::new(e)), is_owned: true } }).into() };
 262         local_res
 263 }
 264
 265 use lightning::routing::router::RouteHint as nativeRouteHintImport;
 266 type nativeRouteHint = nativeRouteHintImport;
 267
 268 /// A channel descriptor which provides a last-hop route to get_route
 269 #[must_use]
 270 #[repr(C)]
 271 pub struct RouteHint {
 272         /// A pointer to the opaque Rust object.
 273
 274         /// Nearly everywhere, inner must be non-null, however in places where
 275         /// the Rust equivalent takes an Option, it may be set to null to indicate None.
 276         pub inner: *mut nativeRouteHint,
 277         /// Indicates that this is the only struct which contains the same pointer.
 278
 279         /// Rust functions which take ownership of an object provided via an argument require
 280         /// this to be true and invalidate the object pointed to by inner.
 281         pub is_owned: bool,
 282 }
 283
 284 impl Drop for RouteHint {
 285         fn drop(&mut self) {
 286                 if self.is_owned && !<*mut nativeRouteHint>::is_null(self.inner) {
 287                         let _ = unsafe { Box::from_raw(self.inner) };
 288                 }
 289         }
 290 }
 291 /// Frees any resources used by the RouteHint, if is_owned is set and inner is non-NULL.
 292 #[no_mangle]
 293 pub extern "C" fn RouteHint_free(this_obj: RouteHint) { }
 294 #[allow(unused)]
 295 /// Used only if an object of this type is returned as a trait impl by a method
 296 extern "C" fn RouteHint_free_void(this_ptr: *mut c_void) {
 297         unsafe { let _ = Box::from_raw(this_ptr as *mut nativeRouteHint); }
 298 }
 299 #[allow(unused)]
 300 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
 301 impl RouteHint {
 302         pub(crate) fn take_inner(mut self) -> *mut nativeRouteHint {
 303                 assert!(self.is_owned);
 304                 let ret = self.inner;
 305                 self.inner = std::ptr::null_mut();
 306                 ret
 307         }
 308 }
 309 /// The node_id of the non-target end of the route
 310 #[no_mangle]
 311 pub extern "C" fn RouteHint_get_src_node_id(this_ptr: &RouteHint) -> crate::c_types::PublicKey {
 312         let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.src_node_id;
 313         crate::c_types::PublicKey::from_rust(&(*inner_val))
 314 }
 315 /// The node_id of the non-target end of the route
 316 #[no_mangle]
 317 pub extern "C" fn RouteHint_set_src_node_id(this_ptr: &mut RouteHint, mut val: crate::c_types::PublicKey) {
 318         unsafe { &mut *this_ptr.inner }.src_node_id = val.into_rust();
 319 }
 320 /// The short_channel_id of this channel
 321 #[no_mangle]
 322 pub extern "C" fn RouteHint_get_short_channel_id(this_ptr: &RouteHint) -> u64 {
 323         let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.short_channel_id;
 324         (*inner_val)
 325 }
 326 /// The short_channel_id of this channel
 327 #[no_mangle]
 328 pub extern "C" fn RouteHint_set_short_channel_id(this_ptr: &mut RouteHint, mut val: u64) {
 329         unsafe { &mut *this_ptr.inner }.short_channel_id = val;
 330 }
 331 /// The fees which must be paid to use this channel
 332 #[no_mangle]
 333 pub extern "C" fn RouteHint_get_fees(this_ptr: &RouteHint) -> crate::routing::network_graph::RoutingFees {
 334         let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.fees;
 335         crate::routing::network_graph::RoutingFees { inner: unsafe { ( (&((*inner_val)) as *const _) as *mut _) }, is_owned: false }
 336 }
 337 /// The fees which must be paid to use this channel
 338 #[no_mangle]
 339 pub extern "C" fn RouteHint_set_fees(this_ptr: &mut RouteHint, mut val: crate::routing::network_graph::RoutingFees) {
 340         unsafe { &mut *this_ptr.inner }.fees = *unsafe { Box::from_raw(val.take_inner()) };
 341 }
 342 /// The difference in CLTV values between this node and the next node.
 343 #[no_mangle]
 344 pub extern "C" fn RouteHint_get_cltv_expiry_delta(this_ptr: &RouteHint) -> u16 {
 345         let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.cltv_expiry_delta;
 346         (*inner_val)
 347 }
 348 /// The difference in CLTV values between this node and the next node.
 349 #[no_mangle]
 350 pub extern "C" fn RouteHint_set_cltv_expiry_delta(this_ptr: &mut RouteHint, mut val: u16) {
 351         unsafe { &mut *this_ptr.inner }.cltv_expiry_delta = val;
 352 }
 353 impl Clone for RouteHint {
 354         fn clone(&self) -> Self {
 355                 Self {
 356                         inner: if <*mut nativeRouteHint>::is_null(self.inner) { std::ptr::null_mut() } else {
 357                                 Box::into_raw(Box::new(unsafe { &*self.inner }.clone())) },
 358                         is_owned: true,
 359                 }
 360         }
 361 }
 362 #[allow(unused)]
 363 /// Used only if an object of this type is returned as a trait impl by a method
 364 pub(crate) extern "C" fn RouteHint_clone_void(this_ptr: *const c_void) -> *mut c_void {
 365         Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeRouteHint)).clone() })) as *mut c_void
 366 }
 367 #[no_mangle]
 368 /// Creates a copy of the RouteHint
 369 pub extern "C" fn RouteHint_clone(orig: &RouteHint) -> RouteHint {
 370         orig.clone()
 371 }
 372 /// Gets a route from us (payer) to the given target node (payee).
 373 ///
 374 /// If the payee provided features in their invoice, they should be provided via payee_features.
 375 /// Without this, MPP will only be used if the payee's features are available in the network graph.
 376 ///
 377 /// Extra routing hops between known nodes and the target will be used if they are included in
 378 /// last_hops.
 379 ///
 380 /// If some channels aren't announced, it may be useful to fill in a first_hops with the
 381 /// results from a local ChannelManager::list_usable_channels() call. If it is filled in, our
 382 /// view of our local channels (from net_graph_msg_handler) will be ignored, and only those
 383 /// in first_hops will be used.
 384 ///
 385 /// Panics if first_hops contains channels without short_channel_ids
 386 /// (ChannelManager::list_usable_channels will never include such channels).
 387 ///
 388 /// The fees on channels from us to next-hops are ignored (as they are assumed to all be
 389 /// equal), however the enabled/disabled bit on such channels as well as the
 390 /// htlc_minimum_msat/htlc_maximum_msat *are* checked as they may change based on the receiving node.
 391 #[no_mangle]
 392 pub extern "C" fn get_route(mut our_node_id: crate::c_types::PublicKey, network: &crate::routing::network_graph::NetworkGraph, mut payee: crate::c_types::PublicKey, mut payee_features: crate::ln::features::InvoiceFeatures, first_hops: *mut crate::c_types::derived::CVec_ChannelDetailsZ, mut last_hops: crate::c_types::derived::CVec_RouteHintZ, mut final_value_msat: u64, mut final_cltv: u32, mut logger: crate::util::logger::Logger) -> crate::c_types::derived::CResult_RouteLightningErrorZ {
 393         let mut local_payee_features = if payee_features.inner.is_null() { None } else { Some( { *unsafe { Box::from_raw(payee_features.take_inner()) } }) };
 394         let mut local_first_hops_base = if first_hops == std::ptr::null_mut() { None } else { Some( { let mut local_first_hops_0 = Vec::new(); for mut item in unsafe { &mut *first_hops }.as_slice().iter() { local_first_hops_0.push( { unsafe { &*item.inner } }); }; local_first_hops_0 }) }; let mut local_first_hops = local_first_hops_base.as_ref().map(|a| &a[..]);
 395         let mut local_last_hops = Vec::new(); for mut item in last_hops.as_slice().iter() { local_last_hops.push( { unsafe { &*item.inner } }); };
 396         let mut ret = lightning::routing::router::get_route(&our_node_id.into_rust(), unsafe { &*network.inner }, &payee.into_rust(), local_payee_features, local_first_hops, &local_last_hops[..], final_value_msat, final_cltv, logger);
 397         let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::routing::router::Route { inner: Box::into_raw(Box::new(o)), is_owned: true } }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::ln::msgs::LightningError { inner: Box::into_raw(Box::new(e)), is_owned: true } }).into() };
 398         local_ret
 399 }
 400