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