1 // This file is Copyright its original authors, visible in version control
2 // history and in the source files from which this was generated.
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.
9 //! Logic to connect off-chain channel management with on-chain transaction monitoring.
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.
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.
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.
25 use alloc::str::FromStr;
26 use alloc::string::String;
27 use core::ffi::c_void;
28 use core::convert::Infallible;
29 use bitcoin::hashes::Hash;
30 use crate::c_types::*;
31 #[cfg(feature="no-std")]
32 use alloc::{vec::Vec, boxed::Box};
36 use alloc::str::FromStr;
37 use alloc::string::String;
38 use core::ffi::c_void;
39 use core::convert::Infallible;
40 use bitcoin::hashes::Hash;
41 use crate::c_types::*;
42 #[cfg(feature="no-std")]
43 use alloc::{vec::Vec, boxed::Box};
47 use lightning::chain::chainmonitor::MonitorUpdateId as nativeMonitorUpdateIdImport;
48 pub(crate) type nativeMonitorUpdateId = nativeMonitorUpdateIdImport;
50 /// An opaque identifier describing a specific [`Persist`] method call.
53 pub struct MonitorUpdateId {
54 /// A pointer to the opaque Rust object.
56 /// Nearly everywhere, inner must be non-null, however in places where
57 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
58 pub inner: *mut nativeMonitorUpdateId,
59 /// Indicates that this is the only struct which contains the same pointer.
61 /// Rust functions which take ownership of an object provided via an argument require
62 /// this to be true and invalidate the object pointed to by inner.
66 impl Drop for MonitorUpdateId {
68 if self.is_owned && !<*mut nativeMonitorUpdateId>::is_null(self.inner) {
69 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
73 /// Frees any resources used by the MonitorUpdateId, if is_owned is set and inner is non-NULL.
75 pub extern "C" fn MonitorUpdateId_free(this_obj: MonitorUpdateId) { }
77 /// Used only if an object of this type is returned as a trait impl by a method
78 pub(crate) extern "C" fn MonitorUpdateId_free_void(this_ptr: *mut c_void) {
79 let _ = unsafe { Box::from_raw(this_ptr as *mut nativeMonitorUpdateId) };
82 impl MonitorUpdateId {
83 pub(crate) fn get_native_ref(&self) -> &'static nativeMonitorUpdateId {
84 unsafe { &*ObjOps::untweak_ptr(self.inner) }
86 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeMonitorUpdateId {
87 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
89 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
90 pub(crate) fn take_inner(mut self) -> *mut nativeMonitorUpdateId {
91 assert!(self.is_owned);
92 let ret = ObjOps::untweak_ptr(self.inner);
93 self.inner = core::ptr::null_mut();
97 /// Get a string which allows debug introspection of a MonitorUpdateId object
98 pub extern "C" fn MonitorUpdateId_debug_str_void(o: *const c_void) -> Str {
99 alloc::format!("{:?}", unsafe { o as *const crate::lightning::chain::chainmonitor::MonitorUpdateId }).into()}
100 impl Clone for MonitorUpdateId {
101 fn clone(&self) -> Self {
103 inner: if <*mut nativeMonitorUpdateId>::is_null(self.inner) { core::ptr::null_mut() } else {
104 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
110 /// Used only if an object of this type is returned as a trait impl by a method
111 pub(crate) extern "C" fn MonitorUpdateId_clone_void(this_ptr: *const c_void) -> *mut c_void {
112 Box::into_raw(Box::new(unsafe { (*(this_ptr as *const nativeMonitorUpdateId)).clone() })) as *mut c_void
115 /// Creates a copy of the MonitorUpdateId
116 pub extern "C" fn MonitorUpdateId_clone(orig: &MonitorUpdateId) -> MonitorUpdateId {
119 /// Generates a non-cryptographic 64-bit hash of the MonitorUpdateId.
121 pub extern "C" fn MonitorUpdateId_hash(o: &MonitorUpdateId) -> u64 {
122 if o.inner.is_null() { return 0; }
123 // Note that we'd love to use alloc::collections::hash_map::DefaultHasher but it's not in core
125 let mut hasher = core::hash::SipHasher::new();
126 core::hash::Hash::hash(o.get_native_ref(), &mut hasher);
127 core::hash::Hasher::finish(&hasher)
129 /// Checks if two MonitorUpdateIds contain equal inner contents.
130 /// This ignores pointers and is_owned flags and looks at the values in fields.
131 /// Two objects with NULL inner values will be considered "equal" here.
133 pub extern "C" fn MonitorUpdateId_eq(a: &MonitorUpdateId, b: &MonitorUpdateId) -> bool {
134 if a.inner == b.inner { return true; }
135 if a.inner.is_null() || b.inner.is_null() { return false; }
136 if a.get_native_ref() == b.get_native_ref() { true } else { false }
138 /// `Persist` defines behavior for persisting channel monitors: this could mean
139 /// writing once to disk, and/or uploading to one or more backup services.
141 /// Persistence can happen in one of two ways - synchronously completing before the trait method
142 /// calls return or asynchronously in the background.
144 /// # For those implementing synchronous persistence
146 /// * If persistence completes fully (including any relevant `fsync()` calls), the implementation
147 /// should return [`ChannelMonitorUpdateStatus::Completed`], indicating normal channel operation
150 /// * If persistence fails for some reason, implementations should consider returning
151 /// [`ChannelMonitorUpdateStatus::InProgress`] and retry all pending persistence operations in
152 /// the background with [`ChainMonitor::list_pending_monitor_updates`] and
153 /// [`ChainMonitor::get_monitor`].
155 /// Once a full [`ChannelMonitor`] has been persisted, all pending updates for that channel can
156 /// be marked as complete via [`ChainMonitor::channel_monitor_updated`].
158 /// If at some point no further progress can be made towards persisting the pending updates, the
159 /// node should simply shut down.
161 /// * If the persistence has failed and cannot be retried further (e.g. because of an outage),
162 /// [`ChannelMonitorUpdateStatus::UnrecoverableError`] can be used, though this will result in
163 /// an immediate panic and future operations in LDK generally failing.
165 /// # For those implementing asynchronous persistence
167 /// All calls should generally spawn a background task and immediately return
168 /// [`ChannelMonitorUpdateStatus::InProgress`]. Once the update completes,
169 /// [`ChainMonitor::channel_monitor_updated`] should be called with the corresponding
170 /// [`MonitorUpdateId`].
172 /// Note that unlike the direct [`chain::Watch`] interface,
173 /// [`ChainMonitor::channel_monitor_updated`] must be called once for *each* update which occurs.
175 /// If at some point no further progress can be made towards persisting a pending update, the node
176 /// should simply shut down. Until then, the background task should either loop indefinitely, or
177 /// persistence should be regularly retried with [`ChainMonitor::list_pending_monitor_updates`]
178 /// and [`ChainMonitor::get_monitor`] (note that if a full monitor is persisted all pending
179 /// monitor updates may be marked completed).
181 /// # Using remote watchtowers
183 /// Watchtowers may be updated as a part of an implementation of this trait, utilizing the async
184 /// update process described above while the watchtower is being updated. The following methods are
185 /// provided for bulding transactions for a watchtower:
186 /// [`ChannelMonitor::initial_counterparty_commitment_tx`],
187 /// [`ChannelMonitor::counterparty_commitment_txs_from_update`],
188 /// [`ChannelMonitor::sign_to_local_justice_tx`], [`TrustedCommitmentTransaction::revokeable_output_index`],
189 /// [`TrustedCommitmentTransaction::build_to_local_justice_tx`].
191 /// [`TrustedCommitmentTransaction::revokeable_output_index`]: crate::ln::chan_utils::TrustedCommitmentTransaction::revokeable_output_index
192 /// [`TrustedCommitmentTransaction::build_to_local_justice_tx`]: crate::ln::chan_utils::TrustedCommitmentTransaction::build_to_local_justice_tx
195 /// An opaque pointer which is passed to your function implementations as an argument.
196 /// This has no meaning in the LDK, and can be NULL or any other value.
197 pub this_arg: *mut c_void,
198 /// Persist a new channel's data in response to a [`chain::Watch::watch_channel`] call. This is
199 /// called by [`ChannelManager`] for new channels, or may be called directly, e.g. on startup.
201 /// The data can be stored any way you want, but the identifier provided by LDK is the
202 /// channel's outpoint (and it is up to you to maintain a correct mapping between the outpoint
203 /// and the stored channel data). Note that you **must** persist every new monitor to disk.
205 /// The `update_id` is used to identify this call to [`ChainMonitor::channel_monitor_updated`],
206 /// if you return [`ChannelMonitorUpdateStatus::InProgress`].
208 /// See [`Writeable::write`] on [`ChannelMonitor`] for writing out a `ChannelMonitor`
209 /// and [`ChannelMonitorUpdateStatus`] for requirements when returning errors.
211 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
212 /// [`Writeable::write`]: crate::util::ser::Writeable::write
213 pub persist_new_channel: extern "C" fn (this_arg: *const c_void, channel_funding_outpoint: crate::lightning::chain::transaction::OutPoint, data: &crate::lightning::chain::channelmonitor::ChannelMonitor, update_id: crate::lightning::chain::chainmonitor::MonitorUpdateId) -> crate::lightning::chain::ChannelMonitorUpdateStatus,
214 /// Update one channel's data. The provided [`ChannelMonitor`] has already applied the given
217 /// Note that on every update, you **must** persist either the [`ChannelMonitorUpdate`] or the
218 /// updated monitor itself to disk/backups. See the [`Persist`] trait documentation for more
221 /// During blockchain synchronization operations, and in some rare cases, this may be called with
222 /// no [`ChannelMonitorUpdate`], in which case the full [`ChannelMonitor`] needs to be persisted.
223 /// Note that after the full [`ChannelMonitor`] is persisted any previous
224 /// [`ChannelMonitorUpdate`]s which were persisted should be discarded - they can no longer be
225 /// applied to the persisted [`ChannelMonitor`] as they were already applied.
227 /// If an implementer chooses to persist the updates only, they need to make
228 /// sure that all the updates are applied to the `ChannelMonitors` *before*
229 /// the set of channel monitors is given to the `ChannelManager`
230 /// deserialization routine. See [`ChannelMonitor::update_monitor`] for
231 /// applying a monitor update to a monitor. If full `ChannelMonitors` are
232 /// persisted, then there is no need to persist individual updates.
234 /// Note that there could be a performance tradeoff between persisting complete
235 /// channel monitors on every update vs. persisting only updates and applying
236 /// them in batches. The size of each monitor grows `O(number of state updates)`
237 /// whereas updates are small and `O(1)`.
239 /// The `update_id` is used to identify this call to [`ChainMonitor::channel_monitor_updated`],
240 /// if you return [`ChannelMonitorUpdateStatus::InProgress`].
242 /// See [`Writeable::write`] on [`ChannelMonitor`] for writing out a `ChannelMonitor`,
243 /// [`Writeable::write`] on [`ChannelMonitorUpdate`] for writing out an update, and
244 /// [`ChannelMonitorUpdateStatus`] for requirements when returning errors.
246 /// [`Writeable::write`]: crate::util::ser::Writeable::write
248 /// Note that update (or a relevant inner pointer) may be NULL or all-0s to represent None
249 pub update_persisted_channel: extern "C" fn (this_arg: *const c_void, channel_funding_outpoint: crate::lightning::chain::transaction::OutPoint, update: crate::lightning::chain::channelmonitor::ChannelMonitorUpdate, data: &crate::lightning::chain::channelmonitor::ChannelMonitor, update_id: crate::lightning::chain::chainmonitor::MonitorUpdateId) -> crate::lightning::chain::ChannelMonitorUpdateStatus,
250 /// Prevents the channel monitor from being loaded on startup.
252 /// Archiving the data in a backup location (rather than deleting it fully) is useful for
253 /// hedging against data loss in case of unexpected failure.
254 pub archive_persisted_channel: extern "C" fn (this_arg: *const c_void, channel_funding_outpoint: crate::lightning::chain::transaction::OutPoint),
255 /// Frees any resources associated with this object given its this_arg pointer.
256 /// Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
257 pub free: Option<extern "C" fn(this_arg: *mut c_void)>,
259 unsafe impl Send for Persist {}
260 unsafe impl Sync for Persist {}
262 pub(crate) fn Persist_clone_fields(orig: &Persist) -> Persist {
264 this_arg: orig.this_arg,
265 persist_new_channel: Clone::clone(&orig.persist_new_channel),
266 update_persisted_channel: Clone::clone(&orig.update_persisted_channel),
267 archive_persisted_channel: Clone::clone(&orig.archive_persisted_channel),
268 free: Clone::clone(&orig.free),
272 use lightning::chain::chainmonitor::Persist as rustPersist;
273 impl rustPersist<crate::lightning::sign::ecdsa::WriteableEcdsaChannelSigner, > for Persist {
274 fn persist_new_channel(&self, mut channel_funding_outpoint: lightning::chain::transaction::OutPoint, mut data: &lightning::chain::channelmonitor::ChannelMonitor<crate::lightning::sign::ecdsa::WriteableEcdsaChannelSigner>, mut update_id: lightning::chain::chainmonitor::MonitorUpdateId) -> lightning::chain::ChannelMonitorUpdateStatus {
275 let mut ret = (self.persist_new_channel)(self.this_arg, crate::lightning::chain::transaction::OutPoint { inner: ObjOps::heap_alloc(channel_funding_outpoint), is_owned: true }, &crate::lightning::chain::channelmonitor::ChannelMonitor { inner: unsafe { ObjOps::nonnull_ptr_to_inner((data as *const lightning::chain::channelmonitor::ChannelMonitor<_, >) as *mut _) }, is_owned: false }, crate::lightning::chain::chainmonitor::MonitorUpdateId { inner: ObjOps::heap_alloc(update_id), is_owned: true });
278 fn update_persisted_channel(&self, mut channel_funding_outpoint: lightning::chain::transaction::OutPoint, mut update: Option<&lightning::chain::channelmonitor::ChannelMonitorUpdate>, mut data: &lightning::chain::channelmonitor::ChannelMonitor<crate::lightning::sign::ecdsa::WriteableEcdsaChannelSigner>, mut update_id: lightning::chain::chainmonitor::MonitorUpdateId) -> lightning::chain::ChannelMonitorUpdateStatus {
279 let mut local_update = crate::lightning::chain::channelmonitor::ChannelMonitorUpdate { inner: unsafe { (if update.is_none() { core::ptr::null() } else { ObjOps::nonnull_ptr_to_inner( { (update.unwrap()) }) } as *const lightning::chain::channelmonitor::ChannelMonitorUpdate<>) as *mut _ }, is_owned: false };
280 let mut ret = (self.update_persisted_channel)(self.this_arg, crate::lightning::chain::transaction::OutPoint { inner: ObjOps::heap_alloc(channel_funding_outpoint), is_owned: true }, local_update, &crate::lightning::chain::channelmonitor::ChannelMonitor { inner: unsafe { ObjOps::nonnull_ptr_to_inner((data as *const lightning::chain::channelmonitor::ChannelMonitor<_, >) as *mut _) }, is_owned: false }, crate::lightning::chain::chainmonitor::MonitorUpdateId { inner: ObjOps::heap_alloc(update_id), is_owned: true });
283 fn archive_persisted_channel(&self, mut channel_funding_outpoint: lightning::chain::transaction::OutPoint) {
284 (self.archive_persisted_channel)(self.this_arg, crate::lightning::chain::transaction::OutPoint { inner: ObjOps::heap_alloc(channel_funding_outpoint), is_owned: true })
288 // We're essentially a pointer already, or at least a set of pointers, so allow us to be used
289 // directly as a Deref trait in higher-level structs:
290 impl core::ops::Deref for Persist {
292 fn deref(&self) -> &Self {
296 impl core::ops::DerefMut for Persist {
297 fn deref_mut(&mut self) -> &mut Self {
301 /// Calls the free function if one is set
303 pub extern "C" fn Persist_free(this_ptr: Persist) { }
304 impl Drop for Persist {
306 if let Some(f) = self.free {
312 use lightning::chain::chainmonitor::LockedChannelMonitor as nativeLockedChannelMonitorImport;
313 pub(crate) type nativeLockedChannelMonitor = nativeLockedChannelMonitorImport<'static, crate::lightning::sign::ecdsa::WriteableEcdsaChannelSigner, >;
315 /// A read-only reference to a current ChannelMonitor.
317 /// Note that this holds a mutex in [`ChainMonitor`] and may block other events until it is
321 pub struct LockedChannelMonitor {
322 /// A pointer to the opaque Rust object.
324 /// Nearly everywhere, inner must be non-null, however in places where
325 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
326 pub inner: *mut nativeLockedChannelMonitor,
327 /// Indicates that this is the only struct which contains the same pointer.
329 /// Rust functions which take ownership of an object provided via an argument require
330 /// this to be true and invalidate the object pointed to by inner.
334 impl Drop for LockedChannelMonitor {
336 if self.is_owned && !<*mut nativeLockedChannelMonitor>::is_null(self.inner) {
337 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
341 /// Frees any resources used by the LockedChannelMonitor, if is_owned is set and inner is non-NULL.
343 pub extern "C" fn LockedChannelMonitor_free(this_obj: LockedChannelMonitor) { }
345 /// Used only if an object of this type is returned as a trait impl by a method
346 pub(crate) extern "C" fn LockedChannelMonitor_free_void(this_ptr: *mut c_void) {
347 let _ = unsafe { Box::from_raw(this_ptr as *mut nativeLockedChannelMonitor) };
350 impl LockedChannelMonitor {
351 pub(crate) fn get_native_ref(&self) -> &'static nativeLockedChannelMonitor {
352 unsafe { &*ObjOps::untweak_ptr(self.inner) }
354 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeLockedChannelMonitor {
355 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
357 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
358 pub(crate) fn take_inner(mut self) -> *mut nativeLockedChannelMonitor {
359 assert!(self.is_owned);
360 let ret = ObjOps::untweak_ptr(self.inner);
361 self.inner = core::ptr::null_mut();
366 use lightning::chain::chainmonitor::ChainMonitor as nativeChainMonitorImport;
367 pub(crate) type nativeChainMonitor = nativeChainMonitorImport<crate::lightning::sign::ecdsa::WriteableEcdsaChannelSigner, crate::lightning::chain::Filter, crate::lightning::chain::chaininterface::BroadcasterInterface, crate::lightning::chain::chaininterface::FeeEstimator, crate::lightning::util::logger::Logger, crate::lightning::chain::chainmonitor::Persist, >;
369 /// An implementation of [`chain::Watch`] for monitoring channels.
371 /// Connected and disconnected blocks must be provided to `ChainMonitor` as documented by
372 /// [`chain::Watch`]. May be used in conjunction with [`ChannelManager`] to monitor channels locally
373 /// or used independently to monitor channels remotely. See the [module-level documentation] for
376 /// Note that `ChainMonitor` should regularly trigger rebroadcasts/fee bumps of pending claims from
377 /// a force-closed channel. This is crucial in preventing certain classes of pinning attacks,
378 /// detecting substantial mempool feerate changes between blocks, and ensuring reliability if
379 /// broadcasting fails. We recommend invoking this every 30 seconds, or lower if running in an
380 /// environment with spotty connections, like on mobile.
382 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
383 /// [module-level documentation]: crate::chain::chainmonitor
384 /// [`rebroadcast_pending_claims`]: Self::rebroadcast_pending_claims
387 pub struct ChainMonitor {
388 /// A pointer to the opaque Rust object.
390 /// Nearly everywhere, inner must be non-null, however in places where
391 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
392 pub inner: *mut nativeChainMonitor,
393 /// Indicates that this is the only struct which contains the same pointer.
395 /// Rust functions which take ownership of an object provided via an argument require
396 /// this to be true and invalidate the object pointed to by inner.
400 impl Drop for ChainMonitor {
402 if self.is_owned && !<*mut nativeChainMonitor>::is_null(self.inner) {
403 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
407 /// Frees any resources used by the ChainMonitor, if is_owned is set and inner is non-NULL.
409 pub extern "C" fn ChainMonitor_free(this_obj: ChainMonitor) { }
411 /// Used only if an object of this type is returned as a trait impl by a method
412 pub(crate) extern "C" fn ChainMonitor_free_void(this_ptr: *mut c_void) {
413 let _ = unsafe { Box::from_raw(this_ptr as *mut nativeChainMonitor) };
417 pub(crate) fn get_native_ref(&self) -> &'static nativeChainMonitor {
418 unsafe { &*ObjOps::untweak_ptr(self.inner) }
420 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeChainMonitor {
421 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
423 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
424 pub(crate) fn take_inner(mut self) -> *mut nativeChainMonitor {
425 assert!(self.is_owned);
426 let ret = ObjOps::untweak_ptr(self.inner);
427 self.inner = core::ptr::null_mut();
431 /// Creates a new `ChainMonitor` used to watch on-chain activity pertaining to channels.
433 /// When an optional chain source implementing [`chain::Filter`] is provided, the chain monitor
434 /// will call back to it indicating transactions and outputs of interest. This allows clients to
435 /// pre-filter blocks or only fetch blocks matching a compact filter. Otherwise, clients may
436 /// always need to fetch full blocks absent another means for determining which blocks contain
437 /// transactions relevant to the watched channels.
440 pub extern "C" fn ChainMonitor_new(mut chain_source: crate::c_types::derived::COption_FilterZ, mut broadcaster: crate::lightning::chain::chaininterface::BroadcasterInterface, mut logger: crate::lightning::util::logger::Logger, mut feeest: crate::lightning::chain::chaininterface::FeeEstimator, mut persister: crate::lightning::chain::chainmonitor::Persist) -> crate::lightning::chain::chainmonitor::ChainMonitor {
441 let mut local_chain_source = { /*chain_source*/ let chain_source_opt = chain_source; if chain_source_opt.is_none() { None } else { Some({ { { chain_source_opt.take() } }})} };
442 let mut ret = lightning::chain::chainmonitor::ChainMonitor::new(local_chain_source, broadcaster, logger, feeest, persister);
443 crate::lightning::chain::chainmonitor::ChainMonitor { inner: ObjOps::heap_alloc(ret), is_owned: true }
446 /// Gets the balances in the contained [`ChannelMonitor`]s which are claimable on-chain or
447 /// claims which are awaiting confirmation.
449 /// Includes the balances from each [`ChannelMonitor`] *except* those included in
450 /// `ignored_channels`, allowing you to filter out balances from channels which are still open
451 /// (and whose balance should likely be pulled from the [`ChannelDetails`]).
453 /// See [`ChannelMonitor::get_claimable_balances`] for more details on the exact criteria for
454 /// inclusion in the return value.
457 pub extern "C" fn ChainMonitor_get_claimable_balances(this_arg: &crate::lightning::chain::chainmonitor::ChainMonitor, mut ignored_channels: crate::c_types::derived::CVec_ChannelDetailsZ) -> crate::c_types::derived::CVec_BalanceZ {
458 let mut local_ignored_channels = Vec::new(); for mut item in ignored_channels.as_slice().iter() { local_ignored_channels.push( { item.get_native_ref() }); };
459 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.get_claimable_balances(&local_ignored_channels[..]);
460 let mut local_ret = Vec::new(); for mut item in ret.drain(..) { local_ret.push( { crate::lightning::chain::channelmonitor::Balance::native_into(item) }); };
464 /// Gets the [`LockedChannelMonitor`] for a given funding outpoint, returning an `Err` if no
465 /// such [`ChannelMonitor`] is currently being monitored for.
467 /// Note that the result holds a mutex over our monitor set, and should not be held
471 pub extern "C" fn ChainMonitor_get_monitor(this_arg: &crate::lightning::chain::chainmonitor::ChainMonitor, mut funding_txo: crate::lightning::chain::transaction::OutPoint) -> crate::c_types::derived::CResult_LockedChannelMonitorNoneZ {
472 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.get_monitor(*unsafe { Box::from_raw(funding_txo.take_inner()) });
473 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::lightning::chain::chainmonitor::LockedChannelMonitor { inner: ObjOps::heap_alloc(o), is_owned: true } }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { () /*e*/ }).into() };
477 /// Lists the funding outpoint and channel ID of each [`ChannelMonitor`] being monitored.
479 /// Note that [`ChannelMonitor`]s are not removed when a channel is closed as they are always
480 /// monitoring for on-chain state resolutions.
483 pub extern "C" fn ChainMonitor_list_monitors(this_arg: &crate::lightning::chain::chainmonitor::ChainMonitor) -> crate::c_types::derived::CVec_C2Tuple_OutPointChannelIdZZ {
484 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.list_monitors();
485 let mut local_ret = Vec::new(); for mut item in ret.drain(..) { local_ret.push( { let (mut orig_ret_0_0, mut orig_ret_0_1) = item; let mut local_ret_0 = (crate::lightning::chain::transaction::OutPoint { inner: ObjOps::heap_alloc(orig_ret_0_0), is_owned: true }, crate::lightning::ln::types::ChannelId { inner: ObjOps::heap_alloc(orig_ret_0_1), is_owned: true }).into(); local_ret_0 }); };
489 /// Lists the pending updates for each [`ChannelMonitor`] (by `OutPoint` being monitored).
492 pub extern "C" fn ChainMonitor_list_pending_monitor_updates(this_arg: &crate::lightning::chain::chainmonitor::ChainMonitor) -> crate::c_types::derived::CVec_C2Tuple_OutPointCVec_MonitorUpdateIdZZZ {
493 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.list_pending_monitor_updates();
494 let mut local_ret = Vec::new(); for mut item in ret.drain(..) { local_ret.push( { let (mut orig_ret_0_0, mut orig_ret_0_1) = item; let mut local_orig_ret_0_1 = Vec::new(); for mut item in orig_ret_0_1.drain(..) { local_orig_ret_0_1.push( { crate::lightning::chain::chainmonitor::MonitorUpdateId { inner: ObjOps::heap_alloc(item), is_owned: true } }); }; let mut local_ret_0 = (crate::lightning::chain::transaction::OutPoint { inner: ObjOps::heap_alloc(orig_ret_0_0), is_owned: true }, local_orig_ret_0_1.into()).into(); local_ret_0 }); };
498 /// Indicates the persistence of a [`ChannelMonitor`] has completed after
499 /// [`ChannelMonitorUpdateStatus::InProgress`] was returned from an update operation.
501 /// Thus, the anticipated use is, at a high level:
502 /// 1) This [`ChainMonitor`] calls [`Persist::update_persisted_channel`] which stores the
503 /// update to disk and begins updating any remote (e.g. watchtower/backup) copies,
504 /// returning [`ChannelMonitorUpdateStatus::InProgress`],
505 /// 2) once all remote copies are updated, you call this function with the
506 /// `completed_update_id` that completed, and once all pending updates have completed the
507 /// channel will be re-enabled.
509 /// Returns an [`APIError::APIMisuseError`] if `funding_txo` does not match any currently
510 /// registered [`ChannelMonitor`]s.
513 pub extern "C" fn ChainMonitor_channel_monitor_updated(this_arg: &crate::lightning::chain::chainmonitor::ChainMonitor, mut funding_txo: crate::lightning::chain::transaction::OutPoint, mut completed_update_id: crate::lightning::chain::chainmonitor::MonitorUpdateId) -> crate::c_types::derived::CResult_NoneAPIErrorZ {
514 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.channel_monitor_updated(*unsafe { Box::from_raw(funding_txo.take_inner()) }, *unsafe { Box::from_raw(completed_update_id.take_inner()) });
515 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::util::errors::APIError::native_into(e) }).into() };
519 /// Gets a [`Future`] that completes when an event is available either via
520 /// [`chain::Watch::release_pending_monitor_events`] or
521 /// [`EventsProvider::process_pending_events`].
523 /// Note that callbacks registered on the [`Future`] MUST NOT call back into this
524 /// [`ChainMonitor`] and should instead register actions to be taken later.
526 /// [`EventsProvider::process_pending_events`]: crate::events::EventsProvider::process_pending_events
529 pub extern "C" fn ChainMonitor_get_update_future(this_arg: &crate::lightning::chain::chainmonitor::ChainMonitor) -> crate::lightning::util::wakers::Future {
530 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.get_update_future();
531 crate::lightning::util::wakers::Future { inner: ObjOps::heap_alloc(ret), is_owned: true }
534 /// Triggers rebroadcasts/fee-bumps of pending claims from a force-closed channel. This is
535 /// crucial in preventing certain classes of pinning attacks, detecting substantial mempool
536 /// feerate changes between blocks, and ensuring reliability if broadcasting fails. We recommend
537 /// invoking this every 30 seconds, or lower if running in an environment with spotty
538 /// connections, like on mobile.
540 pub extern "C" fn ChainMonitor_rebroadcast_pending_claims(this_arg: &crate::lightning::chain::chainmonitor::ChainMonitor) {
541 unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.rebroadcast_pending_claims()
544 /// Triggers rebroadcasts of pending claims from force-closed channels after a transaction
545 /// signature generation failure.
547 /// `monitor_opt` can be used as a filter to only trigger them for a specific channel monitor.
549 /// Note that monitor_opt (or a relevant inner pointer) may be NULL or all-0s to represent None
551 pub extern "C" fn ChainMonitor_signer_unblocked(this_arg: &crate::lightning::chain::chainmonitor::ChainMonitor, mut monitor_opt: crate::lightning::chain::transaction::OutPoint) {
552 let mut local_monitor_opt = if monitor_opt.inner.is_null() { None } else { Some( { *unsafe { Box::from_raw(monitor_opt.take_inner()) } }) };
553 unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.signer_unblocked(local_monitor_opt)
556 /// Archives fully resolved channel monitors by calling [`Persist::archive_persisted_channel`].
558 /// This is useful for pruning fully resolved monitors from the monitor set and primary
559 /// storage so they are not kept in memory and reloaded on restart.
561 /// Should be called occasionally (once every handful of blocks or on startup).
563 /// Depending on the implementation of [`Persist::archive_persisted_channel`] the monitor
564 /// data could be moved to an archive location or removed entirely.
566 pub extern "C" fn ChainMonitor_archive_fully_resolved_channel_monitors(this_arg: &crate::lightning::chain::chainmonitor::ChainMonitor) {
567 unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.archive_fully_resolved_channel_monitors()
570 impl From<nativeChainMonitor> for crate::lightning::chain::Listen {
571 fn from(obj: nativeChainMonitor) -> Self {
572 let rust_obj = crate::lightning::chain::chainmonitor::ChainMonitor { inner: ObjOps::heap_alloc(obj), is_owned: true };
573 let mut ret = ChainMonitor_as_Listen(&rust_obj);
574 // We want to free rust_obj when ret gets drop()'d, not rust_obj, so forget it and set ret's free() fn
575 core::mem::forget(rust_obj);
576 ret.free = Some(ChainMonitor_free_void);
580 /// Constructs a new Listen which calls the relevant methods on this_arg.
581 /// This copies the `inner` pointer in this_arg and thus the returned Listen must be freed before this_arg is
583 pub extern "C" fn ChainMonitor_as_Listen(this_arg: &ChainMonitor) -> crate::lightning::chain::Listen {
584 crate::lightning::chain::Listen {
585 this_arg: unsafe { ObjOps::untweak_ptr((*this_arg).inner) as *mut c_void },
587 filtered_block_connected: ChainMonitor_Listen_filtered_block_connected,
588 block_connected: ChainMonitor_Listen_block_connected,
589 block_disconnected: ChainMonitor_Listen_block_disconnected,
593 extern "C" fn ChainMonitor_Listen_filtered_block_connected(this_arg: *const c_void, header: *const [u8; 80], mut txdata: crate::c_types::derived::CVec_C2Tuple_usizeTransactionZZ, mut height: u32) {
594 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 }); };
595 <nativeChainMonitor as lightning::chain::Listen>::filtered_block_connected(unsafe { &mut *(this_arg as *mut nativeChainMonitor) }, &::bitcoin::consensus::encode::deserialize(unsafe { &*header }).unwrap(), &local_txdata.iter().map(|(a, b)| (*a, b)).collect::<Vec<_>>()[..], height)
597 extern "C" fn ChainMonitor_Listen_block_connected(this_arg: *const c_void, mut block: crate::c_types::u8slice, mut height: u32) {
598 <nativeChainMonitor as lightning::chain::Listen>::block_connected(unsafe { &mut *(this_arg as *mut nativeChainMonitor) }, &::bitcoin::consensus::encode::deserialize(block.to_slice()).unwrap(), height)
600 extern "C" fn ChainMonitor_Listen_block_disconnected(this_arg: *const c_void, header: *const [u8; 80], mut height: u32) {
601 <nativeChainMonitor as lightning::chain::Listen>::block_disconnected(unsafe { &mut *(this_arg as *mut nativeChainMonitor) }, &::bitcoin::consensus::encode::deserialize(unsafe { &*header }).unwrap(), height)
604 impl From<nativeChainMonitor> for crate::lightning::chain::Confirm {
605 fn from(obj: nativeChainMonitor) -> Self {
606 let rust_obj = crate::lightning::chain::chainmonitor::ChainMonitor { inner: ObjOps::heap_alloc(obj), is_owned: true };
607 let mut ret = ChainMonitor_as_Confirm(&rust_obj);
608 // We want to free rust_obj when ret gets drop()'d, not rust_obj, so forget it and set ret's free() fn
609 core::mem::forget(rust_obj);
610 ret.free = Some(ChainMonitor_free_void);
614 /// Constructs a new Confirm which calls the relevant methods on this_arg.
615 /// This copies the `inner` pointer in this_arg and thus the returned Confirm must be freed before this_arg is
617 pub extern "C" fn ChainMonitor_as_Confirm(this_arg: &ChainMonitor) -> crate::lightning::chain::Confirm {
618 crate::lightning::chain::Confirm {
619 this_arg: unsafe { ObjOps::untweak_ptr((*this_arg).inner) as *mut c_void },
621 transactions_confirmed: ChainMonitor_Confirm_transactions_confirmed,
622 transaction_unconfirmed: ChainMonitor_Confirm_transaction_unconfirmed,
623 best_block_updated: ChainMonitor_Confirm_best_block_updated,
624 get_relevant_txids: ChainMonitor_Confirm_get_relevant_txids,
628 extern "C" fn ChainMonitor_Confirm_transactions_confirmed(this_arg: *const c_void, header: *const [u8; 80], mut txdata: crate::c_types::derived::CVec_C2Tuple_usizeTransactionZZ, mut height: u32) {
629 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 }); };
630 <nativeChainMonitor as lightning::chain::Confirm>::transactions_confirmed(unsafe { &mut *(this_arg as *mut nativeChainMonitor) }, &::bitcoin::consensus::encode::deserialize(unsafe { &*header }).unwrap(), &local_txdata.iter().map(|(a, b)| (*a, b)).collect::<Vec<_>>()[..], height)
632 extern "C" fn ChainMonitor_Confirm_transaction_unconfirmed(this_arg: *const c_void, txid: *const [u8; 32]) {
633 <nativeChainMonitor as lightning::chain::Confirm>::transaction_unconfirmed(unsafe { &mut *(this_arg as *mut nativeChainMonitor) }, &::bitcoin::hash_types::Txid::from_slice(&unsafe { &*txid }[..]).unwrap())
635 extern "C" fn ChainMonitor_Confirm_best_block_updated(this_arg: *const c_void, header: *const [u8; 80], mut height: u32) {
636 <nativeChainMonitor as lightning::chain::Confirm>::best_block_updated(unsafe { &mut *(this_arg as *mut nativeChainMonitor) }, &::bitcoin::consensus::encode::deserialize(unsafe { &*header }).unwrap(), height)
639 extern "C" fn ChainMonitor_Confirm_get_relevant_txids(this_arg: *const c_void) -> crate::c_types::derived::CVec_C3Tuple_ThirtyTwoBytesu32COption_ThirtyTwoBytesZZZ {
640 let mut ret = <nativeChainMonitor as lightning::chain::Confirm>::get_relevant_txids(unsafe { &mut *(this_arg as *mut nativeChainMonitor) }, );
641 let mut local_ret = Vec::new(); for mut item in ret.drain(..) { local_ret.push( { let (mut orig_ret_0_0, mut orig_ret_0_1, mut orig_ret_0_2) = item; let mut local_orig_ret_0_2 = if orig_ret_0_2.is_none() { crate::c_types::derived::COption_ThirtyTwoBytesZ::None } else { crate::c_types::derived::COption_ThirtyTwoBytesZ::Some( { crate::c_types::ThirtyTwoBytes { data: *orig_ret_0_2.unwrap().as_ref() } }) }; let mut local_ret_0 = (crate::c_types::ThirtyTwoBytes { data: *orig_ret_0_0.as_ref() }, orig_ret_0_1, local_orig_ret_0_2).into(); local_ret_0 }); };
645 impl From<nativeChainMonitor> for crate::lightning::chain::Watch {
646 fn from(obj: nativeChainMonitor) -> Self {
647 let rust_obj = crate::lightning::chain::chainmonitor::ChainMonitor { inner: ObjOps::heap_alloc(obj), is_owned: true };
648 let mut ret = ChainMonitor_as_Watch(&rust_obj);
649 // We want to free rust_obj when ret gets drop()'d, not rust_obj, so forget it and set ret's free() fn
650 core::mem::forget(rust_obj);
651 ret.free = Some(ChainMonitor_free_void);
655 /// Constructs a new Watch which calls the relevant methods on this_arg.
656 /// This copies the `inner` pointer in this_arg and thus the returned Watch must be freed before this_arg is
658 pub extern "C" fn ChainMonitor_as_Watch(this_arg: &ChainMonitor) -> crate::lightning::chain::Watch {
659 crate::lightning::chain::Watch {
660 this_arg: unsafe { ObjOps::untweak_ptr((*this_arg).inner) as *mut c_void },
662 watch_channel: ChainMonitor_Watch_watch_channel,
663 update_channel: ChainMonitor_Watch_update_channel,
664 release_pending_monitor_events: ChainMonitor_Watch_release_pending_monitor_events,
669 extern "C" fn ChainMonitor_Watch_watch_channel(this_arg: *const c_void, mut funding_txo: crate::lightning::chain::transaction::OutPoint, mut monitor: crate::lightning::chain::channelmonitor::ChannelMonitor) -> crate::c_types::derived::CResult_ChannelMonitorUpdateStatusNoneZ {
670 let mut ret = <nativeChainMonitor as lightning::chain::Watch<crate::lightning::sign::ecdsa::WriteableEcdsaChannelSigner, >>::watch_channel(unsafe { &mut *(this_arg as *mut nativeChainMonitor) }, *unsafe { Box::from_raw(funding_txo.take_inner()) }, *unsafe { Box::from_raw(monitor.take_inner()) });
671 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::lightning::chain::ChannelMonitorUpdateStatus::native_into(o) }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { () /*e*/ }).into() };
675 extern "C" fn ChainMonitor_Watch_update_channel(this_arg: *const c_void, mut funding_txo: crate::lightning::chain::transaction::OutPoint, update: &crate::lightning::chain::channelmonitor::ChannelMonitorUpdate) -> crate::lightning::chain::ChannelMonitorUpdateStatus {
676 let mut ret = <nativeChainMonitor as lightning::chain::Watch<crate::lightning::sign::ecdsa::WriteableEcdsaChannelSigner, >>::update_channel(unsafe { &mut *(this_arg as *mut nativeChainMonitor) }, *unsafe { Box::from_raw(funding_txo.take_inner()) }, update.get_native_ref());
677 crate::lightning::chain::ChannelMonitorUpdateStatus::native_into(ret)
680 extern "C" fn ChainMonitor_Watch_release_pending_monitor_events(this_arg: *const c_void) -> crate::c_types::derived::CVec_C4Tuple_OutPointChannelIdCVec_MonitorEventZPublicKeyZZ {
681 let mut ret = <nativeChainMonitor as lightning::chain::Watch<crate::lightning::sign::ecdsa::WriteableEcdsaChannelSigner, >>::release_pending_monitor_events(unsafe { &mut *(this_arg as *mut nativeChainMonitor) }, );
682 let mut local_ret = Vec::new(); for mut item in ret.drain(..) { local_ret.push( { let (mut orig_ret_0_0, mut orig_ret_0_1, mut orig_ret_0_2, mut orig_ret_0_3) = item; let mut local_orig_ret_0_2 = Vec::new(); for mut item in orig_ret_0_2.drain(..) { local_orig_ret_0_2.push( { crate::lightning::chain::channelmonitor::MonitorEvent::native_into(item) }); }; let mut local_orig_ret_0_3 = if orig_ret_0_3.is_none() { crate::c_types::PublicKey::null() } else { { crate::c_types::PublicKey::from_rust(&(orig_ret_0_3.unwrap())) } }; let mut local_ret_0 = (crate::lightning::chain::transaction::OutPoint { inner: ObjOps::heap_alloc(orig_ret_0_0), is_owned: true }, crate::lightning::ln::types::ChannelId { inner: ObjOps::heap_alloc(orig_ret_0_1), is_owned: true }, local_orig_ret_0_2.into(), local_orig_ret_0_3).into(); local_ret_0 }); };
686 impl From<nativeChainMonitor> for crate::lightning::events::EventsProvider {
687 fn from(obj: nativeChainMonitor) -> Self {
688 let rust_obj = crate::lightning::chain::chainmonitor::ChainMonitor { inner: ObjOps::heap_alloc(obj), is_owned: true };
689 let mut ret = ChainMonitor_as_EventsProvider(&rust_obj);
690 // We want to free rust_obj when ret gets drop()'d, not rust_obj, so forget it and set ret's free() fn
691 core::mem::forget(rust_obj);
692 ret.free = Some(ChainMonitor_free_void);
696 /// Constructs a new EventsProvider which calls the relevant methods on this_arg.
697 /// This copies the `inner` pointer in this_arg and thus the returned EventsProvider must be freed before this_arg is
699 pub extern "C" fn ChainMonitor_as_EventsProvider(this_arg: &ChainMonitor) -> crate::lightning::events::EventsProvider {
700 crate::lightning::events::EventsProvider {
701 this_arg: unsafe { ObjOps::untweak_ptr((*this_arg).inner) as *mut c_void },
703 process_pending_events: ChainMonitor_EventsProvider_process_pending_events,
707 extern "C" fn ChainMonitor_EventsProvider_process_pending_events(this_arg: *const c_void, mut handler: crate::lightning::events::EventHandler) {
708 <nativeChainMonitor as lightning::events::EventsProvider>::process_pending_events(unsafe { &mut *(this_arg as *mut nativeChainMonitor) }, handler)