Update auto-generated bindings
[ldk-c-bindings] / lightning-c-bindings / src / lightning_rapid_gossip_sync / mod.rs
1 // This file is Copyright its original authors, visible in version control
2 // history and in the source files from which this was generated.
3 //
4 // This file is licensed under the license available in the LICENSE or LICENSE.md
5 // file in the root of this repository or, if no such file exists, the same
6 // license as that which applies to the original source files from which this
7 // source was automatically generated.
8
9 //! This crate exposes client functionality to rapidly sync gossip data, aimed primarily at mobile
10 //! devices.
11 //!
12 //! The rapid gossip sync server will provide a compressed response containing differential gossip
13 //! data. The gossip data is formatted compactly, omitting signatures and opportunistically
14 //! incremental where previous channel updates are known. This mechanism is enabled when the
15 //! timestamp of the last known channel update is communicated. A reference server implementation
16 //! can be found [on Github](https://github.com/lightningdevkit/rapid-gossip-sync-server).
17 //!
18 //! The primary benefit of this syncing mechanism is that it allows a low-powered client to offload
19 //! the validation of gossip signatures to a semi-trusted server. This enables the client to
20 //! privately calculate routes for payments, and to do so much faster than requiring a full
21 //! peer-to-peer gossip sync to complete.
22 //!
23 //! The server calculates its response on the basis of a client-provided `latest_seen` timestamp,
24 //! i.e., the server will return all rapid gossip sync data it has seen after the given timestamp.
25 //!
26 //! # Getting Started
27 //! Firstly, the data needs to be retrieved from the server. For example, you could use the server
28 //! at <https://rapidsync.lightningdevkit.org> with the following request format:
29 //!
30 //! ```shell
31 //! curl -o rapid_sync.lngossip https://rapidsync.lightningdevkit.org/snapshot/<last_sync_timestamp>
32 //! ```
33 //! Note that the first ever rapid sync should use `0` for `last_sync_timestamp`.
34 //!
35 //! After the gossip data snapshot has been downloaded, one of the client's graph processing
36 //! functions needs to be called. In this example, we process the update by reading its contents
37 //! from disk, which we do by calling [`RapidGossipSync::update_network_graph`]:
38 //!
39 //! ```
40 //! use bitcoin::blockdata::constants::genesis_block;
41 //! use bitcoin::Network;
42 //! use lightning::routing::gossip::NetworkGraph;
43 //! use lightning_rapid_gossip_sync::RapidGossipSync;
44 //!
45 //! # use lightning::util::logger::{Logger, Record};
46 //! # struct FakeLogger {}
47 //! # impl Logger for FakeLogger {
48 //! #     fn log(&self, record: &Record) { }
49 //! # }
50 //! # let logger = FakeLogger {};
51 //!
52 //! let network_graph = NetworkGraph::new(Network::Bitcoin, &logger);
53 //! let rapid_sync = RapidGossipSync::new(&network_graph, &logger);
54 //! let snapshot_contents: &[u8] = &[0; 0];
55 //! // In no-std you need to provide the current time in unix epoch seconds
56 //! // otherwise you can use update_network_graph
57 //! let current_time_unix = 0;
58 //! let new_last_sync_timestamp_result = rapid_sync.update_network_graph_no_std(snapshot_contents, Some(current_time_unix));
59 //! ```
60
61 use alloc::str::FromStr;
62 use alloc::string::String;
63 use core::ffi::c_void;
64 use core::convert::Infallible;
65 use bitcoin::hashes::Hash;
66 use crate::c_types::*;
67 #[cfg(feature="no-std")]
68 use alloc::{vec::Vec, boxed::Box};
69
70 pub mod error;
71 mod processing {
72
73 use alloc::str::FromStr;
74 use alloc::string::String;
75 use core::ffi::c_void;
76 use core::convert::Infallible;
77 use bitcoin::hashes::Hash;
78 use crate::c_types::*;
79 #[cfg(feature="no-std")]
80 use alloc::{vec::Vec, boxed::Box};
81
82 }
83
84 use lightning_rapid_gossip_sync::RapidGossipSync as nativeRapidGossipSyncImport;
85 pub(crate) type nativeRapidGossipSync = nativeRapidGossipSyncImport<&'static lightning::routing::gossip::NetworkGraph<crate::lightning::util::logger::Logger>, crate::lightning::util::logger::Logger>;
86
87 /// The main Rapid Gossip Sync object.
88 ///
89 /// See [crate-level documentation] for usage.
90 ///
91 /// [crate-level documentation]: crate
92 #[must_use]
93 #[repr(C)]
94 pub struct RapidGossipSync {
95         /// A pointer to the opaque Rust object.
96
97         /// Nearly everywhere, inner must be non-null, however in places where
98         /// the Rust equivalent takes an Option, it may be set to null to indicate None.
99         pub inner: *mut nativeRapidGossipSync,
100         /// Indicates that this is the only struct which contains the same pointer.
101
102         /// Rust functions which take ownership of an object provided via an argument require
103         /// this to be true and invalidate the object pointed to by inner.
104         pub is_owned: bool,
105 }
106
107 impl Drop for RapidGossipSync {
108         fn drop(&mut self) {
109                 if self.is_owned && !<*mut nativeRapidGossipSync>::is_null(self.inner) {
110                         let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
111                 }
112         }
113 }
114 /// Frees any resources used by the RapidGossipSync, if is_owned is set and inner is non-NULL.
115 #[no_mangle]
116 pub extern "C" fn RapidGossipSync_free(this_obj: RapidGossipSync) { }
117 #[allow(unused)]
118 /// Used only if an object of this type is returned as a trait impl by a method
119 pub(crate) extern "C" fn RapidGossipSync_free_void(this_ptr: *mut c_void) {
120         let _ = unsafe { Box::from_raw(this_ptr as *mut nativeRapidGossipSync) };
121 }
122 #[allow(unused)]
123 impl RapidGossipSync {
124         pub(crate) fn get_native_ref(&self) -> &'static nativeRapidGossipSync {
125                 unsafe { &*ObjOps::untweak_ptr(self.inner) }
126         }
127         pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeRapidGossipSync {
128                 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
129         }
130         /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
131         pub(crate) fn take_inner(mut self) -> *mut nativeRapidGossipSync {
132                 assert!(self.is_owned);
133                 let ret = ObjOps::untweak_ptr(self.inner);
134                 self.inner = core::ptr::null_mut();
135                 ret
136         }
137 }
138 /// Instantiate a new [`RapidGossipSync`] instance.
139 #[must_use]
140 #[no_mangle]
141 pub extern "C" fn RapidGossipSync_new(network_graph: &crate::lightning::routing::gossip::NetworkGraph, mut logger: crate::lightning::util::logger::Logger) -> crate::lightning_rapid_gossip_sync::RapidGossipSync {
142         let mut ret = lightning_rapid_gossip_sync::RapidGossipSync::new(network_graph.get_native_ref(), logger);
143         crate::lightning_rapid_gossip_sync::RapidGossipSync { inner: ObjOps::heap_alloc(ret), is_owned: true }
144 }
145
146 /// Sync gossip data from a file.
147 /// Returns the last sync timestamp to be used the next time rapid sync data is queried.
148 ///
149 /// `network_graph`: The network graph to apply the updates to
150 ///
151 /// `sync_path`: Path to the file where the gossip update data is located
152 ///
153 #[must_use]
154 #[no_mangle]
155 pub extern "C" fn RapidGossipSync_sync_network_graph_with_file_path(this_arg: &crate::lightning_rapid_gossip_sync::RapidGossipSync, mut sync_path: crate::c_types::Str) -> crate::c_types::derived::CResult_u32GraphSyncErrorZ {
156         let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.sync_network_graph_with_file_path(sync_path.into_str());
157         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::lightning_rapid_gossip_sync::error::GraphSyncError::native_into(e) }).into() };
158         local_ret
159 }
160
161 /// Update network graph from binary data.
162 /// Returns the last sync timestamp to be used the next time rapid sync data is queried.
163 ///
164 /// `update_data`: `&[u8]` binary stream that comprises the update data
165 #[must_use]
166 #[no_mangle]
167 pub extern "C" fn RapidGossipSync_update_network_graph(this_arg: &crate::lightning_rapid_gossip_sync::RapidGossipSync, mut update_data: crate::c_types::u8slice) -> crate::c_types::derived::CResult_u32GraphSyncErrorZ {
168         let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.update_network_graph(update_data.to_slice());
169         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::lightning_rapid_gossip_sync::error::GraphSyncError::native_into(e) }).into() };
170         local_ret
171 }
172
173 /// Update network graph from binary data.
174 /// Returns the last sync timestamp to be used the next time rapid sync data is queried.
175 ///
176 /// `update_data`: `&[u8]` binary stream that comprises the update data
177 /// `current_time_unix`: `Option<u64>` optional current timestamp to verify data age
178 #[must_use]
179 #[no_mangle]
180 pub extern "C" fn RapidGossipSync_update_network_graph_no_std(this_arg: &crate::lightning_rapid_gossip_sync::RapidGossipSync, mut update_data: crate::c_types::u8slice, mut current_time_unix: crate::c_types::derived::COption_u64Z) -> crate::c_types::derived::CResult_u32GraphSyncErrorZ {
181         let mut local_current_time_unix = if current_time_unix.is_some() { Some( { current_time_unix.take() }) } else { None };
182         let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.update_network_graph_no_std(update_data.to_slice(), local_current_time_unix);
183         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::lightning_rapid_gossip_sync::error::GraphSyncError::native_into(e) }).into() };
184         local_ret
185 }
186
187 /// Returns whether a rapid gossip sync has completed at least once.
188 #[must_use]
189 #[no_mangle]
190 pub extern "C" fn RapidGossipSync_is_initial_sync_complete(this_arg: &crate::lightning_rapid_gossip_sync::RapidGossipSync) -> bool {
191         let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.is_initial_sync_complete();
192         ret
193 }
194