Update auto-generated bindings
[ldk-c-bindings] / lightning-c-bindings / src / lightning / chain / chainmonitor.rs
1 // This file is Copyright its original authors, visible in version control
2 // history and in the source files from which this was generated.
3 //
4 // This file is licensed under the license available in the LICENSE or LICENSE.md
5 // file in the root of this repository or, if no such file exists, the same
6 // license as that which applies to the original source files from which this
7 // source was automatically generated.
8
9 //! Logic to connect off-chain channel management with on-chain transaction monitoring.
10 //!
11 //! [`ChainMonitor`] is an implementation of [`chain::Watch`] used both to process blocks and to
12 //! update [`ChannelMonitor`]s accordingly. If any on-chain events need further processing, it will
13 //! make those available as [`MonitorEvent`]s to be consumed.
14 //!
15 //! [`ChainMonitor`] is parameterized by an optional chain source, which must implement the
16 //! [`chain::Filter`] trait. This provides a mechanism to signal new relevant outputs back to light
17 //! clients, such that transactions spending those outputs are included in block data.
18 //!
19 //! [`ChainMonitor`] may be used directly to monitor channels locally or as a part of a distributed
20 //! setup to monitor channels remotely. In the latter case, a custom [`chain::Watch`] implementation
21 //! would be responsible for routing each update to a remote server and for retrieving monitor
22 //! events. The remote server would make use of [`ChainMonitor`] for block processing and for
23 //! servicing [`ChannelMonitor`] updates from the client.
24
25 use alloc::str::FromStr;
26 use core::ffi::c_void;
27 use core::convert::Infallible;
28 use bitcoin::hashes::Hash;
29 use crate::c_types::*;
30 #[cfg(feature="no-std")]
31 use alloc::{vec::Vec, boxed::Box};
32
33
34 use lightning::chain::chainmonitor::MonitorUpdateId as nativeMonitorUpdateIdImport;
35 pub(crate) type nativeMonitorUpdateId = nativeMonitorUpdateIdImport;
36
37 /// An opaque identifier describing a specific [`Persist`] method call.
38 #[must_use]
39 #[repr(C)]
40 pub struct MonitorUpdateId {
41         /// A pointer to the opaque Rust object.
42
43         /// Nearly everywhere, inner must be non-null, however in places where
44         /// the Rust equivalent takes an Option, it may be set to null to indicate None.
45         pub inner: *mut nativeMonitorUpdateId,
46         /// Indicates that this is the only struct which contains the same pointer.
47
48         /// Rust functions which take ownership of an object provided via an argument require
49         /// this to be true and invalidate the object pointed to by inner.
50         pub is_owned: bool,
51 }
52
53 impl Drop for MonitorUpdateId {
54         fn drop(&mut self) {
55                 if self.is_owned && !<*mut nativeMonitorUpdateId>::is_null(self.inner) {
56                         let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
57                 }
58         }
59 }
60 /// Frees any resources used by the MonitorUpdateId, if is_owned is set and inner is non-NULL.
61 #[no_mangle]
62 pub extern "C" fn MonitorUpdateId_free(this_obj: MonitorUpdateId) { }
63 #[allow(unused)]
64 /// Used only if an object of this type is returned as a trait impl by a method
65 pub(crate) extern "C" fn MonitorUpdateId_free_void(this_ptr: *mut c_void) {
66         unsafe { let _ = Box::from_raw(this_ptr as *mut nativeMonitorUpdateId); }
67 }
68 #[allow(unused)]
69 impl MonitorUpdateId {
70         pub(crate) fn get_native_ref(&self) -> &'static nativeMonitorUpdateId {
71                 unsafe { &*ObjOps::untweak_ptr(self.inner) }
72         }
73         pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeMonitorUpdateId {
74                 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
75         }
76         /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
77         pub(crate) fn take_inner(mut self) -> *mut nativeMonitorUpdateId {
78                 assert!(self.is_owned);
79                 let ret = ObjOps::untweak_ptr(self.inner);
80                 self.inner = core::ptr::null_mut();
81                 ret
82         }
83 }
84 impl Clone for MonitorUpdateId {
85         fn clone(&self) -> Self {
86                 Self {
87                         inner: if <*mut nativeMonitorUpdateId>::is_null(self.inner) { core::ptr::null_mut() } else {
88                                 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
89                         is_owned: true,
90                 }
91         }
92 }
93 #[allow(unused)]
94 /// Used only if an object of this type is returned as a trait impl by a method
95 pub(crate) extern "C" fn MonitorUpdateId_clone_void(this_ptr: *const c_void) -> *mut c_void {
96         Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeMonitorUpdateId)).clone() })) as *mut c_void
97 }
98 #[no_mangle]
99 /// Creates a copy of the MonitorUpdateId
100 pub extern "C" fn MonitorUpdateId_clone(orig: &MonitorUpdateId) -> MonitorUpdateId {
101         orig.clone()
102 }
103 /// Checks if two MonitorUpdateIds contain equal inner contents.
104 #[no_mangle]
105 pub extern "C" fn MonitorUpdateId_hash(o: &MonitorUpdateId) -> u64 {
106         if o.inner.is_null() { return 0; }
107         // Note that we'd love to use alloc::collections::hash_map::DefaultHasher but it's not in core
108         #[allow(deprecated)]
109         let mut hasher = core::hash::SipHasher::new();
110         core::hash::Hash::hash(o.get_native_ref(), &mut hasher);
111         core::hash::Hasher::finish(&hasher)
112 }
113 /// Checks if two MonitorUpdateIds contain equal inner contents.
114 /// This ignores pointers and is_owned flags and looks at the values in fields.
115 /// Two objects with NULL inner values will be considered "equal" here.
116 #[no_mangle]
117 pub extern "C" fn MonitorUpdateId_eq(a: &MonitorUpdateId, b: &MonitorUpdateId) -> bool {
118         if a.inner == b.inner { return true; }
119         if a.inner.is_null() || b.inner.is_null() { return false; }
120         if a.get_native_ref() == b.get_native_ref() { true } else { false }
121 }
122 /// `Persist` defines behavior for persisting channel monitors: this could mean
123 /// writing once to disk, and/or uploading to one or more backup services.
124 ///
125 /// Each method can return three possible values:
126 ///  * If persistence (including any relevant `fsync()` calls) happens immediately, the
127 ///    implementation should return [`ChannelMonitorUpdateStatus::Completed`], indicating normal
128 ///    channel operation should continue.
129 ///  * If persistence happens asynchronously, implementations should first ensure the
130 ///    [`ChannelMonitor`] or [`ChannelMonitorUpdate`] are written durably to disk, and then return
131 ///    [`ChannelMonitorUpdateStatus::InProgress`] while the update continues in the background.
132 ///    Once the update completes, [`ChainMonitor::channel_monitor_updated`] should be called with
133 ///    the corresponding [`MonitorUpdateId`].
134 ///
135 ///    Note that unlike the direct [`chain::Watch`] interface,
136 ///    [`ChainMonitor::channel_monitor_updated`] must be called once for *each* update which occurs.
137 ///
138 ///  * If persistence fails for some reason, implementations should return
139 ///    [`ChannelMonitorUpdateStatus::PermanentFailure`], in which case the channel will likely be
140 ///    closed without broadcasting the latest state. See
141 ///    [`ChannelMonitorUpdateStatus::PermanentFailure`] for more details.
142 #[repr(C)]
143 pub struct Persist {
144         /// An opaque pointer which is passed to your function implementations as an argument.
145         /// This has no meaning in the LDK, and can be NULL or any other value.
146         pub this_arg: *mut c_void,
147         /// Persist a new channel's data in response to a [`chain::Watch::watch_channel`] call. This is
148         /// called by [`ChannelManager`] for new channels, or may be called directly, e.g. on startup.
149         ///
150         /// The data can be stored any way you want, but the identifier provided by LDK is the
151         /// channel's outpoint (and it is up to you to maintain a correct mapping between the outpoint
152         /// and the stored channel data). Note that you **must** persist every new monitor to disk.
153         ///
154         /// The `update_id` is used to identify this call to [`ChainMonitor::channel_monitor_updated`],
155         /// if you return [`ChannelMonitorUpdateStatus::InProgress`].
156         ///
157         /// See [`Writeable::write`] on [`ChannelMonitor`] for writing out a `ChannelMonitor`
158         /// and [`ChannelMonitorUpdateStatus`] for requirements when returning errors.
159         ///
160         /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
161         /// [`Writeable::write`]: crate::util::ser::Writeable::write
162         #[must_use]
163         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,
164         /// Update one channel's data. The provided [`ChannelMonitor`] has already applied the given
165         /// update.
166         ///
167         /// Note that on every update, you **must** persist either the [`ChannelMonitorUpdate`] or the
168         /// updated monitor itself to disk/backups. See the [`Persist`] trait documentation for more
169         /// details.
170         ///
171         /// During blockchain synchronization operations, this may be called with no
172         /// [`ChannelMonitorUpdate`], in which case the full [`ChannelMonitor`] needs to be persisted.
173         /// Note that after the full [`ChannelMonitor`] is persisted any previous
174         /// [`ChannelMonitorUpdate`]s which were persisted should be discarded - they can no longer be
175         /// applied to the persisted [`ChannelMonitor`] as they were already applied.
176         ///
177         /// If an implementer chooses to persist the updates only, they need to make
178         /// sure that all the updates are applied to the `ChannelMonitors` *before*
179         /// the set of channel monitors is given to the `ChannelManager`
180         /// deserialization routine. See [`ChannelMonitor::update_monitor`] for
181         /// applying a monitor update to a monitor. If full `ChannelMonitors` are
182         /// persisted, then there is no need to persist individual updates.
183         ///
184         /// Note that there could be a performance tradeoff between persisting complete
185         /// channel monitors on every update vs. persisting only updates and applying
186         /// them in batches. The size of each monitor grows `O(number of state updates)`
187         /// whereas updates are small and `O(1)`.
188         ///
189         /// The `update_id` is used to identify this call to [`ChainMonitor::channel_monitor_updated`],
190         /// if you return [`ChannelMonitorUpdateStatus::InProgress`].
191         ///
192         /// See [`Writeable::write`] on [`ChannelMonitor`] for writing out a `ChannelMonitor`,
193         /// [`Writeable::write`] on [`ChannelMonitorUpdate`] for writing out an update, and
194         /// [`ChannelMonitorUpdateStatus`] for requirements when returning errors.
195         ///
196         /// [`Writeable::write`]: crate::util::ser::Writeable::write
197         ///
198         /// Note that update (or a relevant inner pointer) may be NULL or all-0s to represent None
199         #[must_use]
200         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,
201         /// Frees any resources associated with this object given its this_arg pointer.
202         /// Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
203         pub free: Option<extern "C" fn(this_arg: *mut c_void)>,
204 }
205 unsafe impl Send for Persist {}
206 unsafe impl Sync for Persist {}
207 #[no_mangle]
208 pub(crate) extern "C" fn Persist_clone_fields(orig: &Persist) -> Persist {
209         Persist {
210                 this_arg: orig.this_arg,
211                 persist_new_channel: Clone::clone(&orig.persist_new_channel),
212                 update_persisted_channel: Clone::clone(&orig.update_persisted_channel),
213                 free: Clone::clone(&orig.free),
214         }
215 }
216
217 use lightning::chain::chainmonitor::Persist as rustPersist;
218 impl rustPersist<crate::lightning::chain::keysinterface::Sign> for Persist {
219         fn persist_new_channel(&self, mut channel_id: lightning::chain::transaction::OutPoint, mut data: &lightning::chain::channelmonitor::ChannelMonitor<crate::lightning::chain::keysinterface::Sign>, mut update_id: lightning::chain::chainmonitor::MonitorUpdateId) -> lightning::chain::ChannelMonitorUpdateStatus {
220                 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 });
221                 ret.into_native()
222         }
223         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::chain::keysinterface::Sign>, mut update_id: lightning::chain::chainmonitor::MonitorUpdateId) -> lightning::chain::ChannelMonitorUpdateStatus {
224                 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.as_ref().unwrap()) }) } as *const lightning::chain::channelmonitor::ChannelMonitorUpdate<>) as *mut _ }, is_owned: false };
225                 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 });
226                 ret.into_native()
227         }
228 }
229
230 // We're essentially a pointer already, or at least a set of pointers, so allow us to be used
231 // directly as a Deref trait in higher-level structs:
232 impl core::ops::Deref for Persist {
233         type Target = Self;
234         fn deref(&self) -> &Self {
235                 self
236         }
237 }
238 /// Calls the free function if one is set
239 #[no_mangle]
240 pub extern "C" fn Persist_free(this_ptr: Persist) { }
241 impl Drop for Persist {
242         fn drop(&mut self) {
243                 if let Some(f) = self.free {
244                         f(self.this_arg);
245                 }
246         }
247 }
248
249 use lightning::chain::chainmonitor::LockedChannelMonitor as nativeLockedChannelMonitorImport;
250 pub(crate) type nativeLockedChannelMonitor = nativeLockedChannelMonitorImport<'static, crate::lightning::chain::keysinterface::Sign>;
251
252 /// A read-only reference to a current ChannelMonitor.
253 ///
254 /// Note that this holds a mutex in [`ChainMonitor`] and may block other events until it is
255 /// released.
256 #[must_use]
257 #[repr(C)]
258 pub struct LockedChannelMonitor {
259         /// A pointer to the opaque Rust object.
260
261         /// Nearly everywhere, inner must be non-null, however in places where
262         /// the Rust equivalent takes an Option, it may be set to null to indicate None.
263         pub inner: *mut nativeLockedChannelMonitor,
264         /// Indicates that this is the only struct which contains the same pointer.
265
266         /// Rust functions which take ownership of an object provided via an argument require
267         /// this to be true and invalidate the object pointed to by inner.
268         pub is_owned: bool,
269 }
270
271 impl Drop for LockedChannelMonitor {
272         fn drop(&mut self) {
273                 if self.is_owned && !<*mut nativeLockedChannelMonitor>::is_null(self.inner) {
274                         let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
275                 }
276         }
277 }
278 /// Frees any resources used by the LockedChannelMonitor, if is_owned is set and inner is non-NULL.
279 #[no_mangle]
280 pub extern "C" fn LockedChannelMonitor_free(this_obj: LockedChannelMonitor) { }
281 #[allow(unused)]
282 /// Used only if an object of this type is returned as a trait impl by a method
283 pub(crate) extern "C" fn LockedChannelMonitor_free_void(this_ptr: *mut c_void) {
284         unsafe { let _ = Box::from_raw(this_ptr as *mut nativeLockedChannelMonitor); }
285 }
286 #[allow(unused)]
287 impl LockedChannelMonitor {
288         pub(crate) fn get_native_ref(&self) -> &'static nativeLockedChannelMonitor {
289                 unsafe { &*ObjOps::untweak_ptr(self.inner) }
290         }
291         pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeLockedChannelMonitor {
292                 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
293         }
294         /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
295         pub(crate) fn take_inner(mut self) -> *mut nativeLockedChannelMonitor {
296                 assert!(self.is_owned);
297                 let ret = ObjOps::untweak_ptr(self.inner);
298                 self.inner = core::ptr::null_mut();
299                 ret
300         }
301 }
302
303 use lightning::chain::chainmonitor::ChainMonitor as nativeChainMonitorImport;
304 pub(crate) type nativeChainMonitor = nativeChainMonitorImport<crate::lightning::chain::keysinterface::Sign, crate::lightning::chain::Filter, crate::lightning::chain::chaininterface::BroadcasterInterface, crate::lightning::chain::chaininterface::FeeEstimator, crate::lightning::util::logger::Logger, crate::lightning::chain::chainmonitor::Persist>;
305
306 /// An implementation of [`chain::Watch`] for monitoring channels.
307 ///
308 /// Connected and disconnected blocks must be provided to `ChainMonitor` as documented by
309 /// [`chain::Watch`]. May be used in conjunction with [`ChannelManager`] to monitor channels locally
310 /// or used independently to monitor channels remotely. See the [module-level documentation] for
311 /// details.
312 ///
313 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
314 /// [module-level documentation]: crate::chain::chainmonitor
315 #[must_use]
316 #[repr(C)]
317 pub struct ChainMonitor {
318         /// A pointer to the opaque Rust object.
319
320         /// Nearly everywhere, inner must be non-null, however in places where
321         /// the Rust equivalent takes an Option, it may be set to null to indicate None.
322         pub inner: *mut nativeChainMonitor,
323         /// Indicates that this is the only struct which contains the same pointer.
324
325         /// Rust functions which take ownership of an object provided via an argument require
326         /// this to be true and invalidate the object pointed to by inner.
327         pub is_owned: bool,
328 }
329
330 impl Drop for ChainMonitor {
331         fn drop(&mut self) {
332                 if self.is_owned && !<*mut nativeChainMonitor>::is_null(self.inner) {
333                         let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
334                 }
335         }
336 }
337 /// Frees any resources used by the ChainMonitor, if is_owned is set and inner is non-NULL.
338 #[no_mangle]
339 pub extern "C" fn ChainMonitor_free(this_obj: ChainMonitor) { }
340 #[allow(unused)]
341 /// Used only if an object of this type is returned as a trait impl by a method
342 pub(crate) extern "C" fn ChainMonitor_free_void(this_ptr: *mut c_void) {
343         unsafe { let _ = Box::from_raw(this_ptr as *mut nativeChainMonitor); }
344 }
345 #[allow(unused)]
346 impl ChainMonitor {
347         pub(crate) fn get_native_ref(&self) -> &'static nativeChainMonitor {
348                 unsafe { &*ObjOps::untweak_ptr(self.inner) }
349         }
350         pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeChainMonitor {
351                 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
352         }
353         /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
354         pub(crate) fn take_inner(mut self) -> *mut nativeChainMonitor {
355                 assert!(self.is_owned);
356                 let ret = ObjOps::untweak_ptr(self.inner);
357                 self.inner = core::ptr::null_mut();
358                 ret
359         }
360 }
361 /// Creates a new `ChainMonitor` used to watch on-chain activity pertaining to channels.
362 ///
363 /// When an optional chain source implementing [`chain::Filter`] is provided, the chain monitor
364 /// will call back to it indicating transactions and outputs of interest. This allows clients to
365 /// pre-filter blocks or only fetch blocks matching a compact filter. Otherwise, clients may
366 /// always need to fetch full blocks absent another means for determining which blocks contain
367 /// transactions relevant to the watched channels.
368 #[must_use]
369 #[no_mangle]
370 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 {
371         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() }) } };
372         let mut ret = lightning::chain::chainmonitor::ChainMonitor::new(local_chain_source, broadcaster, logger, feeest, persister);
373         crate::lightning::chain::chainmonitor::ChainMonitor { inner: ObjOps::heap_alloc(ret), is_owned: true }
374 }
375
376 /// Gets the balances in the contained [`ChannelMonitor`]s which are claimable on-chain or
377 /// claims which are awaiting confirmation.
378 ///
379 /// Includes the balances from each [`ChannelMonitor`] *except* those included in
380 /// `ignored_channels`, allowing you to filter out balances from channels which are still open
381 /// (and whose balance should likely be pulled from the [`ChannelDetails`]).
382 ///
383 /// See [`ChannelMonitor::get_claimable_balances`] for more details on the exact criteria for
384 /// inclusion in the return value.
385 #[must_use]
386 #[no_mangle]
387 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 {
388         let mut local_ignored_channels = Vec::new(); for mut item in ignored_channels.as_slice().iter() { local_ignored_channels.push( { item.get_native_ref() }); };
389         let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.get_claimable_balances(&local_ignored_channels[..]);
390         let mut local_ret = Vec::new(); for mut item in ret.drain(..) { local_ret.push( { crate::lightning::chain::channelmonitor::Balance::native_into(item) }); };
391         local_ret.into()
392 }
393
394 /// Gets the [`LockedChannelMonitor`] for a given funding outpoint, returning an `Err` if no
395 /// such [`ChannelMonitor`] is currently being monitored for.
396 ///
397 /// Note that the result holds a mutex over our monitor set, and should not be held
398 /// indefinitely.
399 #[must_use]
400 #[no_mangle]
401 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 {
402         let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.get_monitor(*unsafe { Box::from_raw(funding_txo.take_inner()) });
403         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() };
404         local_ret
405 }
406
407 /// Lists the funding outpoint of each [`ChannelMonitor`] being monitored.
408 ///
409 /// Note that [`ChannelMonitor`]s are not removed when a channel is closed as they are always
410 /// monitoring for on-chain state resolutions.
411 #[must_use]
412 #[no_mangle]
413 pub extern "C" fn ChainMonitor_list_monitors(this_arg: &crate::lightning::chain::chainmonitor::ChainMonitor) -> crate::c_types::derived::CVec_OutPointZ {
414         let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.list_monitors();
415         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 } }); };
416         local_ret.into()
417 }
418
419 /// Indicates the persistence of a [`ChannelMonitor`] has completed after
420 /// [`ChannelMonitorUpdateStatus::InProgress`] was returned from an update operation.
421 ///
422 /// Thus, the anticipated use is, at a high level:
423 ///  1) This [`ChainMonitor`] calls [`Persist::update_persisted_channel`] which stores the
424 ///     update to disk and begins updating any remote (e.g. watchtower/backup) copies,
425 ///     returning [`ChannelMonitorUpdateStatus::InProgress`],
426 ///  2) once all remote copies are updated, you call this function with the
427 ///     `completed_update_id` that completed, and once all pending updates have completed the
428 ///     channel will be re-enabled.
429 ///
430 /// Returns an [`APIError::APIMisuseError`] if `funding_txo` does not match any currently
431 /// registered [`ChannelMonitor`]s.
432 #[must_use]
433 #[no_mangle]
434 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 {
435         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()) });
436         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() };
437         local_ret
438 }
439
440 impl From<nativeChainMonitor> for crate::lightning::chain::Listen {
441         fn from(obj: nativeChainMonitor) -> Self {
442                 let mut rust_obj = ChainMonitor { inner: ObjOps::heap_alloc(obj), is_owned: true };
443                 let mut ret = ChainMonitor_as_Listen(&rust_obj);
444                 // 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
445                 rust_obj.inner = core::ptr::null_mut();
446                 ret.free = Some(ChainMonitor_free_void);
447                 ret
448         }
449 }
450 /// Constructs a new Listen which calls the relevant methods on this_arg.
451 /// This copies the `inner` pointer in this_arg and thus the returned Listen must be freed before this_arg is
452 #[no_mangle]
453 pub extern "C" fn ChainMonitor_as_Listen(this_arg: &ChainMonitor) -> crate::lightning::chain::Listen {
454         crate::lightning::chain::Listen {
455                 this_arg: unsafe { ObjOps::untweak_ptr((*this_arg).inner) as *mut c_void },
456                 free: None,
457                 filtered_block_connected: ChainMonitor_Listen_filtered_block_connected,
458                 block_connected: ChainMonitor_Listen_block_connected,
459                 block_disconnected: ChainMonitor_Listen_block_disconnected,
460         }
461 }
462
463 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) {
464         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 }); };
465         <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)
466 }
467 extern "C" fn ChainMonitor_Listen_block_connected(this_arg: *const c_void, mut block: crate::c_types::u8slice, mut height: u32) {
468         <nativeChainMonitor as lightning::chain::Listen<>>::block_connected(unsafe { &mut *(this_arg as *mut nativeChainMonitor) }, &::bitcoin::consensus::encode::deserialize(block.to_slice()).unwrap(), height)
469 }
470 extern "C" fn ChainMonitor_Listen_block_disconnected(this_arg: *const c_void, header: *const [u8; 80], mut height: u32) {
471         <nativeChainMonitor as lightning::chain::Listen<>>::block_disconnected(unsafe { &mut *(this_arg as *mut nativeChainMonitor) }, &::bitcoin::consensus::encode::deserialize(unsafe { &*header }).unwrap(), height)
472 }
473
474 impl From<nativeChainMonitor> for crate::lightning::chain::Confirm {
475         fn from(obj: nativeChainMonitor) -> Self {
476                 let mut rust_obj = ChainMonitor { inner: ObjOps::heap_alloc(obj), is_owned: true };
477                 let mut ret = ChainMonitor_as_Confirm(&rust_obj);
478                 // 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
479                 rust_obj.inner = core::ptr::null_mut();
480                 ret.free = Some(ChainMonitor_free_void);
481                 ret
482         }
483 }
484 /// Constructs a new Confirm which calls the relevant methods on this_arg.
485 /// This copies the `inner` pointer in this_arg and thus the returned Confirm must be freed before this_arg is
486 #[no_mangle]
487 pub extern "C" fn ChainMonitor_as_Confirm(this_arg: &ChainMonitor) -> crate::lightning::chain::Confirm {
488         crate::lightning::chain::Confirm {
489                 this_arg: unsafe { ObjOps::untweak_ptr((*this_arg).inner) as *mut c_void },
490                 free: None,
491                 transactions_confirmed: ChainMonitor_Confirm_transactions_confirmed,
492                 transaction_unconfirmed: ChainMonitor_Confirm_transaction_unconfirmed,
493                 best_block_updated: ChainMonitor_Confirm_best_block_updated,
494                 get_relevant_txids: ChainMonitor_Confirm_get_relevant_txids,
495         }
496 }
497
498 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) {
499         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 }); };
500         <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)
501 }
502 extern "C" fn ChainMonitor_Confirm_transaction_unconfirmed(this_arg: *const c_void, txid: *const [u8; 32]) {
503         <nativeChainMonitor as lightning::chain::Confirm<>>::transaction_unconfirmed(unsafe { &mut *(this_arg as *mut nativeChainMonitor) }, &::bitcoin::hash_types::Txid::from_slice(&unsafe { &*txid }[..]).unwrap())
504 }
505 extern "C" fn ChainMonitor_Confirm_best_block_updated(this_arg: *const c_void, header: *const [u8; 80], mut height: u32) {
506         <nativeChainMonitor as lightning::chain::Confirm<>>::best_block_updated(unsafe { &mut *(this_arg as *mut nativeChainMonitor) }, &::bitcoin::consensus::encode::deserialize(unsafe { &*header }).unwrap(), height)
507 }
508 #[must_use]
509 extern "C" fn ChainMonitor_Confirm_get_relevant_txids(this_arg: *const c_void) -> crate::c_types::derived::CVec_TxidZ {
510         let mut ret = <nativeChainMonitor as lightning::chain::Confirm<>>::get_relevant_txids(unsafe { &mut *(this_arg as *mut nativeChainMonitor) }, );
511         let mut local_ret = Vec::new(); for mut item in ret.drain(..) { local_ret.push( { crate::c_types::ThirtyTwoBytes { data: item.into_inner() } }); };
512         local_ret.into()
513 }
514
515 impl From<nativeChainMonitor> for crate::lightning::chain::Watch {
516         fn from(obj: nativeChainMonitor) -> Self {
517                 let mut rust_obj = ChainMonitor { inner: ObjOps::heap_alloc(obj), is_owned: true };
518                 let mut ret = ChainMonitor_as_Watch(&rust_obj);
519                 // 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
520                 rust_obj.inner = core::ptr::null_mut();
521                 ret.free = Some(ChainMonitor_free_void);
522                 ret
523         }
524 }
525 /// Constructs a new Watch which calls the relevant methods on this_arg.
526 /// This copies the `inner` pointer in this_arg and thus the returned Watch must be freed before this_arg is
527 #[no_mangle]
528 pub extern "C" fn ChainMonitor_as_Watch(this_arg: &ChainMonitor) -> crate::lightning::chain::Watch {
529         crate::lightning::chain::Watch {
530                 this_arg: unsafe { ObjOps::untweak_ptr((*this_arg).inner) as *mut c_void },
531                 free: None,
532                 watch_channel: ChainMonitor_Watch_watch_channel,
533                 update_channel: ChainMonitor_Watch_update_channel,
534                 release_pending_monitor_events: ChainMonitor_Watch_release_pending_monitor_events,
535         }
536 }
537
538 #[must_use]
539 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::lightning::chain::ChannelMonitorUpdateStatus {
540         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()) });
541         crate::lightning::chain::ChannelMonitorUpdateStatus::native_into(ret)
542 }
543 #[must_use]
544 extern "C" fn ChainMonitor_Watch_update_channel(this_arg: *const c_void, mut funding_txo: crate::lightning::chain::transaction::OutPoint, mut update: crate::lightning::chain::channelmonitor::ChannelMonitorUpdate) -> crate::lightning::chain::ChannelMonitorUpdateStatus {
545         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()) });
546         crate::lightning::chain::ChannelMonitorUpdateStatus::native_into(ret)
547 }
548 #[must_use]
549 extern "C" fn ChainMonitor_Watch_release_pending_monitor_events(this_arg: *const c_void) -> crate::c_types::derived::CVec_C3Tuple_OutPointCVec_MonitorEventZPublicKeyZZ {
550         let mut ret = <nativeChainMonitor as lightning::chain::Watch<_>>::release_pending_monitor_events(unsafe { &mut *(this_arg as *mut nativeChainMonitor) }, );
551         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 }); };
552         local_ret.into()
553 }
554
555 impl From<nativeChainMonitor> for crate::lightning::util::events::EventsProvider {
556         fn from(obj: nativeChainMonitor) -> Self {
557                 let mut rust_obj = ChainMonitor { inner: ObjOps::heap_alloc(obj), is_owned: true };
558                 let mut ret = ChainMonitor_as_EventsProvider(&rust_obj);
559                 // 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
560                 rust_obj.inner = core::ptr::null_mut();
561                 ret.free = Some(ChainMonitor_free_void);
562                 ret
563         }
564 }
565 /// Constructs a new EventsProvider which calls the relevant methods on this_arg.
566 /// This copies the `inner` pointer in this_arg and thus the returned EventsProvider must be freed before this_arg is
567 #[no_mangle]
568 pub extern "C" fn ChainMonitor_as_EventsProvider(this_arg: &ChainMonitor) -> crate::lightning::util::events::EventsProvider {
569         crate::lightning::util::events::EventsProvider {
570                 this_arg: unsafe { ObjOps::untweak_ptr((*this_arg).inner) as *mut c_void },
571                 free: None,
572                 process_pending_events: ChainMonitor_EventsProvider_process_pending_events,
573         }
574 }
575
576 extern "C" fn ChainMonitor_EventsProvider_process_pending_events(this_arg: *const c_void, mut handler: crate::lightning::util::events::EventHandler) {
577         <nativeChainMonitor as lightning::util::events::EventsProvider<>>::process_pending_events(unsafe { &mut *(this_arg as *mut nativeChainMonitor) }, handler)
578 }
579