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