_ Git - ldk-c-bindings/blob - lightning-c-bindings/src/chain/chainmonitor.rs

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