_ Git - ldk-c-bindings/blob - 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) { unimplemented!() }
  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 //! let new_last_sync_timestamp_result = rapid_sync.update_network_graph(snapshot_contents);
  56 //! ```
  57
  58 use alloc::str::FromStr;
  59 use core::ffi::c_void;
  60 use core::convert::Infallible;
  61 use bitcoin::hashes::Hash;
  62 use crate::c_types::*;
  63 #[cfg(feature="no-std")]
  64 use alloc::{vec::Vec, boxed::Box};
  65
  66 pub mod error;
  67 mod processing {
  68
  69 use alloc::str::FromStr;
  70 use core::ffi::c_void;
  71 use core::convert::Infallible;
  72 use bitcoin::hashes::Hash;
  73 use crate::c_types::*;
  74 #[cfg(feature="no-std")]
  75 use alloc::{vec::Vec, boxed::Box};
  76
  77 }
  78
  79 use lightning_rapid_gossip_sync::RapidGossipSync as nativeRapidGossipSyncImport;
  80 pub(crate) type nativeRapidGossipSync = nativeRapidGossipSyncImport<&'static lightning::routing::gossip::NetworkGraph<crate::lightning::util::logger::Logger>, crate::lightning::util::logger::Logger>;
  81
  82 /// The main Rapid Gossip Sync object.
  83 ///
  84 /// See [crate-level documentation] for usage.
  85 ///
  86 /// [crate-level documentation]: crate
  87 #[must_use]
  88 #[repr(C)]
  89 pub struct RapidGossipSync {
  90         /// A pointer to the opaque Rust object.
  91
  92         /// Nearly everywhere, inner must be non-null, however in places where
  93         /// the Rust equivalent takes an Option, it may be set to null to indicate None.
  94         pub inner: *mut nativeRapidGossipSync,
  95         /// Indicates that this is the only struct which contains the same pointer.
  96
  97         /// Rust functions which take ownership of an object provided via an argument require
  98         /// this to be true and invalidate the object pointed to by inner.
  99         pub is_owned: bool,
 100 }
 101
 102 impl Drop for RapidGossipSync {
 103         fn drop(&mut self) {
 104                 if self.is_owned && !<*mut nativeRapidGossipSync>::is_null(self.inner) {
 105                         let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
 106                 }
 107         }
 108 }
 109 /// Frees any resources used by the RapidGossipSync, if is_owned is set and inner is non-NULL.
 110 #[no_mangle]
 111 pub extern "C" fn RapidGossipSync_free(this_obj: RapidGossipSync) { }
 112 #[allow(unused)]
 113 /// Used only if an object of this type is returned as a trait impl by a method
 114 pub(crate) extern "C" fn RapidGossipSync_free_void(this_ptr: *mut c_void) {
 115         let _ = unsafe { Box::from_raw(this_ptr as *mut nativeRapidGossipSync) };
 116 }
 117 #[allow(unused)]
 118 impl RapidGossipSync {
 119         pub(crate) fn get_native_ref(&self) -> &'static nativeRapidGossipSync {
 120                 unsafe { &*ObjOps::untweak_ptr(self.inner) }
 121         }
 122         pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeRapidGossipSync {
 123                 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
 124         }
 125         /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
 126         pub(crate) fn take_inner(mut self) -> *mut nativeRapidGossipSync {
 127                 assert!(self.is_owned);
 128                 let ret = ObjOps::untweak_ptr(self.inner);
 129                 self.inner = core::ptr::null_mut();
 130                 ret
 131         }
 132 }
 133 /// Instantiate a new [`RapidGossipSync`] instance.
 134 #[must_use]
 135 #[no_mangle]
 136 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 {
 137         let mut ret = lightning_rapid_gossip_sync::RapidGossipSync::new(network_graph.get_native_ref(), logger);
 138         crate::lightning_rapid_gossip_sync::RapidGossipSync { inner: ObjOps::heap_alloc(ret), is_owned: true }
 139 }
 140
 141 /// Update network graph from binary data.
 142 /// Returns the last sync timestamp to be used the next time rapid sync data is queried.
 143 ///
 144 /// `update_data`: `&[u8]` binary stream that comprises the update data
 145 #[must_use]
 146 #[no_mangle]
 147 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 {
 148         let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.update_network_graph(update_data.to_slice());
 149         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() };
 150         local_ret
 151 }
 152
 153 /// Update network graph from binary data.
 154 /// Returns the last sync timestamp to be used the next time rapid sync data is queried.
 155 ///
 156 /// `update_data`: `&[u8]` binary stream that comprises the update data
 157 /// `current_time_unix`: `Option<u64>` optional current timestamp to verify data age
 158 #[must_use]
 159 #[no_mangle]
 160 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 {
 161         let mut local_current_time_unix = if current_time_unix.is_some() { Some( { current_time_unix.take() }) } else { None };
 162         let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.update_network_graph_no_std(update_data.to_slice(), local_current_time_unix);
 163         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() };
 164         local_ret
 165 }
 166
 167 /// Returns whether a rapid gossip sync has completed at least once.
 168 #[must_use]
 169 #[no_mangle]
 170 pub extern "C" fn RapidGossipSync_is_initial_sync_complete(this_arg: &crate::lightning_rapid_gossip_sync::RapidGossipSync) -> bool {
 171         let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.is_initial_sync_complete();
 172         ret
 173 }
 174