_ Git - ldk-c-bindings/blob - lightning-c-bindings/src/lightning_persister.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 //! Utilities that handle persisting Rust-Lightning data to disk via standard filesystem APIs.
  10
  11 use std::ffi::c_void;
  12 use bitcoin::hashes::Hash;
  13 use crate::c_types::*;
  14
  15
  16 use lightning_persister::FilesystemPersister as nativeFilesystemPersisterImport;
  17 type nativeFilesystemPersister = nativeFilesystemPersisterImport;
  18
  19 /// FilesystemPersister persists channel data on disk, where each channel's
  20 /// data is stored in a file named after its funding outpoint.
  21 ///
  22 /// Warning: this module does the best it can with calls to persist data, but it
  23 /// can only guarantee that the data is passed to the drive. It is up to the
  24 /// drive manufacturers to do the actual persistence properly, which they often
  25 /// don't (especially on consumer-grade hardware). Therefore, it is up to the
  26 /// user to validate their entire storage stack, to ensure the writes are
  27 /// persistent.
  28 /// Corollary: especially when dealing with larger amounts of money, it is best
  29 /// practice to have multiple channel data backups and not rely only on one
  30 /// FilesystemPersister.
  31 #[must_use]
  32 #[repr(C)]
  33 pub struct FilesystemPersister {
  34         /// A pointer to the opaque Rust object.
  35
  36         /// Nearly everywhere, inner must be non-null, however in places where
  37         /// the Rust equivalent takes an Option, it may be set to null to indicate None.
  38         pub inner: *mut nativeFilesystemPersister,
  39         /// Indicates that this is the only struct which contains the same pointer.
  40
  41         /// Rust functions which take ownership of an object provided via an argument require
  42         /// this to be true and invalidate the object pointed to by inner.
  43         pub is_owned: bool,
  44 }
  45
  46 impl Drop for FilesystemPersister {
  47         fn drop(&mut self) {
  48                 if self.is_owned && !<*mut nativeFilesystemPersister>::is_null(self.inner) {
  49                         let _ = unsafe { Box::from_raw(self.inner) };
  50                 }
  51         }
  52 }
  53 /// Frees any resources used by the FilesystemPersister, if is_owned is set and inner is non-NULL.
  54 #[no_mangle]
  55 pub extern "C" fn FilesystemPersister_free(this_obj: FilesystemPersister) { }
  56 #[allow(unused)]
  57 /// Used only if an object of this type is returned as a trait impl by a method
  58 extern "C" fn FilesystemPersister_free_void(this_ptr: *mut c_void) {
  59         unsafe { let _ = Box::from_raw(this_ptr as *mut nativeFilesystemPersister); }
  60 }
  61 #[allow(unused)]
  62 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
  63 impl FilesystemPersister {
  64         pub(crate) fn take_inner(mut self) -> *mut nativeFilesystemPersister {
  65                 assert!(self.is_owned);
  66                 let ret = self.inner;
  67                 self.inner = std::ptr::null_mut();
  68                 ret
  69         }
  70 }
  71 /// Initialize a new FilesystemPersister and set the path to the individual channels'
  72 /// files.
  73 #[must_use]
  74 #[no_mangle]
  75 pub extern "C" fn FilesystemPersister_new(mut path_to_channel_data: crate::c_types::derived::CVec_u8Z) -> FilesystemPersister {
  76         let mut ret = lightning_persister::FilesystemPersister::new(String::from_utf8(path_to_channel_data.into_rust()).unwrap());
  77         FilesystemPersister { inner: Box::into_raw(Box::new(ret)), is_owned: true }
  78 }
  79
  80 /// Get the directory which was provided when this persister was initialized.
  81 #[must_use]
  82 #[no_mangle]
  83 pub extern "C" fn FilesystemPersister_get_data_dir(this_arg: &FilesystemPersister) -> crate::c_types::derived::CVec_u8Z {
  84         let mut ret = unsafe { &*this_arg.inner }.get_data_dir();
  85         ret.into_bytes().into()
  86 }
  87
  88 /// Writes the provided `ChannelManager` to the path provided at `FilesystemPersister`
  89 /// initialization, within a file called \"manager\".
  90 #[must_use]
  91 #[no_mangle]
  92 pub extern "C" fn FilesystemPersister_persist_manager(mut data_dir: crate::c_types::derived::CVec_u8Z, manager: &crate::lightning::ln::channelmanager::ChannelManager) -> crate::c_types::derived::CResult_NoneErrorZ {
  93         let mut ret = lightning_persister::FilesystemPersister::persist_manager(String::from_utf8(data_dir.into_rust()).unwrap(), unsafe { &*manager.inner });
  94         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::c_types::IOError::from_rust(e) }).into() };
  95         local_ret
  96 }
  97
  98 /// Read `ChannelMonitor`s from disk.
  99 #[must_use]
 100 #[no_mangle]
 101 pub extern "C" fn FilesystemPersister_read_channelmonitors(this_arg: &FilesystemPersister, mut keys_manager: crate::lightning::chain::keysinterface::KeysInterface) -> crate::c_types::derived::CResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ {
 102         let mut ret = unsafe { &*this_arg.inner }.read_channelmonitors(keys_manager);
 103         let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { let mut local_ret_0 = Vec::new(); for mut item in o.drain(..) { local_ret_0.push( { let (mut orig_ret_0_0_0, mut orig_ret_0_0_1) = item; let mut local_ret_0_0 = (crate::c_types::ThirtyTwoBytes { data: orig_ret_0_0_0.into_inner() }, crate::lightning::chain::channelmonitor::ChannelMonitor { inner: Box::into_raw(Box::new(orig_ret_0_0_1)), is_owned: true }).into(); local_ret_0_0 }); }; local_ret_0.into() }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::c_types::IOError::from_rust(e) }).into() };
 104         local_ret
 105 }
 106
 107 impl From<nativeFilesystemPersister> for crate::lightning::chain::channelmonitor::Persist {
 108         fn from(obj: nativeFilesystemPersister) -> Self {
 109                 let mut rust_obj = FilesystemPersister { inner: Box::into_raw(Box::new(obj)), is_owned: true };
 110                 let mut ret = FilesystemPersister_as_Persist(&rust_obj);
 111                 // 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
 112                 rust_obj.inner = std::ptr::null_mut();
 113                 ret.free = Some(FilesystemPersister_free_void);
 114                 ret
 115         }
 116 }
 117 /// Constructs a new Persist which calls the relevant methods on this_arg.
 118 /// This copies the `inner` pointer in this_arg and thus the returned Persist must be freed before this_arg is
 119 #[no_mangle]
 120 pub extern "C" fn FilesystemPersister_as_Persist(this_arg: &FilesystemPersister) -> crate::lightning::chain::channelmonitor::Persist {
 121         crate::lightning::chain::channelmonitor::Persist {
 122                 this_arg: unsafe { (*this_arg).inner as *mut c_void },
 123                 free: None,
 124                 persist_new_channel: FilesystemPersister_Persist_persist_new_channel,
 125                 update_persisted_channel: FilesystemPersister_Persist_update_persisted_channel,
 126         }
 127 }
 128
 129 #[must_use]
 130 extern "C" fn FilesystemPersister_Persist_persist_new_channel(this_arg: *const c_void, mut funding_txo: crate::lightning::chain::transaction::OutPoint, monitor: &crate::lightning::chain::channelmonitor::ChannelMonitor) -> crate::c_types::derived::CResult_NoneChannelMonitorUpdateErrZ {
 131         let mut ret = <nativeFilesystemPersister as lightning::chain::channelmonitor::Persist<_>>::persist_new_channel(unsafe { &mut *(this_arg as *mut nativeFilesystemPersister) }, *unsafe { Box::from_raw(funding_txo.take_inner()) }, unsafe { &*monitor.inner });
 132         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::lightning::chain::channelmonitor::ChannelMonitorUpdateErr::native_into(e) }).into() };
 133         local_ret
 134 }
 135 #[must_use]
 136 extern "C" fn FilesystemPersister_Persist_update_persisted_channel(this_arg: *const c_void, mut funding_txo: crate::lightning::chain::transaction::OutPoint, _update: &crate::lightning::chain::channelmonitor::ChannelMonitorUpdate, monitor: &crate::lightning::chain::channelmonitor::ChannelMonitor) -> crate::c_types::derived::CResult_NoneChannelMonitorUpdateErrZ {
 137         let mut ret = <nativeFilesystemPersister as lightning::chain::channelmonitor::Persist<_>>::update_persisted_channel(unsafe { &mut *(this_arg as *mut nativeFilesystemPersister) }, *unsafe { Box::from_raw(funding_txo.take_inner()) }, unsafe { &*_update.inner }, unsafe { &*monitor.inner });
 138         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::lightning::chain::channelmonitor::ChannelMonitorUpdateErr::native_into(e) }).into() };
 139         local_ret
 140 }
 141