_ Git - ldk-c-bindings/blob - lightning-c-bindings/src/chain/chainmonitor.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 //! Logic to connect off-chain channel management with on-chain transaction monitoring.
  10 //!
  11 //! [`ChainMonitor`] is an implementation of [`chain::Watch`] used both to process blocks and to
  12 //! update [`ChannelMonitor`]s accordingly. If any on-chain events need further processing, it will
  13 //! make those available as [`MonitorEvent`]s to be consumed.
  14 //!
  15 //! [`ChainMonitor`] is parameterized by an optional chain source, which must implement the
  16 //! [`chain::Filter`] trait. This provides a mechanism to signal new relevant outputs back to light
  17 //! clients, such that transactions spending those outputs are included in block data.
  18 //!
  19 //! [`ChainMonitor`] may be used directly to monitor channels locally or as a part of a distributed
  20 //! setup to monitor channels remotely. In the latter case, a custom [`chain::Watch`] implementation
  21 //! would be responsible for routing each update to a remote server and for retrieving monitor
  22 //! events. The remote server would make use of [`ChainMonitor`] for block processing and for
  23 //! servicing [`ChannelMonitor`] updates from the client.
  24
  25 use std::ffi::c_void;
  26 use bitcoin::hashes::Hash;
  27 use crate::c_types::*;
  28
  29
  30 use lightning::chain::chainmonitor::ChainMonitor as nativeChainMonitorImport;
  31 type nativeChainMonitor = nativeChainMonitorImport<crate::chain::keysinterface::Sign, crate::chain::Filter, crate::chain::chaininterface::BroadcasterInterface, crate::chain::chaininterface::FeeEstimator, crate::util::logger::Logger, crate::chain::channelmonitor::Persist>;
  32
  33 /// An implementation of [`chain::Watch`] for monitoring channels.
  34 ///
  35 /// Connected and disconnected blocks must be provided to `ChainMonitor` as documented by
  36 /// [`chain::Watch`]. May be used in conjunction with [`ChannelManager`] to monitor channels locally
  37 /// or used independently to monitor channels remotely. See the [module-level documentation] for
  38 /// details.
  39 ///
  40 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
  41 /// [module-level documentation]: crate::chain::chainmonitor
  42 #[must_use]
  43 #[repr(C)]
  44 pub struct ChainMonitor {
  45         /// A pointer to the opaque Rust object.
  46
  47         /// Nearly everywhere, inner must be non-null, however in places where
  48         /// the Rust equivalent takes an Option, it may be set to null to indicate None.
  49         pub inner: *mut nativeChainMonitor,
  50         /// Indicates that this is the only struct which contains the same pointer.
  51
  52         /// Rust functions which take ownership of an object provided via an argument require
  53         /// this to be true and invalidate the object pointed to by inner.
  54         pub is_owned: bool,
  55 }
  56
  57 impl Drop for ChainMonitor {
  58         fn drop(&mut self) {
  59                 if self.is_owned && !<*mut nativeChainMonitor>::is_null(self.inner) {
  60                         let _ = unsafe { Box::from_raw(self.inner) };
  61                 }
  62         }
  63 }
  64 /// Frees any resources used by the ChainMonitor, if is_owned is set and inner is non-NULL.
  65 #[no_mangle]
  66 pub extern "C" fn ChainMonitor_free(this_obj: ChainMonitor) { }
  67 #[allow(unused)]
  68 /// Used only if an object of this type is returned as a trait impl by a method
  69 extern "C" fn ChainMonitor_free_void(this_ptr: *mut c_void) {
  70         unsafe { let _ = Box::from_raw(this_ptr as *mut nativeChainMonitor); }
  71 }
  72 #[allow(unused)]
  73 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
  74 impl ChainMonitor {
  75         pub(crate) fn take_inner(mut self) -> *mut nativeChainMonitor {
  76                 assert!(self.is_owned);
  77                 let ret = self.inner;
  78                 self.inner = std::ptr::null_mut();
  79                 ret
  80         }
  81 }
  82 /// Dispatches to per-channel monitors, which are responsible for updating their on-chain view
  83 /// of a channel and reacting accordingly based on transactions in the connected block. See
  84 /// [`ChannelMonitor::block_connected`] for details. Any HTLCs that were resolved on chain will
  85 /// be returned by [`chain::Watch::release_pending_monitor_events`].
  86 ///
  87 /// Calls back to [`chain::Filter`] if any monitor indicated new outputs to watch. Subsequent
  88 /// calls must not exclude any transactions matching the new outputs nor any in-block
  89 /// descendants of such transactions. It is not necessary to re-fetch the block to obtain
  90 /// updated `txdata`.
  91 #[no_mangle]
  92 pub extern "C" fn ChainMonitor_block_connected(this_arg: &ChainMonitor, header: *const [u8; 80], mut txdata: crate::c_types::derived::CVec_C2Tuple_usizeTransactionZZ, mut height: u32) {
  93         let mut local_txdata = Vec::new(); for mut item in txdata.into_rust().drain(..) { local_txdata.push( { let (mut orig_txdata_0_0, mut orig_txdata_0_1) = item.to_rust(); let mut local_txdata_0 = (orig_txdata_0_0, orig_txdata_0_1.into_bitcoin()); local_txdata_0 }); };
  94         unsafe { &*this_arg.inner }.block_connected(&::bitcoin::consensus::encode::deserialize(unsafe { &*header }).unwrap(), &local_txdata.iter().map(|(a, b)| (*a, b)).collect::<Vec<_>>()[..], height)
  95 }
  96
  97 /// Dispatches to per-channel monitors, which are responsible for updating their on-chain view
  98 /// of a channel based on the disconnected block. See [`ChannelMonitor::block_disconnected`] for
  99 /// details.
 100 #[no_mangle]
 101 pub extern "C" fn ChainMonitor_block_disconnected(this_arg: &ChainMonitor, header: *const [u8; 80], mut disconnected_height: u32) {
 102         unsafe { &*this_arg.inner }.block_disconnected(&::bitcoin::consensus::encode::deserialize(unsafe { &*header }).unwrap(), disconnected_height)
 103 }
 104
 105 /// Creates a new `ChainMonitor` used to watch on-chain activity pertaining to channels.
 106 ///
 107 /// When an optional chain source implementing [`chain::Filter`] is provided, the chain monitor
 108 /// will call back to it indicating transactions and outputs of interest. This allows clients to
 109 /// pre-filter blocks or only fetch blocks matching a compact filter. Otherwise, clients may
 110 /// always need to fetch full blocks absent another means for determining which blocks contain
 111 /// transactions relevant to the watched channels.
 112 #[must_use]
 113 #[no_mangle]
 114 pub extern "C" fn ChainMonitor_new(chain_source: *mut crate::chain::Filter, mut broadcaster: crate::chain::chaininterface::BroadcasterInterface, mut logger: crate::util::logger::Logger, mut feeest: crate::chain::chaininterface::FeeEstimator, mut persister: crate::chain::channelmonitor::Persist) -> ChainMonitor {
 115         let mut local_chain_source = if chain_source == std::ptr::null_mut() { None } else { Some( { unsafe { *Box::from_raw(chain_source) } }) };
 116         let mut ret = lightning::chain::chainmonitor::ChainMonitor::new(local_chain_source, broadcaster, logger, feeest, persister);
 117         ChainMonitor { inner: Box::into_raw(Box::new(ret)), is_owned: true }
 118 }
 119
 120 impl From<nativeChainMonitor> for crate::chain::Watch {
 121         fn from(obj: nativeChainMonitor) -> Self {
 122                 let mut rust_obj = ChainMonitor { inner: Box::into_raw(Box::new(obj)), is_owned: true };
 123                 let mut ret = ChainMonitor_as_Watch(&rust_obj);
 124                 // 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
 125                 rust_obj.inner = std::ptr::null_mut();
 126                 ret.free = Some(ChainMonitor_free_void);
 127                 ret
 128         }
 129 }
 130 /// Constructs a new Watch which calls the relevant methods on this_arg.
 131 /// This copies the `inner` pointer in this_arg and thus the returned Watch must be freed before this_arg is
 132 #[no_mangle]
 133 pub extern "C" fn ChainMonitor_as_Watch(this_arg: &ChainMonitor) -> crate::chain::Watch {
 134         crate::chain::Watch {
 135                 this_arg: unsafe { (*this_arg).inner as *mut c_void },
 136                 free: None,
 137                 watch_channel: ChainMonitor_Watch_watch_channel,
 138                 update_channel: ChainMonitor_Watch_update_channel,
 139                 release_pending_monitor_events: ChainMonitor_Watch_release_pending_monitor_events,
 140         }
 141 }
 142
 143 #[must_use]
 144 extern "C" fn ChainMonitor_Watch_watch_channel(this_arg: *const c_void, mut funding_outpoint: crate::chain::transaction::OutPoint, mut monitor: crate::chain::channelmonitor::ChannelMonitor) -> crate::c_types::derived::CResult_NoneChannelMonitorUpdateErrZ {
 145         let mut ret = <nativeChainMonitor as lightning::chain::Watch<_>>::watch_channel(unsafe { &mut *(this_arg as *mut nativeChainMonitor) }, *unsafe { Box::from_raw(funding_outpoint.take_inner()) }, *unsafe { Box::from_raw(monitor.take_inner()) });
 146         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::chain::channelmonitor::ChannelMonitorUpdateErr::native_into(e) }).into() };
 147         local_ret
 148 }
 149 #[must_use]
 150 extern "C" fn ChainMonitor_Watch_update_channel(this_arg: *const c_void, mut funding_txo: crate::chain::transaction::OutPoint, mut update: crate::chain::channelmonitor::ChannelMonitorUpdate) -> crate::c_types::derived::CResult_NoneChannelMonitorUpdateErrZ {
 151         let mut ret = <nativeChainMonitor as lightning::chain::Watch<_>>::update_channel(unsafe { &mut *(this_arg as *mut nativeChainMonitor) }, *unsafe { Box::from_raw(funding_txo.take_inner()) }, *unsafe { Box::from_raw(update.take_inner()) });
 152         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::chain::channelmonitor::ChannelMonitorUpdateErr::native_into(e) }).into() };
 153         local_ret
 154 }
 155 #[must_use]
 156 extern "C" fn ChainMonitor_Watch_release_pending_monitor_events(this_arg: *const c_void) -> crate::c_types::derived::CVec_MonitorEventZ {
 157         let mut ret = <nativeChainMonitor as lightning::chain::Watch<_>>::release_pending_monitor_events(unsafe { &mut *(this_arg as *mut nativeChainMonitor) }, );
 158         let mut local_ret = Vec::new(); for mut item in ret.drain(..) { local_ret.push( { crate::chain::channelmonitor::MonitorEvent::native_into(item) }); };
 159         local_ret.into()
 160 }
 161
 162 impl From<nativeChainMonitor> for crate::util::events::EventsProvider {
 163         fn from(obj: nativeChainMonitor) -> Self {
 164                 let mut rust_obj = ChainMonitor { inner: Box::into_raw(Box::new(obj)), is_owned: true };
 165                 let mut ret = ChainMonitor_as_EventsProvider(&rust_obj);
 166                 // 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
 167                 rust_obj.inner = std::ptr::null_mut();
 168                 ret.free = Some(ChainMonitor_free_void);
 169                 ret
 170         }
 171 }
 172 /// Constructs a new EventsProvider which calls the relevant methods on this_arg.
 173 /// This copies the `inner` pointer in this_arg and thus the returned EventsProvider must be freed before this_arg is
 174 #[no_mangle]
 175 pub extern "C" fn ChainMonitor_as_EventsProvider(this_arg: &ChainMonitor) -> crate::util::events::EventsProvider {
 176         crate::util::events::EventsProvider {
 177                 this_arg: unsafe { (*this_arg).inner as *mut c_void },
 178                 free: None,
 179                 get_and_clear_pending_events: ChainMonitor_EventsProvider_get_and_clear_pending_events,
 180         }
 181 }
 182
 183 #[must_use]
 184 extern "C" fn ChainMonitor_EventsProvider_get_and_clear_pending_events(this_arg: *const c_void) -> crate::c_types::derived::CVec_EventZ {
 185         let mut ret = <nativeChainMonitor as lightning::util::events::EventsProvider<>>::get_and_clear_pending_events(unsafe { &mut *(this_arg as *mut nativeChainMonitor) }, );
 186         let mut local_ret = Vec::new(); for mut item in ret.drain(..) { local_ret.push( { crate::util::events::Event::native_into(item) }); };
 187         local_ret.into()
 188 }
 189