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_id: 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_id: 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 /// Frees any resources associated with this object given its this_arg pointer.
251 /// Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
252 pub free: Option<extern "C" fn(this_arg: *mut c_void)>,
254 unsafe impl Send for Persist {}
255 unsafe impl Sync for Persist {}
257 pub(crate) fn Persist_clone_fields(orig: &Persist) -> Persist {
259 this_arg: orig.this_arg,
260 persist_new_channel: Clone::clone(&orig.persist_new_channel),
261 update_persisted_channel: Clone::clone(&orig.update_persisted_channel),
262 free: Clone::clone(&orig.free),
266 use lightning::chain::chainmonitor::Persist as rustPersist;
267 impl rustPersist<crate::lightning::sign::ecdsa::WriteableEcdsaChannelSigner> for Persist {
268 fn persist_new_channel(&self, mut channel_id: 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 {
269 let mut ret = (self.persist_new_channel)(self.this_arg, crate::lightning::chain::transaction::OutPoint { inner: ObjOps::heap_alloc(channel_id), 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 });
272 fn update_persisted_channel(&self, mut channel_id: 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 {
273 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 };
274 let mut ret = (self.update_persisted_channel)(self.this_arg, crate::lightning::chain::transaction::OutPoint { inner: ObjOps::heap_alloc(channel_id), 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 });
279 // We're essentially a pointer already, or at least a set of pointers, so allow us to be used
280 // directly as a Deref trait in higher-level structs:
281 impl core::ops::Deref for Persist {
283 fn deref(&self) -> &Self {
287 impl core::ops::DerefMut for Persist {
288 fn deref_mut(&mut self) -> &mut Self {
292 /// Calls the free function if one is set
294 pub extern "C" fn Persist_free(this_ptr: Persist) { }
295 impl Drop for Persist {
297 if let Some(f) = self.free {
303 use lightning::chain::chainmonitor::LockedChannelMonitor as nativeLockedChannelMonitorImport;
304 pub(crate) type nativeLockedChannelMonitor = nativeLockedChannelMonitorImport<'static, crate::lightning::sign::ecdsa::WriteableEcdsaChannelSigner>;
306 /// A read-only reference to a current ChannelMonitor.
308 /// Note that this holds a mutex in [`ChainMonitor`] and may block other events until it is
312 pub struct LockedChannelMonitor {
313 /// A pointer to the opaque Rust object.
315 /// Nearly everywhere, inner must be non-null, however in places where
316 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
317 pub inner: *mut nativeLockedChannelMonitor,
318 /// Indicates that this is the only struct which contains the same pointer.
320 /// Rust functions which take ownership of an object provided via an argument require
321 /// this to be true and invalidate the object pointed to by inner.
325 impl Drop for LockedChannelMonitor {
327 if self.is_owned && !<*mut nativeLockedChannelMonitor>::is_null(self.inner) {
328 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
332 /// Frees any resources used by the LockedChannelMonitor, if is_owned is set and inner is non-NULL.
334 pub extern "C" fn LockedChannelMonitor_free(this_obj: LockedChannelMonitor) { }
336 /// Used only if an object of this type is returned as a trait impl by a method
337 pub(crate) extern "C" fn LockedChannelMonitor_free_void(this_ptr: *mut c_void) {
338 let _ = unsafe { Box::from_raw(this_ptr as *mut nativeLockedChannelMonitor) };
341 impl LockedChannelMonitor {
342 pub(crate) fn get_native_ref(&self) -> &'static nativeLockedChannelMonitor {
343 unsafe { &*ObjOps::untweak_ptr(self.inner) }
345 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeLockedChannelMonitor {
346 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
348 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
349 pub(crate) fn take_inner(mut self) -> *mut nativeLockedChannelMonitor {
350 assert!(self.is_owned);
351 let ret = ObjOps::untweak_ptr(self.inner);
352 self.inner = core::ptr::null_mut();
357 use lightning::chain::chainmonitor::ChainMonitor as nativeChainMonitorImport;
358 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>;
360 /// An implementation of [`chain::Watch`] for monitoring channels.
362 /// Connected and disconnected blocks must be provided to `ChainMonitor` as documented by
363 /// [`chain::Watch`]. May be used in conjunction with [`ChannelManager`] to monitor channels locally
364 /// or used independently to monitor channels remotely. See the [module-level documentation] for
367 /// Note that `ChainMonitor` should regularly trigger rebroadcasts/fee bumps of pending claims from
368 /// a force-closed channel. This is crucial in preventing certain classes of pinning attacks,
369 /// detecting substantial mempool feerate changes between blocks, and ensuring reliability if
370 /// broadcasting fails. We recommend invoking this every 30 seconds, or lower if running in an
371 /// environment with spotty connections, like on mobile.
373 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
374 /// [module-level documentation]: crate::chain::chainmonitor
375 /// [`rebroadcast_pending_claims`]: Self::rebroadcast_pending_claims
378 pub struct ChainMonitor {
379 /// A pointer to the opaque Rust object.
381 /// Nearly everywhere, inner must be non-null, however in places where
382 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
383 pub inner: *mut nativeChainMonitor,
384 /// Indicates that this is the only struct which contains the same pointer.
386 /// Rust functions which take ownership of an object provided via an argument require
387 /// this to be true and invalidate the object pointed to by inner.
391 impl Drop for ChainMonitor {
393 if self.is_owned && !<*mut nativeChainMonitor>::is_null(self.inner) {
394 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
398 /// Frees any resources used by the ChainMonitor, if is_owned is set and inner is non-NULL.
400 pub extern "C" fn ChainMonitor_free(this_obj: ChainMonitor) { }
402 /// Used only if an object of this type is returned as a trait impl by a method
403 pub(crate) extern "C" fn ChainMonitor_free_void(this_ptr: *mut c_void) {
404 let _ = unsafe { Box::from_raw(this_ptr as *mut nativeChainMonitor) };
408 pub(crate) fn get_native_ref(&self) -> &'static nativeChainMonitor {
409 unsafe { &*ObjOps::untweak_ptr(self.inner) }
411 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeChainMonitor {
412 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
414 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
415 pub(crate) fn take_inner(mut self) -> *mut nativeChainMonitor {
416 assert!(self.is_owned);
417 let ret = ObjOps::untweak_ptr(self.inner);
418 self.inner = core::ptr::null_mut();
422 /// Creates a new `ChainMonitor` used to watch on-chain activity pertaining to channels.
424 /// When an optional chain source implementing [`chain::Filter`] is provided, the chain monitor
425 /// will call back to it indicating transactions and outputs of interest. This allows clients to
426 /// pre-filter blocks or only fetch blocks matching a compact filter. Otherwise, clients may
427 /// always need to fetch full blocks absent another means for determining which blocks contain
428 /// transactions relevant to the watched channels.
431 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 {
432 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() } }})} };
433 let mut ret = lightning::chain::chainmonitor::ChainMonitor::new(local_chain_source, broadcaster, logger, feeest, persister);
434 crate::lightning::chain::chainmonitor::ChainMonitor { inner: ObjOps::heap_alloc(ret), is_owned: true }
437 /// Gets the balances in the contained [`ChannelMonitor`]s which are claimable on-chain or
438 /// claims which are awaiting confirmation.
440 /// Includes the balances from each [`ChannelMonitor`] *except* those included in
441 /// `ignored_channels`, allowing you to filter out balances from channels which are still open
442 /// (and whose balance should likely be pulled from the [`ChannelDetails`]).
444 /// See [`ChannelMonitor::get_claimable_balances`] for more details on the exact criteria for
445 /// inclusion in the return value.
448 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 {
449 let mut local_ignored_channels = Vec::new(); for mut item in ignored_channels.as_slice().iter() { local_ignored_channels.push( { item.get_native_ref() }); };
450 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.get_claimable_balances(&local_ignored_channels[..]);
451 let mut local_ret = Vec::new(); for mut item in ret.drain(..) { local_ret.push( { crate::lightning::chain::channelmonitor::Balance::native_into(item) }); };
455 /// Gets the [`LockedChannelMonitor`] for a given funding outpoint, returning an `Err` if no
456 /// such [`ChannelMonitor`] is currently being monitored for.
458 /// Note that the result holds a mutex over our monitor set, and should not be held
462 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 {
463 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.get_monitor(*unsafe { Box::from_raw(funding_txo.take_inner()) });
464 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() };
468 /// Lists the funding outpoint of each [`ChannelMonitor`] being monitored.
470 /// Note that [`ChannelMonitor`]s are not removed when a channel is closed as they are always
471 /// monitoring for on-chain state resolutions.
474 pub extern "C" fn ChainMonitor_list_monitors(this_arg: &crate::lightning::chain::chainmonitor::ChainMonitor) -> crate::c_types::derived::CVec_OutPointZ {
475 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.list_monitors();
476 let mut local_ret = Vec::new(); for mut item in ret.drain(..) { local_ret.push( { crate::lightning::chain::transaction::OutPoint { inner: ObjOps::heap_alloc(item), is_owned: true } }); };
480 /// Lists the pending updates for each [`ChannelMonitor`] (by `OutPoint` being monitored).
483 pub extern "C" fn ChainMonitor_list_pending_monitor_updates(this_arg: &crate::lightning::chain::chainmonitor::ChainMonitor) -> crate::c_types::derived::CVec_C2Tuple_OutPointCVec_MonitorUpdateIdZZZ {
484 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.list_pending_monitor_updates();
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_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 }); };
489 /// Indicates the persistence of a [`ChannelMonitor`] has completed after
490 /// [`ChannelMonitorUpdateStatus::InProgress`] was returned from an update operation.
492 /// Thus, the anticipated use is, at a high level:
493 /// 1) This [`ChainMonitor`] calls [`Persist::update_persisted_channel`] which stores the
494 /// update to disk and begins updating any remote (e.g. watchtower/backup) copies,
495 /// returning [`ChannelMonitorUpdateStatus::InProgress`],
496 /// 2) once all remote copies are updated, you call this function with the
497 /// `completed_update_id` that completed, and once all pending updates have completed the
498 /// channel will be re-enabled.
500 /// Returns an [`APIError::APIMisuseError`] if `funding_txo` does not match any currently
501 /// registered [`ChannelMonitor`]s.
504 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 {
505 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()) });
506 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() };
510 /// Gets a [`Future`] that completes when an event is available either via
511 /// [`chain::Watch::release_pending_monitor_events`] or
512 /// [`EventsProvider::process_pending_events`].
514 /// Note that callbacks registered on the [`Future`] MUST NOT call back into this
515 /// [`ChainMonitor`] and should instead register actions to be taken later.
517 /// [`EventsProvider::process_pending_events`]: crate::events::EventsProvider::process_pending_events
520 pub extern "C" fn ChainMonitor_get_update_future(this_arg: &crate::lightning::chain::chainmonitor::ChainMonitor) -> crate::lightning::util::wakers::Future {
521 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.get_update_future();
522 crate::lightning::util::wakers::Future { inner: ObjOps::heap_alloc(ret), is_owned: true }
525 /// Triggers rebroadcasts/fee-bumps of pending claims from a force-closed channel. This is
526 /// crucial in preventing certain classes of pinning attacks, detecting substantial mempool
527 /// feerate changes between blocks, and ensuring reliability if broadcasting fails. We recommend
528 /// invoking this every 30 seconds, or lower if running in an environment with spotty
529 /// connections, like on mobile.
531 pub extern "C" fn ChainMonitor_rebroadcast_pending_claims(this_arg: &crate::lightning::chain::chainmonitor::ChainMonitor) {
532 unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.rebroadcast_pending_claims()
535 impl From<nativeChainMonitor> for crate::lightning::chain::Listen {
536 fn from(obj: nativeChainMonitor) -> Self {
537 let rust_obj = crate::lightning::chain::chainmonitor::ChainMonitor { inner: ObjOps::heap_alloc(obj), is_owned: true };
538 let mut ret = ChainMonitor_as_Listen(&rust_obj);
539 // We want to free rust_obj when ret gets drop()'d, not rust_obj, so forget it and set ret's free() fn
540 core::mem::forget(rust_obj);
541 ret.free = Some(ChainMonitor_free_void);
545 /// Constructs a new Listen which calls the relevant methods on this_arg.
546 /// This copies the `inner` pointer in this_arg and thus the returned Listen must be freed before this_arg is
548 pub extern "C" fn ChainMonitor_as_Listen(this_arg: &ChainMonitor) -> crate::lightning::chain::Listen {
549 crate::lightning::chain::Listen {
550 this_arg: unsafe { ObjOps::untweak_ptr((*this_arg).inner) as *mut c_void },
552 filtered_block_connected: ChainMonitor_Listen_filtered_block_connected,
553 block_connected: ChainMonitor_Listen_block_connected,
554 block_disconnected: ChainMonitor_Listen_block_disconnected,
558 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) {
559 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 }); };
560 <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)
562 extern "C" fn ChainMonitor_Listen_block_connected(this_arg: *const c_void, mut block: crate::c_types::u8slice, mut height: u32) {
563 <nativeChainMonitor as lightning::chain::Listen<>>::block_connected(unsafe { &mut *(this_arg as *mut nativeChainMonitor) }, &::bitcoin::consensus::encode::deserialize(block.to_slice()).unwrap(), height)
565 extern "C" fn ChainMonitor_Listen_block_disconnected(this_arg: *const c_void, header: *const [u8; 80], mut height: u32) {
566 <nativeChainMonitor as lightning::chain::Listen<>>::block_disconnected(unsafe { &mut *(this_arg as *mut nativeChainMonitor) }, &::bitcoin::consensus::encode::deserialize(unsafe { &*header }).unwrap(), height)
569 impl From<nativeChainMonitor> for crate::lightning::chain::Confirm {
570 fn from(obj: nativeChainMonitor) -> Self {
571 let rust_obj = crate::lightning::chain::chainmonitor::ChainMonitor { inner: ObjOps::heap_alloc(obj), is_owned: true };
572 let mut ret = ChainMonitor_as_Confirm(&rust_obj);
573 // We want to free rust_obj when ret gets drop()'d, not rust_obj, so forget it and set ret's free() fn
574 core::mem::forget(rust_obj);
575 ret.free = Some(ChainMonitor_free_void);
579 /// Constructs a new Confirm which calls the relevant methods on this_arg.
580 /// This copies the `inner` pointer in this_arg and thus the returned Confirm must be freed before this_arg is
582 pub extern "C" fn ChainMonitor_as_Confirm(this_arg: &ChainMonitor) -> crate::lightning::chain::Confirm {
583 crate::lightning::chain::Confirm {
584 this_arg: unsafe { ObjOps::untweak_ptr((*this_arg).inner) as *mut c_void },
586 transactions_confirmed: ChainMonitor_Confirm_transactions_confirmed,
587 transaction_unconfirmed: ChainMonitor_Confirm_transaction_unconfirmed,
588 best_block_updated: ChainMonitor_Confirm_best_block_updated,
589 get_relevant_txids: ChainMonitor_Confirm_get_relevant_txids,
593 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) {
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::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)
597 extern "C" fn ChainMonitor_Confirm_transaction_unconfirmed(this_arg: *const c_void, txid: *const [u8; 32]) {
598 <nativeChainMonitor as lightning::chain::Confirm<>>::transaction_unconfirmed(unsafe { &mut *(this_arg as *mut nativeChainMonitor) }, &::bitcoin::hash_types::Txid::from_slice(&unsafe { &*txid }[..]).unwrap())
600 extern "C" fn ChainMonitor_Confirm_best_block_updated(this_arg: *const c_void, header: *const [u8; 80], mut height: u32) {
601 <nativeChainMonitor as lightning::chain::Confirm<>>::best_block_updated(unsafe { &mut *(this_arg as *mut nativeChainMonitor) }, &::bitcoin::consensus::encode::deserialize(unsafe { &*header }).unwrap(), height)
604 extern "C" fn ChainMonitor_Confirm_get_relevant_txids(this_arg: *const c_void) -> crate::c_types::derived::CVec_C3Tuple_ThirtyTwoBytesu32COption_ThirtyTwoBytesZZZ {
605 let mut ret = <nativeChainMonitor as lightning::chain::Confirm<>>::get_relevant_txids(unsafe { &mut *(this_arg as *mut nativeChainMonitor) }, );
606 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 }); };
610 impl From<nativeChainMonitor> for crate::lightning::chain::Watch {
611 fn from(obj: nativeChainMonitor) -> Self {
612 let rust_obj = crate::lightning::chain::chainmonitor::ChainMonitor { inner: ObjOps::heap_alloc(obj), is_owned: true };
613 let mut ret = ChainMonitor_as_Watch(&rust_obj);
614 // We want to free rust_obj when ret gets drop()'d, not rust_obj, so forget it and set ret's free() fn
615 core::mem::forget(rust_obj);
616 ret.free = Some(ChainMonitor_free_void);
620 /// Constructs a new Watch which calls the relevant methods on this_arg.
621 /// This copies the `inner` pointer in this_arg and thus the returned Watch must be freed before this_arg is
623 pub extern "C" fn ChainMonitor_as_Watch(this_arg: &ChainMonitor) -> crate::lightning::chain::Watch {
624 crate::lightning::chain::Watch {
625 this_arg: unsafe { ObjOps::untweak_ptr((*this_arg).inner) as *mut c_void },
627 watch_channel: ChainMonitor_Watch_watch_channel,
628 update_channel: ChainMonitor_Watch_update_channel,
629 release_pending_monitor_events: ChainMonitor_Watch_release_pending_monitor_events,
634 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 {
635 let mut ret = <nativeChainMonitor as lightning::chain::Watch<_>>::watch_channel(unsafe { &mut *(this_arg as *mut nativeChainMonitor) }, *unsafe { Box::from_raw(funding_txo.take_inner()) }, *unsafe { Box::from_raw(monitor.take_inner()) });
636 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() };
640 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 {
641 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()) }, update.get_native_ref());
642 crate::lightning::chain::ChannelMonitorUpdateStatus::native_into(ret)
645 extern "C" fn ChainMonitor_Watch_release_pending_monitor_events(this_arg: *const c_void) -> crate::c_types::derived::CVec_C3Tuple_OutPointCVec_MonitorEventZPublicKeyZZ {
646 let mut ret = <nativeChainMonitor as lightning::chain::Watch<_>>::release_pending_monitor_events(unsafe { &mut *(this_arg as *mut nativeChainMonitor) }, );
647 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_1 = Vec::new(); for mut item in orig_ret_0_1.drain(..) { local_orig_ret_0_1.push( { crate::lightning::chain::channelmonitor::MonitorEvent::native_into(item) }); }; let mut local_orig_ret_0_2 = if orig_ret_0_2.is_none() { crate::c_types::PublicKey::null() } else { { crate::c_types::PublicKey::from_rust(&(orig_ret_0_2.unwrap())) } }; 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(), local_orig_ret_0_2).into(); local_ret_0 }); };
651 impl From<nativeChainMonitor> for crate::lightning::events::EventsProvider {
652 fn from(obj: nativeChainMonitor) -> Self {
653 let rust_obj = crate::lightning::chain::chainmonitor::ChainMonitor { inner: ObjOps::heap_alloc(obj), is_owned: true };
654 let mut ret = ChainMonitor_as_EventsProvider(&rust_obj);
655 // We want to free rust_obj when ret gets drop()'d, not rust_obj, so forget it and set ret's free() fn
656 core::mem::forget(rust_obj);
657 ret.free = Some(ChainMonitor_free_void);
661 /// Constructs a new EventsProvider which calls the relevant methods on this_arg.
662 /// This copies the `inner` pointer in this_arg and thus the returned EventsProvider must be freed before this_arg is
664 pub extern "C" fn ChainMonitor_as_EventsProvider(this_arg: &ChainMonitor) -> crate::lightning::events::EventsProvider {
665 crate::lightning::events::EventsProvider {
666 this_arg: unsafe { ObjOps::untweak_ptr((*this_arg).inner) as *mut c_void },
668 process_pending_events: ChainMonitor_EventsProvider_process_pending_events,
672 extern "C" fn ChainMonitor_EventsProvider_process_pending_events(this_arg: *const c_void, mut handler: crate::lightning::events::EventHandler) {
673 <nativeChainMonitor as lightning::events::EventsProvider<>>::process_pending_events(unsafe { &mut *(this_arg as *mut nativeChainMonitor) }, handler)