1 // This file is Copyright its original authors, visible in version control
2 // history and in the source files from which this was generated.
4 // This file is licensed under the license available in the LICENSE or LICENSE.md
5 // file in the root of this repository or, if no such file exists, the same
6 // license as that which applies to the original source files from which this
7 // source was automatically generated.
9 //! The top-level network map tracking logic lives here.
12 use bitcoin::hashes::Hash;
13 use crate::c_types::*;
16 use lightning::routing::network_graph::NetworkGraph as nativeNetworkGraphImport;
17 type nativeNetworkGraph = nativeNetworkGraphImport;
19 /// Represents the network as nodes and channels between them
22 pub struct NetworkGraph {
23 /// A pointer to the opaque Rust object.
25 /// Nearly everywhere, inner must be non-null, however in places where
26 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
27 pub inner: *mut nativeNetworkGraph,
28 /// Indicates that this is the only struct which contains the same pointer.
30 /// Rust functions which take ownership of an object provided via an argument require
31 /// this to be true and invalidate the object pointed to by inner.
35 impl Drop for NetworkGraph {
37 if self.is_owned && !<*mut nativeNetworkGraph>::is_null(self.inner) {
38 let _ = unsafe { Box::from_raw(self.inner) };
42 /// Frees any resources used by the NetworkGraph, if is_owned is set and inner is non-NULL.
44 pub extern "C" fn NetworkGraph_free(this_obj: NetworkGraph) { }
46 /// Used only if an object of this type is returned as a trait impl by a method
47 extern "C" fn NetworkGraph_free_void(this_ptr: *mut c_void) {
48 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeNetworkGraph); }
51 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
53 pub(crate) fn take_inner(mut self) -> *mut nativeNetworkGraph {
54 assert!(self.is_owned);
56 self.inner = std::ptr::null_mut();
60 impl Clone for NetworkGraph {
61 fn clone(&self) -> Self {
63 inner: if <*mut nativeNetworkGraph>::is_null(self.inner) { std::ptr::null_mut() } else {
64 Box::into_raw(Box::new(unsafe { &*self.inner }.clone())) },
70 /// Used only if an object of this type is returned as a trait impl by a method
71 pub(crate) extern "C" fn NetworkGraph_clone_void(this_ptr: *const c_void) -> *mut c_void {
72 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeNetworkGraph)).clone() })) as *mut c_void
75 /// Creates a copy of the NetworkGraph
76 pub extern "C" fn NetworkGraph_clone(orig: &NetworkGraph) -> NetworkGraph {
80 use lightning::routing::network_graph::LockedNetworkGraph as nativeLockedNetworkGraphImport;
81 type nativeLockedNetworkGraph = nativeLockedNetworkGraphImport<'static>;
83 /// A simple newtype for RwLockReadGuard<'a, NetworkGraph>.
84 /// This exists only to make accessing a RwLock<NetworkGraph> possible from
85 /// the C bindings, as it can be done directly in Rust code.
88 pub struct LockedNetworkGraph {
89 /// A pointer to the opaque Rust object.
91 /// Nearly everywhere, inner must be non-null, however in places where
92 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
93 pub inner: *mut nativeLockedNetworkGraph,
94 /// Indicates that this is the only struct which contains the same pointer.
96 /// Rust functions which take ownership of an object provided via an argument require
97 /// this to be true and invalidate the object pointed to by inner.
101 impl Drop for LockedNetworkGraph {
103 if self.is_owned && !<*mut nativeLockedNetworkGraph>::is_null(self.inner) {
104 let _ = unsafe { Box::from_raw(self.inner) };
108 /// Frees any resources used by the LockedNetworkGraph, if is_owned is set and inner is non-NULL.
110 pub extern "C" fn LockedNetworkGraph_free(this_obj: LockedNetworkGraph) { }
112 /// Used only if an object of this type is returned as a trait impl by a method
113 extern "C" fn LockedNetworkGraph_free_void(this_ptr: *mut c_void) {
114 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeLockedNetworkGraph); }
117 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
118 impl LockedNetworkGraph {
119 pub(crate) fn take_inner(mut self) -> *mut nativeLockedNetworkGraph {
120 assert!(self.is_owned);
121 let ret = self.inner;
122 self.inner = std::ptr::null_mut();
127 use lightning::routing::network_graph::NetGraphMsgHandler as nativeNetGraphMsgHandlerImport;
128 type nativeNetGraphMsgHandler = nativeNetGraphMsgHandlerImport<crate::chain::Access, crate::util::logger::Logger>;
130 /// Receives and validates network updates from peers,
131 /// stores authentic and relevant data as a network graph.
132 /// This network graph is then used for routing payments.
133 /// Provides interface to help with initial routing sync by
134 /// serving historical announcements.
137 pub struct NetGraphMsgHandler {
138 /// A pointer to the opaque Rust object.
140 /// Nearly everywhere, inner must be non-null, however in places where
141 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
142 pub inner: *mut nativeNetGraphMsgHandler,
143 /// Indicates that this is the only struct which contains the same pointer.
145 /// Rust functions which take ownership of an object provided via an argument require
146 /// this to be true and invalidate the object pointed to by inner.
150 impl Drop for NetGraphMsgHandler {
152 if self.is_owned && !<*mut nativeNetGraphMsgHandler>::is_null(self.inner) {
153 let _ = unsafe { Box::from_raw(self.inner) };
157 /// Frees any resources used by the NetGraphMsgHandler, if is_owned is set and inner is non-NULL.
159 pub extern "C" fn NetGraphMsgHandler_free(this_obj: NetGraphMsgHandler) { }
161 /// Used only if an object of this type is returned as a trait impl by a method
162 extern "C" fn NetGraphMsgHandler_free_void(this_ptr: *mut c_void) {
163 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeNetGraphMsgHandler); }
166 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
167 impl NetGraphMsgHandler {
168 pub(crate) fn take_inner(mut self) -> *mut nativeNetGraphMsgHandler {
169 assert!(self.is_owned);
170 let ret = self.inner;
171 self.inner = std::ptr::null_mut();
175 /// Creates a new tracker of the actual state of the network of channels and nodes,
176 /// assuming a fresh network graph.
177 /// Chain monitor is used to make sure announced channels exist on-chain,
178 /// channel data is correct, and that the announcement is signed with
179 /// channel owners' keys.
182 pub extern "C" fn NetGraphMsgHandler_new(mut genesis_hash: crate::c_types::ThirtyTwoBytes, chain_access: *mut crate::chain::Access, mut logger: crate::util::logger::Logger) -> NetGraphMsgHandler {
183 let mut local_chain_access = if chain_access == std::ptr::null_mut() { None } else { Some( { unsafe { *Box::from_raw(chain_access) } }) };
184 let mut ret = lightning::routing::network_graph::NetGraphMsgHandler::new(::bitcoin::hash_types::BlockHash::from_slice(&genesis_hash.data[..]).unwrap(), local_chain_access, logger);
185 NetGraphMsgHandler { inner: Box::into_raw(Box::new(ret)), is_owned: true }
188 /// Creates a new tracker of the actual state of the network of channels and nodes,
189 /// assuming an existing Network Graph.
192 pub extern "C" fn NetGraphMsgHandler_from_net_graph(chain_access: *mut crate::chain::Access, mut logger: crate::util::logger::Logger, mut network_graph: crate::routing::network_graph::NetworkGraph) -> NetGraphMsgHandler {
193 let mut local_chain_access = if chain_access == std::ptr::null_mut() { None } else { Some( { unsafe { *Box::from_raw(chain_access) } }) };
194 let mut ret = lightning::routing::network_graph::NetGraphMsgHandler::from_net_graph(local_chain_access, logger, *unsafe { Box::from_raw(network_graph.take_inner()) });
195 NetGraphMsgHandler { inner: Box::into_raw(Box::new(ret)), is_owned: true }
198 /// Adds a provider used to check new announcements. Does not affect
199 /// existing announcements unless they are updated.
200 /// Add, update or remove the provider would replace the current one.
202 pub extern "C" fn NetGraphMsgHandler_add_chain_access(this_arg: &mut NetGraphMsgHandler, chain_access: *mut crate::chain::Access) {
203 let mut local_chain_access = if chain_access == std::ptr::null_mut() { None } else { Some( { unsafe { *Box::from_raw(chain_access) } }) };
204 unsafe { &mut (*(this_arg.inner as *mut nativeNetGraphMsgHandler)) }.add_chain_access(local_chain_access)
207 /// Take a read lock on the network_graph and return it in the C-bindings
208 /// newtype helper. This is likely only useful when called via the C
209 /// bindings as you can call `self.network_graph.read().unwrap()` in Rust
213 pub extern "C" fn NetGraphMsgHandler_read_locked_graph(this_arg: &NetGraphMsgHandler) -> crate::routing::network_graph::LockedNetworkGraph {
214 let mut ret = unsafe { &*this_arg.inner }.read_locked_graph();
215 crate::routing::network_graph::LockedNetworkGraph { inner: Box::into_raw(Box::new(ret)), is_owned: true }
218 /// Get a reference to the NetworkGraph which this read-lock contains.
221 pub extern "C" fn LockedNetworkGraph_graph(this_arg: &LockedNetworkGraph) -> crate::routing::network_graph::NetworkGraph {
222 let mut ret = unsafe { &*this_arg.inner }.graph();
223 crate::routing::network_graph::NetworkGraph { inner: unsafe { ( (&(*ret) as *const _) as *mut _) }, is_owned: false }
226 impl From<nativeNetGraphMsgHandler> for crate::ln::msgs::RoutingMessageHandler {
227 fn from(obj: nativeNetGraphMsgHandler) -> Self {
228 let mut rust_obj = NetGraphMsgHandler { inner: Box::into_raw(Box::new(obj)), is_owned: true };
229 let mut ret = NetGraphMsgHandler_as_RoutingMessageHandler(&rust_obj);
230 // We want to free rust_obj when ret gets drop()'d, not rust_obj, so wipe rust_obj's pointer and set ret's free() fn
231 rust_obj.inner = std::ptr::null_mut();
232 ret.free = Some(NetGraphMsgHandler_free_void);
236 /// Constructs a new RoutingMessageHandler which calls the relevant methods on this_arg.
237 /// This copies the `inner` pointer in this_arg and thus the returned RoutingMessageHandler must be freed before this_arg is
239 pub extern "C" fn NetGraphMsgHandler_as_RoutingMessageHandler(this_arg: &NetGraphMsgHandler) -> crate::ln::msgs::RoutingMessageHandler {
240 crate::ln::msgs::RoutingMessageHandler {
241 this_arg: unsafe { (*this_arg).inner as *mut c_void },
243 handle_node_announcement: NetGraphMsgHandler_RoutingMessageHandler_handle_node_announcement,
244 handle_channel_announcement: NetGraphMsgHandler_RoutingMessageHandler_handle_channel_announcement,
245 handle_channel_update: NetGraphMsgHandler_RoutingMessageHandler_handle_channel_update,
246 handle_htlc_fail_channel_update: NetGraphMsgHandler_RoutingMessageHandler_handle_htlc_fail_channel_update,
247 get_next_channel_announcements: NetGraphMsgHandler_RoutingMessageHandler_get_next_channel_announcements,
248 get_next_node_announcements: NetGraphMsgHandler_RoutingMessageHandler_get_next_node_announcements,
249 sync_routing_table: NetGraphMsgHandler_RoutingMessageHandler_sync_routing_table,
250 handle_reply_channel_range: NetGraphMsgHandler_RoutingMessageHandler_handle_reply_channel_range,
251 handle_reply_short_channel_ids_end: NetGraphMsgHandler_RoutingMessageHandler_handle_reply_short_channel_ids_end,
252 handle_query_channel_range: NetGraphMsgHandler_RoutingMessageHandler_handle_query_channel_range,
253 handle_query_short_channel_ids: NetGraphMsgHandler_RoutingMessageHandler_handle_query_short_channel_ids,
254 MessageSendEventsProvider: crate::util::events::MessageSendEventsProvider {
255 this_arg: unsafe { (*this_arg).inner as *mut c_void },
257 get_and_clear_pending_msg_events: NetGraphMsgHandler_RoutingMessageHandler_get_and_clear_pending_msg_events,
263 extern "C" fn NetGraphMsgHandler_RoutingMessageHandler_handle_node_announcement(this_arg: *const c_void, msg: &crate::ln::msgs::NodeAnnouncement) -> crate::c_types::derived::CResult_boolLightningErrorZ {
264 let mut ret = <nativeNetGraphMsgHandler as lightning::ln::msgs::RoutingMessageHandler<>>::handle_node_announcement(unsafe { &mut *(this_arg as *mut nativeNetGraphMsgHandler) }, unsafe { &*msg.inner });
265 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { o }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::ln::msgs::LightningError { inner: Box::into_raw(Box::new(e)), is_owned: true } }).into() };
269 extern "C" fn NetGraphMsgHandler_RoutingMessageHandler_handle_channel_announcement(this_arg: *const c_void, msg: &crate::ln::msgs::ChannelAnnouncement) -> crate::c_types::derived::CResult_boolLightningErrorZ {
270 let mut ret = <nativeNetGraphMsgHandler as lightning::ln::msgs::RoutingMessageHandler<>>::handle_channel_announcement(unsafe { &mut *(this_arg as *mut nativeNetGraphMsgHandler) }, unsafe { &*msg.inner });
271 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { o }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::ln::msgs::LightningError { inner: Box::into_raw(Box::new(e)), is_owned: true } }).into() };
274 extern "C" fn NetGraphMsgHandler_RoutingMessageHandler_handle_htlc_fail_channel_update(this_arg: *const c_void, update: &crate::ln::msgs::HTLCFailChannelUpdate) {
275 <nativeNetGraphMsgHandler as lightning::ln::msgs::RoutingMessageHandler<>>::handle_htlc_fail_channel_update(unsafe { &mut *(this_arg as *mut nativeNetGraphMsgHandler) }, &update.to_native())
278 extern "C" fn NetGraphMsgHandler_RoutingMessageHandler_handle_channel_update(this_arg: *const c_void, msg: &crate::ln::msgs::ChannelUpdate) -> crate::c_types::derived::CResult_boolLightningErrorZ {
279 let mut ret = <nativeNetGraphMsgHandler as lightning::ln::msgs::RoutingMessageHandler<>>::handle_channel_update(unsafe { &mut *(this_arg as *mut nativeNetGraphMsgHandler) }, unsafe { &*msg.inner });
280 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { o }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::ln::msgs::LightningError { inner: Box::into_raw(Box::new(e)), is_owned: true } }).into() };
284 extern "C" fn NetGraphMsgHandler_RoutingMessageHandler_get_next_channel_announcements(this_arg: *const c_void, mut starting_point: u64, mut batch_amount: u8) -> crate::c_types::derived::CVec_C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZZ {
285 let mut ret = <nativeNetGraphMsgHandler as lightning::ln::msgs::RoutingMessageHandler<>>::get_next_channel_announcements(unsafe { &mut *(this_arg as *mut nativeNetGraphMsgHandler) }, starting_point, batch_amount);
286 let mut local_ret = Vec::new(); for mut item in ret.drain(..) { local_ret.push( { let (mut orig_ret_0_0, mut orig_ret_0_1, mut orig_ret_0_2) = item; let mut local_orig_ret_0_1 = crate::ln::msgs::ChannelUpdate { inner: if orig_ret_0_1.is_none() { std::ptr::null_mut() } else { { Box::into_raw(Box::new((orig_ret_0_1.unwrap()))) } }, is_owned: true }; let mut local_orig_ret_0_2 = crate::ln::msgs::ChannelUpdate { inner: if orig_ret_0_2.is_none() { std::ptr::null_mut() } else { { Box::into_raw(Box::new((orig_ret_0_2.unwrap()))) } }, is_owned: true }; let mut local_ret_0 = (crate::ln::msgs::ChannelAnnouncement { inner: Box::into_raw(Box::new(orig_ret_0_0)), is_owned: true }, local_orig_ret_0_1, local_orig_ret_0_2).into(); local_ret_0 }); };
290 extern "C" fn NetGraphMsgHandler_RoutingMessageHandler_get_next_node_announcements(this_arg: *const c_void, mut starting_point: crate::c_types::PublicKey, mut batch_amount: u8) -> crate::c_types::derived::CVec_NodeAnnouncementZ {
291 let mut local_starting_point_base = if starting_point.is_null() { None } else { Some( { starting_point.into_rust() }) }; let mut local_starting_point = local_starting_point_base.as_ref();
292 let mut ret = <nativeNetGraphMsgHandler as lightning::ln::msgs::RoutingMessageHandler<>>::get_next_node_announcements(unsafe { &mut *(this_arg as *mut nativeNetGraphMsgHandler) }, local_starting_point, batch_amount);
293 let mut local_ret = Vec::new(); for mut item in ret.drain(..) { local_ret.push( { crate::ln::msgs::NodeAnnouncement { inner: Box::into_raw(Box::new(item)), is_owned: true } }); };
296 extern "C" fn NetGraphMsgHandler_RoutingMessageHandler_sync_routing_table(this_arg: *const c_void, mut their_node_id: crate::c_types::PublicKey, init_msg: &crate::ln::msgs::Init) {
297 <nativeNetGraphMsgHandler as lightning::ln::msgs::RoutingMessageHandler<>>::sync_routing_table(unsafe { &mut *(this_arg as *mut nativeNetGraphMsgHandler) }, &their_node_id.into_rust(), unsafe { &*init_msg.inner })
300 extern "C" fn NetGraphMsgHandler_RoutingMessageHandler_handle_reply_channel_range(this_arg: *const c_void, mut their_node_id: crate::c_types::PublicKey, mut msg: crate::ln::msgs::ReplyChannelRange) -> crate::c_types::derived::CResult_NoneLightningErrorZ {
301 let mut ret = <nativeNetGraphMsgHandler as lightning::ln::msgs::RoutingMessageHandler<>>::handle_reply_channel_range(unsafe { &mut *(this_arg as *mut nativeNetGraphMsgHandler) }, &their_node_id.into_rust(), *unsafe { Box::from_raw(msg.take_inner()) });
302 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { 0u8 /*o*/ }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::ln::msgs::LightningError { inner: Box::into_raw(Box::new(e)), is_owned: true } }).into() };
306 extern "C" fn NetGraphMsgHandler_RoutingMessageHandler_handle_reply_short_channel_ids_end(this_arg: *const c_void, mut their_node_id: crate::c_types::PublicKey, mut msg: crate::ln::msgs::ReplyShortChannelIdsEnd) -> crate::c_types::derived::CResult_NoneLightningErrorZ {
307 let mut ret = <nativeNetGraphMsgHandler as lightning::ln::msgs::RoutingMessageHandler<>>::handle_reply_short_channel_ids_end(unsafe { &mut *(this_arg as *mut nativeNetGraphMsgHandler) }, &their_node_id.into_rust(), *unsafe { Box::from_raw(msg.take_inner()) });
308 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { 0u8 /*o*/ }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::ln::msgs::LightningError { inner: Box::into_raw(Box::new(e)), is_owned: true } }).into() };
312 extern "C" fn NetGraphMsgHandler_RoutingMessageHandler_handle_query_channel_range(this_arg: *const c_void, mut their_node_id: crate::c_types::PublicKey, mut msg: crate::ln::msgs::QueryChannelRange) -> crate::c_types::derived::CResult_NoneLightningErrorZ {
313 let mut ret = <nativeNetGraphMsgHandler as lightning::ln::msgs::RoutingMessageHandler<>>::handle_query_channel_range(unsafe { &mut *(this_arg as *mut nativeNetGraphMsgHandler) }, &their_node_id.into_rust(), *unsafe { Box::from_raw(msg.take_inner()) });
314 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { 0u8 /*o*/ }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::ln::msgs::LightningError { inner: Box::into_raw(Box::new(e)), is_owned: true } }).into() };
318 extern "C" fn NetGraphMsgHandler_RoutingMessageHandler_handle_query_short_channel_ids(this_arg: *const c_void, mut _their_node_id: crate::c_types::PublicKey, mut _msg: crate::ln::msgs::QueryShortChannelIds) -> crate::c_types::derived::CResult_NoneLightningErrorZ {
319 let mut ret = <nativeNetGraphMsgHandler as lightning::ln::msgs::RoutingMessageHandler<>>::handle_query_short_channel_ids(unsafe { &mut *(this_arg as *mut nativeNetGraphMsgHandler) }, &_their_node_id.into_rust(), *unsafe { Box::from_raw(_msg.take_inner()) });
320 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { 0u8 /*o*/ }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::ln::msgs::LightningError { inner: Box::into_raw(Box::new(e)), is_owned: true } }).into() };
324 extern "C" fn NetGraphMsgHandler_RoutingMessageHandler_get_and_clear_pending_msg_events(this_arg: *const c_void) -> crate::c_types::derived::CVec_MessageSendEventZ {
325 let mut ret = <nativeNetGraphMsgHandler as lightning::util::events::MessageSendEventsProvider<>>::get_and_clear_pending_msg_events(unsafe { &mut *(this_arg as *mut nativeNetGraphMsgHandler) }, );
326 let mut local_ret = Vec::new(); for mut item in ret.drain(..) { local_ret.push( { crate::util::events::MessageSendEvent::native_into(item) }); };
330 impl From<nativeNetGraphMsgHandler> for crate::util::events::MessageSendEventsProvider {
331 fn from(obj: nativeNetGraphMsgHandler) -> Self {
332 let mut rust_obj = NetGraphMsgHandler { inner: Box::into_raw(Box::new(obj)), is_owned: true };
333 let mut ret = NetGraphMsgHandler_as_MessageSendEventsProvider(&rust_obj);
334 // We want to free rust_obj when ret gets drop()'d, not rust_obj, so wipe rust_obj's pointer and set ret's free() fn
335 rust_obj.inner = std::ptr::null_mut();
336 ret.free = Some(NetGraphMsgHandler_free_void);
340 /// Constructs a new MessageSendEventsProvider which calls the relevant methods on this_arg.
341 /// This copies the `inner` pointer in this_arg and thus the returned MessageSendEventsProvider must be freed before this_arg is
343 pub extern "C" fn NetGraphMsgHandler_as_MessageSendEventsProvider(this_arg: &NetGraphMsgHandler) -> crate::util::events::MessageSendEventsProvider {
344 crate::util::events::MessageSendEventsProvider {
345 this_arg: unsafe { (*this_arg).inner as *mut c_void },
347 get_and_clear_pending_msg_events: NetGraphMsgHandler_MessageSendEventsProvider_get_and_clear_pending_msg_events,
352 extern "C" fn NetGraphMsgHandler_MessageSendEventsProvider_get_and_clear_pending_msg_events(this_arg: *const c_void) -> crate::c_types::derived::CVec_MessageSendEventZ {
353 let mut ret = <nativeNetGraphMsgHandler as lightning::util::events::MessageSendEventsProvider<>>::get_and_clear_pending_msg_events(unsafe { &mut *(this_arg as *mut nativeNetGraphMsgHandler) }, );
354 let mut local_ret = Vec::new(); for mut item in ret.drain(..) { local_ret.push( { crate::util::events::MessageSendEvent::native_into(item) }); };
359 use lightning::routing::network_graph::DirectionalChannelInfo as nativeDirectionalChannelInfoImport;
360 type nativeDirectionalChannelInfo = nativeDirectionalChannelInfoImport;
362 /// Details about one direction of a channel. Received
363 /// within a channel update.
366 pub struct DirectionalChannelInfo {
367 /// A pointer to the opaque Rust object.
369 /// Nearly everywhere, inner must be non-null, however in places where
370 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
371 pub inner: *mut nativeDirectionalChannelInfo,
372 /// Indicates that this is the only struct which contains the same pointer.
374 /// Rust functions which take ownership of an object provided via an argument require
375 /// this to be true and invalidate the object pointed to by inner.
379 impl Drop for DirectionalChannelInfo {
381 if self.is_owned && !<*mut nativeDirectionalChannelInfo>::is_null(self.inner) {
382 let _ = unsafe { Box::from_raw(self.inner) };
386 /// Frees any resources used by the DirectionalChannelInfo, if is_owned is set and inner is non-NULL.
388 pub extern "C" fn DirectionalChannelInfo_free(this_obj: DirectionalChannelInfo) { }
390 /// Used only if an object of this type is returned as a trait impl by a method
391 extern "C" fn DirectionalChannelInfo_free_void(this_ptr: *mut c_void) {
392 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeDirectionalChannelInfo); }
395 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
396 impl DirectionalChannelInfo {
397 pub(crate) fn take_inner(mut self) -> *mut nativeDirectionalChannelInfo {
398 assert!(self.is_owned);
399 let ret = self.inner;
400 self.inner = std::ptr::null_mut();
404 /// When the last update to the channel direction was issued.
405 /// Value is opaque, as set in the announcement.
407 pub extern "C" fn DirectionalChannelInfo_get_last_update(this_ptr: &DirectionalChannelInfo) -> u32 {
408 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.last_update;
411 /// When the last update to the channel direction was issued.
412 /// Value is opaque, as set in the announcement.
414 pub extern "C" fn DirectionalChannelInfo_set_last_update(this_ptr: &mut DirectionalChannelInfo, mut val: u32) {
415 unsafe { &mut *this_ptr.inner }.last_update = val;
417 /// Whether the channel can be currently used for payments (in this one direction).
419 pub extern "C" fn DirectionalChannelInfo_get_enabled(this_ptr: &DirectionalChannelInfo) -> bool {
420 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.enabled;
423 /// Whether the channel can be currently used for payments (in this one direction).
425 pub extern "C" fn DirectionalChannelInfo_set_enabled(this_ptr: &mut DirectionalChannelInfo, mut val: bool) {
426 unsafe { &mut *this_ptr.inner }.enabled = val;
428 /// The difference in CLTV values that you must have when routing through this channel.
430 pub extern "C" fn DirectionalChannelInfo_get_cltv_expiry_delta(this_ptr: &DirectionalChannelInfo) -> u16 {
431 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.cltv_expiry_delta;
434 /// The difference in CLTV values that you must have when routing through this channel.
436 pub extern "C" fn DirectionalChannelInfo_set_cltv_expiry_delta(this_ptr: &mut DirectionalChannelInfo, mut val: u16) {
437 unsafe { &mut *this_ptr.inner }.cltv_expiry_delta = val;
439 /// The minimum value, which must be relayed to the next hop via the channel
441 pub extern "C" fn DirectionalChannelInfo_get_htlc_minimum_msat(this_ptr: &DirectionalChannelInfo) -> u64 {
442 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.htlc_minimum_msat;
445 /// The minimum value, which must be relayed to the next hop via the channel
447 pub extern "C" fn DirectionalChannelInfo_set_htlc_minimum_msat(this_ptr: &mut DirectionalChannelInfo, mut val: u64) {
448 unsafe { &mut *this_ptr.inner }.htlc_minimum_msat = val;
450 /// Fees charged when the channel is used for routing
452 pub extern "C" fn DirectionalChannelInfo_get_fees(this_ptr: &DirectionalChannelInfo) -> crate::routing::network_graph::RoutingFees {
453 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.fees;
454 crate::routing::network_graph::RoutingFees { inner: unsafe { ( (&((*inner_val)) as *const _) as *mut _) }, is_owned: false }
456 /// Fees charged when the channel is used for routing
458 pub extern "C" fn DirectionalChannelInfo_set_fees(this_ptr: &mut DirectionalChannelInfo, mut val: crate::routing::network_graph::RoutingFees) {
459 unsafe { &mut *this_ptr.inner }.fees = *unsafe { Box::from_raw(val.take_inner()) };
461 /// Most recent update for the channel received from the network
462 /// Mostly redundant with the data we store in fields explicitly.
463 /// Everything else is useful only for sending out for initial routing sync.
464 /// Not stored if contains excess data to prevent DoS.
466 pub extern "C" fn DirectionalChannelInfo_get_last_update_message(this_ptr: &DirectionalChannelInfo) -> crate::ln::msgs::ChannelUpdate {
467 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.last_update_message;
468 let mut local_inner_val = crate::ln::msgs::ChannelUpdate { inner: unsafe { (if inner_val.is_none() { std::ptr::null() } else { { (inner_val.as_ref().unwrap()) } } as *const _) as *mut _ }, is_owned: false };
471 /// Most recent update for the channel received from the network
472 /// Mostly redundant with the data we store in fields explicitly.
473 /// Everything else is useful only for sending out for initial routing sync.
474 /// Not stored if contains excess data to prevent DoS.
476 pub extern "C" fn DirectionalChannelInfo_set_last_update_message(this_ptr: &mut DirectionalChannelInfo, mut val: crate::ln::msgs::ChannelUpdate) {
477 let mut local_val = if val.inner.is_null() { None } else { Some( { *unsafe { Box::from_raw(val.take_inner()) } }) };
478 unsafe { &mut *this_ptr.inner }.last_update_message = local_val;
480 impl Clone for DirectionalChannelInfo {
481 fn clone(&self) -> Self {
483 inner: if <*mut nativeDirectionalChannelInfo>::is_null(self.inner) { std::ptr::null_mut() } else {
484 Box::into_raw(Box::new(unsafe { &*self.inner }.clone())) },
490 /// Used only if an object of this type is returned as a trait impl by a method
491 pub(crate) extern "C" fn DirectionalChannelInfo_clone_void(this_ptr: *const c_void) -> *mut c_void {
492 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeDirectionalChannelInfo)).clone() })) as *mut c_void
495 /// Creates a copy of the DirectionalChannelInfo
496 pub extern "C" fn DirectionalChannelInfo_clone(orig: &DirectionalChannelInfo) -> DirectionalChannelInfo {
500 /// Serialize the DirectionalChannelInfo object into a byte array which can be read by DirectionalChannelInfo_read
501 pub extern "C" fn DirectionalChannelInfo_write(obj: &DirectionalChannelInfo) -> crate::c_types::derived::CVec_u8Z {
502 crate::c_types::serialize_obj(unsafe { &*unsafe { &*obj }.inner })
505 pub(crate) extern "C" fn DirectionalChannelInfo_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
506 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeDirectionalChannelInfo) })
509 /// Read a DirectionalChannelInfo from a byte array, created by DirectionalChannelInfo_write
510 pub extern "C" fn DirectionalChannelInfo_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_DirectionalChannelInfoDecodeErrorZ {
511 let res = crate::c_types::deserialize_obj(ser);
512 let mut local_res = match res { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::routing::network_graph::DirectionalChannelInfo { 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() };
516 use lightning::routing::network_graph::ChannelInfo as nativeChannelInfoImport;
517 type nativeChannelInfo = nativeChannelInfoImport;
519 /// Details about a channel (both directions).
520 /// Received within a channel announcement.
523 pub struct ChannelInfo {
524 /// A pointer to the opaque Rust object.
526 /// Nearly everywhere, inner must be non-null, however in places where
527 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
528 pub inner: *mut nativeChannelInfo,
529 /// Indicates that this is the only struct which contains the same pointer.
531 /// Rust functions which take ownership of an object provided via an argument require
532 /// this to be true and invalidate the object pointed to by inner.
536 impl Drop for ChannelInfo {
538 if self.is_owned && !<*mut nativeChannelInfo>::is_null(self.inner) {
539 let _ = unsafe { Box::from_raw(self.inner) };
543 /// Frees any resources used by the ChannelInfo, if is_owned is set and inner is non-NULL.
545 pub extern "C" fn ChannelInfo_free(this_obj: ChannelInfo) { }
547 /// Used only if an object of this type is returned as a trait impl by a method
548 extern "C" fn ChannelInfo_free_void(this_ptr: *mut c_void) {
549 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeChannelInfo); }
552 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
554 pub(crate) fn take_inner(mut self) -> *mut nativeChannelInfo {
555 assert!(self.is_owned);
556 let ret = self.inner;
557 self.inner = std::ptr::null_mut();
561 /// Protocol features of a channel communicated during its announcement
563 pub extern "C" fn ChannelInfo_get_features(this_ptr: &ChannelInfo) -> crate::ln::features::ChannelFeatures {
564 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.features;
565 crate::ln::features::ChannelFeatures { inner: unsafe { ( (&((*inner_val)) as *const _) as *mut _) }, is_owned: false }
567 /// Protocol features of a channel communicated during its announcement
569 pub extern "C" fn ChannelInfo_set_features(this_ptr: &mut ChannelInfo, mut val: crate::ln::features::ChannelFeatures) {
570 unsafe { &mut *this_ptr.inner }.features = *unsafe { Box::from_raw(val.take_inner()) };
572 /// Source node of the first direction of a channel
574 pub extern "C" fn ChannelInfo_get_node_one(this_ptr: &ChannelInfo) -> crate::c_types::PublicKey {
575 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.node_one;
576 crate::c_types::PublicKey::from_rust(&(*inner_val))
578 /// Source node of the first direction of a channel
580 pub extern "C" fn ChannelInfo_set_node_one(this_ptr: &mut ChannelInfo, mut val: crate::c_types::PublicKey) {
581 unsafe { &mut *this_ptr.inner }.node_one = val.into_rust();
583 /// Details about the first direction of a channel
585 pub extern "C" fn ChannelInfo_get_one_to_two(this_ptr: &ChannelInfo) -> crate::routing::network_graph::DirectionalChannelInfo {
586 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.one_to_two;
587 let mut local_inner_val = crate::routing::network_graph::DirectionalChannelInfo { inner: unsafe { (if inner_val.is_none() { std::ptr::null() } else { { (inner_val.as_ref().unwrap()) } } as *const _) as *mut _ }, is_owned: false };
590 /// Details about the first direction of a channel
592 pub extern "C" fn ChannelInfo_set_one_to_two(this_ptr: &mut ChannelInfo, mut val: crate::routing::network_graph::DirectionalChannelInfo) {
593 let mut local_val = if val.inner.is_null() { None } else { Some( { *unsafe { Box::from_raw(val.take_inner()) } }) };
594 unsafe { &mut *this_ptr.inner }.one_to_two = local_val;
596 /// Source node of the second direction of a channel
598 pub extern "C" fn ChannelInfo_get_node_two(this_ptr: &ChannelInfo) -> crate::c_types::PublicKey {
599 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.node_two;
600 crate::c_types::PublicKey::from_rust(&(*inner_val))
602 /// Source node of the second direction of a channel
604 pub extern "C" fn ChannelInfo_set_node_two(this_ptr: &mut ChannelInfo, mut val: crate::c_types::PublicKey) {
605 unsafe { &mut *this_ptr.inner }.node_two = val.into_rust();
607 /// Details about the second direction of a channel
609 pub extern "C" fn ChannelInfo_get_two_to_one(this_ptr: &ChannelInfo) -> crate::routing::network_graph::DirectionalChannelInfo {
610 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.two_to_one;
611 let mut local_inner_val = crate::routing::network_graph::DirectionalChannelInfo { inner: unsafe { (if inner_val.is_none() { std::ptr::null() } else { { (inner_val.as_ref().unwrap()) } } as *const _) as *mut _ }, is_owned: false };
614 /// Details about the second direction of a channel
616 pub extern "C" fn ChannelInfo_set_two_to_one(this_ptr: &mut ChannelInfo, mut val: crate::routing::network_graph::DirectionalChannelInfo) {
617 let mut local_val = if val.inner.is_null() { None } else { Some( { *unsafe { Box::from_raw(val.take_inner()) } }) };
618 unsafe { &mut *this_ptr.inner }.two_to_one = local_val;
620 /// An initial announcement of the channel
621 /// Mostly redundant with the data we store in fields explicitly.
622 /// Everything else is useful only for sending out for initial routing sync.
623 /// Not stored if contains excess data to prevent DoS.
625 pub extern "C" fn ChannelInfo_get_announcement_message(this_ptr: &ChannelInfo) -> crate::ln::msgs::ChannelAnnouncement {
626 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.announcement_message;
627 let mut local_inner_val = crate::ln::msgs::ChannelAnnouncement { inner: unsafe { (if inner_val.is_none() { std::ptr::null() } else { { (inner_val.as_ref().unwrap()) } } as *const _) as *mut _ }, is_owned: false };
630 /// An initial announcement of the channel
631 /// Mostly redundant with the data we store in fields explicitly.
632 /// Everything else is useful only for sending out for initial routing sync.
633 /// Not stored if contains excess data to prevent DoS.
635 pub extern "C" fn ChannelInfo_set_announcement_message(this_ptr: &mut ChannelInfo, mut val: crate::ln::msgs::ChannelAnnouncement) {
636 let mut local_val = if val.inner.is_null() { None } else { Some( { *unsafe { Box::from_raw(val.take_inner()) } }) };
637 unsafe { &mut *this_ptr.inner }.announcement_message = local_val;
639 impl Clone for ChannelInfo {
640 fn clone(&self) -> Self {
642 inner: if <*mut nativeChannelInfo>::is_null(self.inner) { std::ptr::null_mut() } else {
643 Box::into_raw(Box::new(unsafe { &*self.inner }.clone())) },
649 /// Used only if an object of this type is returned as a trait impl by a method
650 pub(crate) extern "C" fn ChannelInfo_clone_void(this_ptr: *const c_void) -> *mut c_void {
651 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeChannelInfo)).clone() })) as *mut c_void
654 /// Creates a copy of the ChannelInfo
655 pub extern "C" fn ChannelInfo_clone(orig: &ChannelInfo) -> ChannelInfo {
659 /// Serialize the ChannelInfo object into a byte array which can be read by ChannelInfo_read
660 pub extern "C" fn ChannelInfo_write(obj: &ChannelInfo) -> crate::c_types::derived::CVec_u8Z {
661 crate::c_types::serialize_obj(unsafe { &*unsafe { &*obj }.inner })
664 pub(crate) extern "C" fn ChannelInfo_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
665 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeChannelInfo) })
668 /// Read a ChannelInfo from a byte array, created by ChannelInfo_write
669 pub extern "C" fn ChannelInfo_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_ChannelInfoDecodeErrorZ {
670 let res = crate::c_types::deserialize_obj(ser);
671 let mut local_res = match res { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::routing::network_graph::ChannelInfo { 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() };
675 use lightning::routing::network_graph::RoutingFees as nativeRoutingFeesImport;
676 type nativeRoutingFees = nativeRoutingFeesImport;
678 /// Fees for routing via a given channel or a node
681 pub struct RoutingFees {
682 /// A pointer to the opaque Rust object.
684 /// Nearly everywhere, inner must be non-null, however in places where
685 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
686 pub inner: *mut nativeRoutingFees,
687 /// Indicates that this is the only struct which contains the same pointer.
689 /// Rust functions which take ownership of an object provided via an argument require
690 /// this to be true and invalidate the object pointed to by inner.
694 impl Drop for RoutingFees {
696 if self.is_owned && !<*mut nativeRoutingFees>::is_null(self.inner) {
697 let _ = unsafe { Box::from_raw(self.inner) };
701 /// Frees any resources used by the RoutingFees, if is_owned is set and inner is non-NULL.
703 pub extern "C" fn RoutingFees_free(this_obj: RoutingFees) { }
705 /// Used only if an object of this type is returned as a trait impl by a method
706 extern "C" fn RoutingFees_free_void(this_ptr: *mut c_void) {
707 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeRoutingFees); }
710 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
712 pub(crate) fn take_inner(mut self) -> *mut nativeRoutingFees {
713 assert!(self.is_owned);
714 let ret = self.inner;
715 self.inner = std::ptr::null_mut();
719 /// Flat routing fee in satoshis
721 pub extern "C" fn RoutingFees_get_base_msat(this_ptr: &RoutingFees) -> u32 {
722 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.base_msat;
725 /// Flat routing fee in satoshis
727 pub extern "C" fn RoutingFees_set_base_msat(this_ptr: &mut RoutingFees, mut val: u32) {
728 unsafe { &mut *this_ptr.inner }.base_msat = val;
730 /// Liquidity-based routing fee in millionths of a routed amount.
731 /// In other words, 10000 is 1%.
733 pub extern "C" fn RoutingFees_get_proportional_millionths(this_ptr: &RoutingFees) -> u32 {
734 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.proportional_millionths;
737 /// Liquidity-based routing fee in millionths of a routed amount.
738 /// In other words, 10000 is 1%.
740 pub extern "C" fn RoutingFees_set_proportional_millionths(this_ptr: &mut RoutingFees, mut val: u32) {
741 unsafe { &mut *this_ptr.inner }.proportional_millionths = val;
743 /// Constructs a new RoutingFees given each field
746 pub extern "C" fn RoutingFees_new(mut base_msat_arg: u32, mut proportional_millionths_arg: u32) -> RoutingFees {
747 RoutingFees { inner: Box::into_raw(Box::new(nativeRoutingFees {
748 base_msat: base_msat_arg,
749 proportional_millionths: proportional_millionths_arg,
750 })), is_owned: true }
752 impl Clone for RoutingFees {
753 fn clone(&self) -> Self {
755 inner: if <*mut nativeRoutingFees>::is_null(self.inner) { std::ptr::null_mut() } else {
756 Box::into_raw(Box::new(unsafe { &*self.inner }.clone())) },
762 /// Used only if an object of this type is returned as a trait impl by a method
763 pub(crate) extern "C" fn RoutingFees_clone_void(this_ptr: *const c_void) -> *mut c_void {
764 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeRoutingFees)).clone() })) as *mut c_void
767 /// Creates a copy of the RoutingFees
768 pub extern "C" fn RoutingFees_clone(orig: &RoutingFees) -> RoutingFees {
772 /// Read a RoutingFees from a byte array, created by RoutingFees_write
773 pub extern "C" fn RoutingFees_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_RoutingFeesDecodeErrorZ {
774 let res = crate::c_types::deserialize_obj(ser);
775 let mut local_res = match res { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::routing::network_graph::RoutingFees { 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() };
779 /// Serialize the RoutingFees object into a byte array which can be read by RoutingFees_read
780 pub extern "C" fn RoutingFees_write(obj: &RoutingFees) -> crate::c_types::derived::CVec_u8Z {
781 crate::c_types::serialize_obj(unsafe { &*unsafe { &*obj }.inner })
784 pub(crate) extern "C" fn RoutingFees_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
785 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeRoutingFees) })
788 use lightning::routing::network_graph::NodeAnnouncementInfo as nativeNodeAnnouncementInfoImport;
789 type nativeNodeAnnouncementInfo = nativeNodeAnnouncementInfoImport;
791 /// Information received in the latest node_announcement from this node.
794 pub struct NodeAnnouncementInfo {
795 /// A pointer to the opaque Rust object.
797 /// Nearly everywhere, inner must be non-null, however in places where
798 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
799 pub inner: *mut nativeNodeAnnouncementInfo,
800 /// Indicates that this is the only struct which contains the same pointer.
802 /// Rust functions which take ownership of an object provided via an argument require
803 /// this to be true and invalidate the object pointed to by inner.
807 impl Drop for NodeAnnouncementInfo {
809 if self.is_owned && !<*mut nativeNodeAnnouncementInfo>::is_null(self.inner) {
810 let _ = unsafe { Box::from_raw(self.inner) };
814 /// Frees any resources used by the NodeAnnouncementInfo, if is_owned is set and inner is non-NULL.
816 pub extern "C" fn NodeAnnouncementInfo_free(this_obj: NodeAnnouncementInfo) { }
818 /// Used only if an object of this type is returned as a trait impl by a method
819 extern "C" fn NodeAnnouncementInfo_free_void(this_ptr: *mut c_void) {
820 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeNodeAnnouncementInfo); }
823 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
824 impl NodeAnnouncementInfo {
825 pub(crate) fn take_inner(mut self) -> *mut nativeNodeAnnouncementInfo {
826 assert!(self.is_owned);
827 let ret = self.inner;
828 self.inner = std::ptr::null_mut();
832 /// Protocol features the node announced support for
834 pub extern "C" fn NodeAnnouncementInfo_get_features(this_ptr: &NodeAnnouncementInfo) -> crate::ln::features::NodeFeatures {
835 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.features;
836 crate::ln::features::NodeFeatures { inner: unsafe { ( (&((*inner_val)) as *const _) as *mut _) }, is_owned: false }
838 /// Protocol features the node announced support for
840 pub extern "C" fn NodeAnnouncementInfo_set_features(this_ptr: &mut NodeAnnouncementInfo, mut val: crate::ln::features::NodeFeatures) {
841 unsafe { &mut *this_ptr.inner }.features = *unsafe { Box::from_raw(val.take_inner()) };
843 /// When the last known update to the node state was issued.
844 /// Value is opaque, as set in the announcement.
846 pub extern "C" fn NodeAnnouncementInfo_get_last_update(this_ptr: &NodeAnnouncementInfo) -> u32 {
847 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.last_update;
850 /// When the last known update to the node state was issued.
851 /// Value is opaque, as set in the announcement.
853 pub extern "C" fn NodeAnnouncementInfo_set_last_update(this_ptr: &mut NodeAnnouncementInfo, mut val: u32) {
854 unsafe { &mut *this_ptr.inner }.last_update = val;
856 /// Color assigned to the node
858 pub extern "C" fn NodeAnnouncementInfo_get_rgb(this_ptr: &NodeAnnouncementInfo) -> *const [u8; 3] {
859 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.rgb;
862 /// Color assigned to the node
864 pub extern "C" fn NodeAnnouncementInfo_set_rgb(this_ptr: &mut NodeAnnouncementInfo, mut val: crate::c_types::ThreeBytes) {
865 unsafe { &mut *this_ptr.inner }.rgb = val.data;
867 /// Moniker assigned to the node.
868 /// May be invalid or malicious (eg control chars),
869 /// should not be exposed to the user.
871 pub extern "C" fn NodeAnnouncementInfo_get_alias(this_ptr: &NodeAnnouncementInfo) -> *const [u8; 32] {
872 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.alias;
875 /// Moniker assigned to the node.
876 /// May be invalid or malicious (eg control chars),
877 /// should not be exposed to the user.
879 pub extern "C" fn NodeAnnouncementInfo_set_alias(this_ptr: &mut NodeAnnouncementInfo, mut val: crate::c_types::ThirtyTwoBytes) {
880 unsafe { &mut *this_ptr.inner }.alias = val.data;
882 /// Internet-level addresses via which one can connect to the node
884 pub extern "C" fn NodeAnnouncementInfo_set_addresses(this_ptr: &mut NodeAnnouncementInfo, mut val: crate::c_types::derived::CVec_NetAddressZ) {
885 let mut local_val = Vec::new(); for mut item in val.into_rust().drain(..) { local_val.push( { item.into_native() }); };
886 unsafe { &mut *this_ptr.inner }.addresses = local_val;
888 /// An initial announcement of the node
889 /// Mostly redundant with the data we store in fields explicitly.
890 /// Everything else is useful only for sending out for initial routing sync.
891 /// Not stored if contains excess data to prevent DoS.
893 pub extern "C" fn NodeAnnouncementInfo_get_announcement_message(this_ptr: &NodeAnnouncementInfo) -> crate::ln::msgs::NodeAnnouncement {
894 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.announcement_message;
895 let mut local_inner_val = crate::ln::msgs::NodeAnnouncement { inner: unsafe { (if inner_val.is_none() { std::ptr::null() } else { { (inner_val.as_ref().unwrap()) } } as *const _) as *mut _ }, is_owned: false };
898 /// An initial announcement of the node
899 /// Mostly redundant with the data we store in fields explicitly.
900 /// Everything else is useful only for sending out for initial routing sync.
901 /// Not stored if contains excess data to prevent DoS.
903 pub extern "C" fn NodeAnnouncementInfo_set_announcement_message(this_ptr: &mut NodeAnnouncementInfo, mut val: crate::ln::msgs::NodeAnnouncement) {
904 let mut local_val = if val.inner.is_null() { None } else { Some( { *unsafe { Box::from_raw(val.take_inner()) } }) };
905 unsafe { &mut *this_ptr.inner }.announcement_message = local_val;
907 /// Constructs a new NodeAnnouncementInfo given each field
910 pub extern "C" fn NodeAnnouncementInfo_new(mut features_arg: crate::ln::features::NodeFeatures, mut last_update_arg: u32, mut rgb_arg: crate::c_types::ThreeBytes, mut alias_arg: crate::c_types::ThirtyTwoBytes, mut addresses_arg: crate::c_types::derived::CVec_NetAddressZ, mut announcement_message_arg: crate::ln::msgs::NodeAnnouncement) -> NodeAnnouncementInfo {
911 let mut local_addresses_arg = Vec::new(); for mut item in addresses_arg.into_rust().drain(..) { local_addresses_arg.push( { item.into_native() }); };
912 let mut local_announcement_message_arg = if announcement_message_arg.inner.is_null() { None } else { Some( { *unsafe { Box::from_raw(announcement_message_arg.take_inner()) } }) };
913 NodeAnnouncementInfo { inner: Box::into_raw(Box::new(nativeNodeAnnouncementInfo {
914 features: *unsafe { Box::from_raw(features_arg.take_inner()) },
915 last_update: last_update_arg,
917 alias: alias_arg.data,
918 addresses: local_addresses_arg,
919 announcement_message: local_announcement_message_arg,
920 })), is_owned: true }
922 impl Clone for NodeAnnouncementInfo {
923 fn clone(&self) -> Self {
925 inner: if <*mut nativeNodeAnnouncementInfo>::is_null(self.inner) { std::ptr::null_mut() } else {
926 Box::into_raw(Box::new(unsafe { &*self.inner }.clone())) },
932 /// Used only if an object of this type is returned as a trait impl by a method
933 pub(crate) extern "C" fn NodeAnnouncementInfo_clone_void(this_ptr: *const c_void) -> *mut c_void {
934 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeNodeAnnouncementInfo)).clone() })) as *mut c_void
937 /// Creates a copy of the NodeAnnouncementInfo
938 pub extern "C" fn NodeAnnouncementInfo_clone(orig: &NodeAnnouncementInfo) -> NodeAnnouncementInfo {
942 /// Serialize the NodeAnnouncementInfo object into a byte array which can be read by NodeAnnouncementInfo_read
943 pub extern "C" fn NodeAnnouncementInfo_write(obj: &NodeAnnouncementInfo) -> crate::c_types::derived::CVec_u8Z {
944 crate::c_types::serialize_obj(unsafe { &*unsafe { &*obj }.inner })
947 pub(crate) extern "C" fn NodeAnnouncementInfo_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
948 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeNodeAnnouncementInfo) })
951 /// Read a NodeAnnouncementInfo from a byte array, created by NodeAnnouncementInfo_write
952 pub extern "C" fn NodeAnnouncementInfo_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_NodeAnnouncementInfoDecodeErrorZ {
953 let res = crate::c_types::deserialize_obj(ser);
954 let mut local_res = match res { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::routing::network_graph::NodeAnnouncementInfo { 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() };
958 use lightning::routing::network_graph::NodeInfo as nativeNodeInfoImport;
959 type nativeNodeInfo = nativeNodeInfoImport;
961 /// Details about a node in the network, known from the network announcement.
964 pub struct NodeInfo {
965 /// A pointer to the opaque Rust object.
967 /// Nearly everywhere, inner must be non-null, however in places where
968 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
969 pub inner: *mut nativeNodeInfo,
970 /// Indicates that this is the only struct which contains the same pointer.
972 /// Rust functions which take ownership of an object provided via an argument require
973 /// this to be true and invalidate the object pointed to by inner.
977 impl Drop for NodeInfo {
979 if self.is_owned && !<*mut nativeNodeInfo>::is_null(self.inner) {
980 let _ = unsafe { Box::from_raw(self.inner) };
984 /// Frees any resources used by the NodeInfo, if is_owned is set and inner is non-NULL.
986 pub extern "C" fn NodeInfo_free(this_obj: NodeInfo) { }
988 /// Used only if an object of this type is returned as a trait impl by a method
989 extern "C" fn NodeInfo_free_void(this_ptr: *mut c_void) {
990 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeNodeInfo); }
993 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
995 pub(crate) fn take_inner(mut self) -> *mut nativeNodeInfo {
996 assert!(self.is_owned);
997 let ret = self.inner;
998 self.inner = std::ptr::null_mut();
1002 /// All valid channels a node has announced
1004 pub extern "C" fn NodeInfo_set_channels(this_ptr: &mut NodeInfo, mut val: crate::c_types::derived::CVec_u64Z) {
1005 let mut local_val = Vec::new(); for mut item in val.into_rust().drain(..) { local_val.push( { item }); };
1006 unsafe { &mut *this_ptr.inner }.channels = local_val;
1008 /// Lowest fees enabling routing via any of the enabled, known channels to a node.
1009 /// The two fields (flat and proportional fee) are independent,
1010 /// meaning they don't have to refer to the same channel.
1012 pub extern "C" fn NodeInfo_get_lowest_inbound_channel_fees(this_ptr: &NodeInfo) -> crate::routing::network_graph::RoutingFees {
1013 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.lowest_inbound_channel_fees;
1014 let mut local_inner_val = crate::routing::network_graph::RoutingFees { inner: unsafe { (if inner_val.is_none() { std::ptr::null() } else { { (inner_val.as_ref().unwrap()) } } as *const _) as *mut _ }, is_owned: false };
1017 /// Lowest fees enabling routing via any of the enabled, known channels to a node.
1018 /// The two fields (flat and proportional fee) are independent,
1019 /// meaning they don't have to refer to the same channel.
1021 pub extern "C" fn NodeInfo_set_lowest_inbound_channel_fees(this_ptr: &mut NodeInfo, mut val: crate::routing::network_graph::RoutingFees) {
1022 let mut local_val = if val.inner.is_null() { None } else { Some( { *unsafe { Box::from_raw(val.take_inner()) } }) };
1023 unsafe { &mut *this_ptr.inner }.lowest_inbound_channel_fees = local_val;
1025 /// More information about a node from node_announcement.
1026 /// Optional because we store a Node entry after learning about it from
1027 /// a channel announcement, but before receiving a node announcement.
1029 pub extern "C" fn NodeInfo_get_announcement_info(this_ptr: &NodeInfo) -> crate::routing::network_graph::NodeAnnouncementInfo {
1030 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.announcement_info;
1031 let mut local_inner_val = crate::routing::network_graph::NodeAnnouncementInfo { inner: unsafe { (if inner_val.is_none() { std::ptr::null() } else { { (inner_val.as_ref().unwrap()) } } as *const _) as *mut _ }, is_owned: false };
1034 /// More information about a node from node_announcement.
1035 /// Optional because we store a Node entry after learning about it from
1036 /// a channel announcement, but before receiving a node announcement.
1038 pub extern "C" fn NodeInfo_set_announcement_info(this_ptr: &mut NodeInfo, mut val: crate::routing::network_graph::NodeAnnouncementInfo) {
1039 let mut local_val = if val.inner.is_null() { None } else { Some( { *unsafe { Box::from_raw(val.take_inner()) } }) };
1040 unsafe { &mut *this_ptr.inner }.announcement_info = local_val;
1042 /// Constructs a new NodeInfo given each field
1045 pub extern "C" fn NodeInfo_new(mut channels_arg: crate::c_types::derived::CVec_u64Z, mut lowest_inbound_channel_fees_arg: crate::routing::network_graph::RoutingFees, mut announcement_info_arg: crate::routing::network_graph::NodeAnnouncementInfo) -> NodeInfo {
1046 let mut local_channels_arg = Vec::new(); for mut item in channels_arg.into_rust().drain(..) { local_channels_arg.push( { item }); };
1047 let mut local_lowest_inbound_channel_fees_arg = if lowest_inbound_channel_fees_arg.inner.is_null() { None } else { Some( { *unsafe { Box::from_raw(lowest_inbound_channel_fees_arg.take_inner()) } }) };
1048 let mut local_announcement_info_arg = if announcement_info_arg.inner.is_null() { None } else { Some( { *unsafe { Box::from_raw(announcement_info_arg.take_inner()) } }) };
1049 NodeInfo { inner: Box::into_raw(Box::new(nativeNodeInfo {
1050 channels: local_channels_arg,
1051 lowest_inbound_channel_fees: local_lowest_inbound_channel_fees_arg,
1052 announcement_info: local_announcement_info_arg,
1053 })), is_owned: true }
1055 impl Clone for NodeInfo {
1056 fn clone(&self) -> Self {
1058 inner: if <*mut nativeNodeInfo>::is_null(self.inner) { std::ptr::null_mut() } else {
1059 Box::into_raw(Box::new(unsafe { &*self.inner }.clone())) },
1065 /// Used only if an object of this type is returned as a trait impl by a method
1066 pub(crate) extern "C" fn NodeInfo_clone_void(this_ptr: *const c_void) -> *mut c_void {
1067 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeNodeInfo)).clone() })) as *mut c_void
1070 /// Creates a copy of the NodeInfo
1071 pub extern "C" fn NodeInfo_clone(orig: &NodeInfo) -> NodeInfo {
1075 /// Serialize the NodeInfo object into a byte array which can be read by NodeInfo_read
1076 pub extern "C" fn NodeInfo_write(obj: &NodeInfo) -> crate::c_types::derived::CVec_u8Z {
1077 crate::c_types::serialize_obj(unsafe { &*unsafe { &*obj }.inner })
1080 pub(crate) extern "C" fn NodeInfo_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
1081 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeNodeInfo) })
1084 /// Read a NodeInfo from a byte array, created by NodeInfo_write
1085 pub extern "C" fn NodeInfo_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_NodeInfoDecodeErrorZ {
1086 let res = crate::c_types::deserialize_obj(ser);
1087 let mut local_res = match res { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::routing::network_graph::NodeInfo { 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() };
1091 /// Serialize the NetworkGraph object into a byte array which can be read by NetworkGraph_read
1092 pub extern "C" fn NetworkGraph_write(obj: &NetworkGraph) -> crate::c_types::derived::CVec_u8Z {
1093 crate::c_types::serialize_obj(unsafe { &*unsafe { &*obj }.inner })
1096 pub(crate) extern "C" fn NetworkGraph_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
1097 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeNetworkGraph) })
1100 /// Read a NetworkGraph from a byte array, created by NetworkGraph_write
1101 pub extern "C" fn NetworkGraph_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_NetworkGraphDecodeErrorZ {
1102 let res = crate::c_types::deserialize_obj(ser);
1103 let mut local_res = match res { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::routing::network_graph::NetworkGraph { 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() };
1106 /// Creates a new, empty, network graph.
1109 pub extern "C" fn NetworkGraph_new(mut genesis_hash: crate::c_types::ThirtyTwoBytes) -> crate::routing::network_graph::NetworkGraph {
1110 let mut ret = lightning::routing::network_graph::NetworkGraph::new(::bitcoin::hash_types::BlockHash::from_slice(&genesis_hash.data[..]).unwrap());
1111 crate::routing::network_graph::NetworkGraph { inner: Box::into_raw(Box::new(ret)), is_owned: true }
1114 /// For an already known node (from channel announcements), update its stored properties from a
1115 /// given node announcement.
1117 /// You probably don't want to call this directly, instead relying on a NetGraphMsgHandler's
1118 /// RoutingMessageHandler implementation to call it indirectly. This may be useful to accept
1119 /// routing messages from a source using a protocol other than the lightning P2P protocol.
1122 pub extern "C" fn NetworkGraph_update_node_from_announcement(this_arg: &mut NetworkGraph, msg: &crate::ln::msgs::NodeAnnouncement) -> crate::c_types::derived::CResult_NoneLightningErrorZ {
1123 let mut ret = unsafe { &mut (*(this_arg.inner as *mut nativeNetworkGraph)) }.update_node_from_announcement(unsafe { &*msg.inner }, secp256k1::SECP256K1);
1124 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { 0u8 /*o*/ }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::ln::msgs::LightningError { inner: Box::into_raw(Box::new(e)), is_owned: true } }).into() };
1128 /// For an already known node (from channel announcements), update its stored properties from a
1129 /// given node announcement without verifying the associated signatures. Because we aren't
1130 /// given the associated signatures here we cannot relay the node announcement to any of our
1134 pub extern "C" fn NetworkGraph_update_node_from_unsigned_announcement(this_arg: &mut NetworkGraph, msg: &crate::ln::msgs::UnsignedNodeAnnouncement) -> crate::c_types::derived::CResult_NoneLightningErrorZ {
1135 let mut ret = unsafe { &mut (*(this_arg.inner as *mut nativeNetworkGraph)) }.update_node_from_unsigned_announcement(unsafe { &*msg.inner });
1136 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { 0u8 /*o*/ }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::ln::msgs::LightningError { inner: Box::into_raw(Box::new(e)), is_owned: true } }).into() };
1140 /// Store or update channel info from a channel announcement.
1142 /// You probably don't want to call this directly, instead relying on a NetGraphMsgHandler's
1143 /// RoutingMessageHandler implementation to call it indirectly. This may be useful to accept
1144 /// routing messages from a source using a protocol other than the lightning P2P protocol.
1146 /// If a `chain::Access` object is provided via `chain_access`, it will be called to verify
1147 /// the corresponding UTXO exists on chain and is correctly-formatted.
1150 pub extern "C" fn NetworkGraph_update_channel_from_announcement(this_arg: &mut NetworkGraph, msg: &crate::ln::msgs::ChannelAnnouncement, chain_access: *mut crate::chain::Access) -> crate::c_types::derived::CResult_NoneLightningErrorZ {
1151 let mut local_chain_access = if chain_access == std::ptr::null_mut() { None } else { Some( { unsafe { *Box::from_raw(chain_access) } }) };
1152 let mut ret = unsafe { &mut (*(this_arg.inner as *mut nativeNetworkGraph)) }.update_channel_from_announcement(unsafe { &*msg.inner }, &local_chain_access, secp256k1::SECP256K1);
1153 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { 0u8 /*o*/ }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::ln::msgs::LightningError { inner: Box::into_raw(Box::new(e)), is_owned: true } }).into() };
1157 /// Store or update channel info from a channel announcement without verifying the associated
1158 /// signatures. Because we aren't given the associated signatures here we cannot relay the
1159 /// channel announcement to any of our peers.
1161 /// If a `chain::Access` object is provided via `chain_access`, it will be called to verify
1162 /// the corresponding UTXO exists on chain and is correctly-formatted.
1165 pub extern "C" fn NetworkGraph_update_channel_from_unsigned_announcement(this_arg: &mut NetworkGraph, msg: &crate::ln::msgs::UnsignedChannelAnnouncement, chain_access: *mut crate::chain::Access) -> crate::c_types::derived::CResult_NoneLightningErrorZ {
1166 let mut local_chain_access = if chain_access == std::ptr::null_mut() { None } else { Some( { unsafe { *Box::from_raw(chain_access) } }) };
1167 let mut ret = unsafe { &mut (*(this_arg.inner as *mut nativeNetworkGraph)) }.update_channel_from_unsigned_announcement(unsafe { &*msg.inner }, &local_chain_access);
1168 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { 0u8 /*o*/ }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::ln::msgs::LightningError { inner: Box::into_raw(Box::new(e)), is_owned: true } }).into() };
1172 /// Close a channel if a corresponding HTLC fail was sent.
1173 /// If permanent, removes a channel from the local storage.
1174 /// May cause the removal of nodes too, if this was their last channel.
1175 /// If not permanent, makes channels unavailable for routing.
1177 pub extern "C" fn NetworkGraph_close_channel_from_update(this_arg: &mut NetworkGraph, mut short_channel_id: u64, mut is_permanent: bool) {
1178 unsafe { &mut (*(this_arg.inner as *mut nativeNetworkGraph)) }.close_channel_from_update(short_channel_id, is_permanent)
1181 /// For an already known (from announcement) channel, update info about one of the directions
1184 /// You probably don't want to call this directly, instead relying on a NetGraphMsgHandler's
1185 /// RoutingMessageHandler implementation to call it indirectly. This may be useful to accept
1186 /// routing messages from a source using a protocol other than the lightning P2P protocol.
1189 pub extern "C" fn NetworkGraph_update_channel(this_arg: &mut NetworkGraph, msg: &crate::ln::msgs::ChannelUpdate) -> crate::c_types::derived::CResult_NoneLightningErrorZ {
1190 let mut ret = unsafe { &mut (*(this_arg.inner as *mut nativeNetworkGraph)) }.update_channel(unsafe { &*msg.inner }, secp256k1::SECP256K1);
1191 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { 0u8 /*o*/ }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::ln::msgs::LightningError { inner: Box::into_raw(Box::new(e)), is_owned: true } }).into() };
1195 /// For an already known (from announcement) channel, update info about one of the directions
1196 /// of the channel without verifying the associated signatures. Because we aren't given the
1197 /// associated signatures here we cannot relay the channel update to any of our peers.
1200 pub extern "C" fn NetworkGraph_update_channel_unsigned(this_arg: &mut NetworkGraph, msg: &crate::ln::msgs::UnsignedChannelUpdate) -> crate::c_types::derived::CResult_NoneLightningErrorZ {
1201 let mut ret = unsafe { &mut (*(this_arg.inner as *mut nativeNetworkGraph)) }.update_channel_unsigned(unsafe { &*msg.inner });
1202 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { 0u8 /*o*/ }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::ln::msgs::LightningError { inner: Box::into_raw(Box::new(e)), is_owned: true } }).into() };