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