Auto-generated bindings updates
[rust-lightning] / lightning-c-bindings / src / chain / channelmonitor.rs
1 //! The logic to monitor for on-chain transactions and create the relevant claim responses lives
2 //! here.
3 //!
4 //! ChannelMonitor objects are generated by ChannelManager in response to relevant
5 //! messages/actions, and MUST be persisted to disk (and, preferably, remotely) before progress can
6 //! be made in responding to certain messages, see [`chain::Watch`] for more.
7 //!
8 //! Note that ChannelMonitors are an important part of the lightning trust model and a copy of the
9 //! latest ChannelMonitor must always be actively monitoring for chain updates (and no out-of-date
10 //! ChannelMonitors should do so). Thus, if you're building rust-lightning into an HSM or other
11 //! security-domain-separated system design, you should consider having multiple paths for
12 //! ChannelMonitors to get out of the HSM and onto monitoring devices.
13 //!
14 //! [`chain::Watch`]: ../trait.Watch.html
15
16 use std::ffi::c_void;
17 use bitcoin::hashes::Hash;
18 use crate::c_types::*;
19
20
21 use lightning::chain::channelmonitor::ChannelMonitorUpdate as nativeChannelMonitorUpdateImport;
22 type nativeChannelMonitorUpdate = nativeChannelMonitorUpdateImport;
23
24 /// An update generated by the underlying Channel itself which contains some new information the
25 /// ChannelMonitor should be made aware of.
26 #[must_use]
27 #[repr(C)]
28 pub struct ChannelMonitorUpdate {
29         /// Nearly everywhere, inner must be non-null, however in places where
30         /// the Rust equivalent takes an Option, it may be set to null to indicate None.
31         pub inner: *mut nativeChannelMonitorUpdate,
32         pub is_owned: bool,
33 }
34
35 impl Drop for ChannelMonitorUpdate {
36         fn drop(&mut self) {
37                 if self.is_owned && !self.inner.is_null() {
38                         let _ = unsafe { Box::from_raw(self.inner) };
39                 }
40         }
41 }
42 #[no_mangle]
43 pub extern "C" fn ChannelMonitorUpdate_free(this_ptr: ChannelMonitorUpdate) { }
44 #[allow(unused)]
45 /// Used only if an object of this type is returned as a trait impl by a method
46 extern "C" fn ChannelMonitorUpdate_free_void(this_ptr: *mut c_void) {
47         unsafe { let _ = Box::from_raw(this_ptr as *mut nativeChannelMonitorUpdate); }
48 }
49 #[allow(unused)]
50 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
51 impl ChannelMonitorUpdate {
52         pub(crate) fn take_inner(mut self) -> *mut nativeChannelMonitorUpdate {
53                 assert!(self.is_owned);
54                 let ret = self.inner;
55                 self.inner = std::ptr::null_mut();
56                 ret
57         }
58 }
59 impl Clone for ChannelMonitorUpdate {
60         fn clone(&self) -> Self {
61                 Self {
62                         inner: Box::into_raw(Box::new(unsafe { &*self.inner }.clone())),
63                         is_owned: true,
64                 }
65         }
66 }
67 #[allow(unused)]
68 /// Used only if an object of this type is returned as a trait impl by a method
69 pub(crate) extern "C" fn ChannelMonitorUpdate_clone_void(this_ptr: *const c_void) -> *mut c_void {
70         Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeChannelMonitorUpdate)).clone() })) as *mut c_void
71 }
72 #[no_mangle]
73 pub extern "C" fn ChannelMonitorUpdate_clone(orig: &ChannelMonitorUpdate) -> ChannelMonitorUpdate {
74         ChannelMonitorUpdate { inner: Box::into_raw(Box::new(unsafe { &*orig.inner }.clone())), is_owned: true }
75 }
76 /// The sequence number of this update. Updates *must* be replayed in-order according to this
77 /// sequence number (and updates may panic if they are not). The update_id values are strictly
78 /// increasing and increase by one for each new update, with one exception specified below.
79 ///
80 /// This sequence number is also used to track up to which points updates which returned
81 /// ChannelMonitorUpdateErr::TemporaryFailure have been applied to all copies of a given
82 /// ChannelMonitor when ChannelManager::channel_monitor_updated is called.
83 ///
84 /// The only instance where update_id values are not strictly increasing is the case where we
85 /// allow post-force-close updates with a special update ID of [`CLOSED_CHANNEL_UPDATE_ID`]. See
86 /// its docs for more details.
87 ///
88 /// [`CLOSED_CHANNEL_UPDATE_ID`]: constant.CLOSED_CHANNEL_UPDATE_ID.html
89 #[no_mangle]
90 pub extern "C" fn ChannelMonitorUpdate_get_update_id(this_ptr: &ChannelMonitorUpdate) -> u64 {
91         let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.update_id;
92         (*inner_val)
93 }
94 /// The sequence number of this update. Updates *must* be replayed in-order according to this
95 /// sequence number (and updates may panic if they are not). The update_id values are strictly
96 /// increasing and increase by one for each new update, with one exception specified below.
97 ///
98 /// This sequence number is also used to track up to which points updates which returned
99 /// ChannelMonitorUpdateErr::TemporaryFailure have been applied to all copies of a given
100 /// ChannelMonitor when ChannelManager::channel_monitor_updated is called.
101 ///
102 /// The only instance where update_id values are not strictly increasing is the case where we
103 /// allow post-force-close updates with a special update ID of [`CLOSED_CHANNEL_UPDATE_ID`]. See
104 /// its docs for more details.
105 ///
106 /// [`CLOSED_CHANNEL_UPDATE_ID`]: constant.CLOSED_CHANNEL_UPDATE_ID.html
107 #[no_mangle]
108 pub extern "C" fn ChannelMonitorUpdate_set_update_id(this_ptr: &mut ChannelMonitorUpdate, mut val: u64) {
109         unsafe { &mut *this_ptr.inner }.update_id = val;
110 }
111
112 #[no_mangle]
113 pub static CLOSED_CHANNEL_UPDATE_ID: u64 = lightning::chain::channelmonitor::CLOSED_CHANNEL_UPDATE_ID;
114 #[no_mangle]
115 pub extern "C" fn ChannelMonitorUpdate_write(obj: &ChannelMonitorUpdate) -> crate::c_types::derived::CVec_u8Z {
116         crate::c_types::serialize_obj(unsafe { &*unsafe { &*obj }.inner })
117 }
118 #[no_mangle]
119 pub(crate) extern "C" fn ChannelMonitorUpdate_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
120         crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeChannelMonitorUpdate) })
121 }
122 #[no_mangle]
123 pub extern "C" fn ChannelMonitorUpdate_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_ChannelMonitorUpdateDecodeErrorZ {
124         let res = crate::c_types::deserialize_obj(ser);
125         let mut local_res = match res { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::chain::channelmonitor::ChannelMonitorUpdate { inner: Box::into_raw(Box::new(o)), is_owned: true } }), Err(mut e) => crate::c_types::CResultTempl::err( { crate::ln::msgs::DecodeError { inner: Box::into_raw(Box::new(e)), is_owned: true } }) };
126         local_res
127 }
128 /// An error enum representing a failure to persist a channel monitor update.
129 #[must_use]
130 #[derive(Clone)]
131 #[repr(C)]
132 pub enum ChannelMonitorUpdateErr {
133         /// Used to indicate a temporary failure (eg connection to a watchtower or remote backup of
134         /// our state failed, but is expected to succeed at some point in the future).
135         ///
136         /// Such a failure will \"freeze\" a channel, preventing us from revoking old states or
137         /// submitting new commitment transactions to the counterparty. Once the update(s) which failed
138         /// have been successfully applied, ChannelManager::channel_monitor_updated can be used to
139         /// restore the channel to an operational state.
140         ///
141         /// Note that a given ChannelManager will *never* re-generate a given ChannelMonitorUpdate. If
142         /// you return a TemporaryFailure you must ensure that it is written to disk safely before
143         /// writing out the latest ChannelManager state.
144         ///
145         /// Even when a channel has been \"frozen\" updates to the ChannelMonitor can continue to occur
146         /// (eg if an inbound HTLC which we forwarded was claimed upstream resulting in us attempting
147         /// to claim it on this channel) and those updates must be applied wherever they can be. At
148         /// least one such updated ChannelMonitor must be persisted otherwise PermanentFailure should
149         /// be returned to get things on-chain ASAP using only the in-memory copy. Obviously updates to
150         /// the channel which would invalidate previous ChannelMonitors are not made when a channel has
151         /// been \"frozen\".
152         ///
153         /// Note that even if updates made after TemporaryFailure succeed you must still call
154         /// channel_monitor_updated to ensure you have the latest monitor and re-enable normal channel
155         /// operation.
156         ///
157         /// Note that the update being processed here will not be replayed for you when you call
158         /// ChannelManager::channel_monitor_updated, so you must store the update itself along
159         /// with the persisted ChannelMonitor on your own local disk prior to returning a
160         /// TemporaryFailure. You may, of course, employ a journaling approach, storing only the
161         /// ChannelMonitorUpdate on disk without updating the monitor itself, replaying the journal at
162         /// reload-time.
163         ///
164         /// For deployments where a copy of ChannelMonitors and other local state are backed up in a
165         /// remote location (with local copies persisted immediately), it is anticipated that all
166         /// updates will return TemporaryFailure until the remote copies could be updated.
167         TemporaryFailure,
168         /// Used to indicate no further channel monitor updates will be allowed (eg we've moved on to a
169         /// different watchtower and cannot update with all watchtowers that were previously informed
170         /// of this channel).
171         ///
172         /// At reception of this error, ChannelManager will force-close the channel and return at
173         /// least a final ChannelMonitorUpdate::ChannelForceClosed which must be delivered to at
174         /// least one ChannelMonitor copy. Revocation secret MUST NOT be released and offchain channel
175         /// update must be rejected.
176         ///
177         /// This failure may also signal a failure to update the local persisted copy of one of
178         /// the channel monitor instance.
179         ///
180         /// Note that even when you fail a holder commitment transaction update, you must store the
181         /// update to ensure you can claim from it in case of a duplicate copy of this ChannelMonitor
182         /// broadcasts it (e.g distributed channel-monitor deployment)
183         ///
184         /// In case of distributed watchtowers deployment, the new version must be written to disk, as
185         /// state may have been stored but rejected due to a block forcing a commitment broadcast. This
186         /// storage is used to claim outputs of rejected state confirmed onchain by another watchtower,
187         /// lagging behind on block processing.
188         PermanentFailure,
189 }
190 use lightning::chain::channelmonitor::ChannelMonitorUpdateErr as nativeChannelMonitorUpdateErr;
191 impl ChannelMonitorUpdateErr {
192         #[allow(unused)]
193         pub(crate) fn to_native(&self) -> nativeChannelMonitorUpdateErr {
194                 match self {
195                         ChannelMonitorUpdateErr::TemporaryFailure => nativeChannelMonitorUpdateErr::TemporaryFailure,
196                         ChannelMonitorUpdateErr::PermanentFailure => nativeChannelMonitorUpdateErr::PermanentFailure,
197                 }
198         }
199         #[allow(unused)]
200         pub(crate) fn into_native(self) -> nativeChannelMonitorUpdateErr {
201                 match self {
202                         ChannelMonitorUpdateErr::TemporaryFailure => nativeChannelMonitorUpdateErr::TemporaryFailure,
203                         ChannelMonitorUpdateErr::PermanentFailure => nativeChannelMonitorUpdateErr::PermanentFailure,
204                 }
205         }
206         #[allow(unused)]
207         pub(crate) fn from_native(native: &nativeChannelMonitorUpdateErr) -> Self {
208                 match native {
209                         nativeChannelMonitorUpdateErr::TemporaryFailure => ChannelMonitorUpdateErr::TemporaryFailure,
210                         nativeChannelMonitorUpdateErr::PermanentFailure => ChannelMonitorUpdateErr::PermanentFailure,
211                 }
212         }
213         #[allow(unused)]
214         pub(crate) fn native_into(native: nativeChannelMonitorUpdateErr) -> Self {
215                 match native {
216                         nativeChannelMonitorUpdateErr::TemporaryFailure => ChannelMonitorUpdateErr::TemporaryFailure,
217                         nativeChannelMonitorUpdateErr::PermanentFailure => ChannelMonitorUpdateErr::PermanentFailure,
218                 }
219         }
220 }
221 #[no_mangle]
222 pub extern "C" fn ChannelMonitorUpdateErr_clone(orig: &ChannelMonitorUpdateErr) -> ChannelMonitorUpdateErr {
223         orig.clone()
224 }
225
226 use lightning::chain::channelmonitor::MonitorUpdateError as nativeMonitorUpdateErrorImport;
227 type nativeMonitorUpdateError = nativeMonitorUpdateErrorImport;
228
229 /// General Err type for ChannelMonitor actions. Generally, this implies that the data provided is
230 /// inconsistent with the ChannelMonitor being called. eg for ChannelMonitor::update_monitor this
231 /// means you tried to update a monitor for a different channel or the ChannelMonitorUpdate was
232 /// corrupted.
233 /// Contains a developer-readable error message.
234 #[must_use]
235 #[repr(C)]
236 pub struct MonitorUpdateError {
237         /// Nearly everywhere, inner must be non-null, however in places where
238         /// the Rust equivalent takes an Option, it may be set to null to indicate None.
239         pub inner: *mut nativeMonitorUpdateError,
240         pub is_owned: bool,
241 }
242
243 impl Drop for MonitorUpdateError {
244         fn drop(&mut self) {
245                 if self.is_owned && !self.inner.is_null() {
246                         let _ = unsafe { Box::from_raw(self.inner) };
247                 }
248         }
249 }
250 #[no_mangle]
251 pub extern "C" fn MonitorUpdateError_free(this_ptr: MonitorUpdateError) { }
252 #[allow(unused)]
253 /// Used only if an object of this type is returned as a trait impl by a method
254 extern "C" fn MonitorUpdateError_free_void(this_ptr: *mut c_void) {
255         unsafe { let _ = Box::from_raw(this_ptr as *mut nativeMonitorUpdateError); }
256 }
257 #[allow(unused)]
258 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
259 impl MonitorUpdateError {
260         pub(crate) fn take_inner(mut self) -> *mut nativeMonitorUpdateError {
261                 assert!(self.is_owned);
262                 let ret = self.inner;
263                 self.inner = std::ptr::null_mut();
264                 ret
265         }
266 }
267
268 use lightning::chain::channelmonitor::MonitorEvent as nativeMonitorEventImport;
269 type nativeMonitorEvent = nativeMonitorEventImport;
270
271 /// An event to be processed by the ChannelManager.
272 #[must_use]
273 #[repr(C)]
274 pub struct MonitorEvent {
275         /// Nearly everywhere, inner must be non-null, however in places where
276         /// the Rust equivalent takes an Option, it may be set to null to indicate None.
277         pub inner: *mut nativeMonitorEvent,
278         pub is_owned: bool,
279 }
280
281 impl Drop for MonitorEvent {
282         fn drop(&mut self) {
283                 if self.is_owned && !self.inner.is_null() {
284                         let _ = unsafe { Box::from_raw(self.inner) };
285                 }
286         }
287 }
288 #[no_mangle]
289 pub extern "C" fn MonitorEvent_free(this_ptr: MonitorEvent) { }
290 #[allow(unused)]
291 /// Used only if an object of this type is returned as a trait impl by a method
292 extern "C" fn MonitorEvent_free_void(this_ptr: *mut c_void) {
293         unsafe { let _ = Box::from_raw(this_ptr as *mut nativeMonitorEvent); }
294 }
295 #[allow(unused)]
296 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
297 impl MonitorEvent {
298         pub(crate) fn take_inner(mut self) -> *mut nativeMonitorEvent {
299                 assert!(self.is_owned);
300                 let ret = self.inner;
301                 self.inner = std::ptr::null_mut();
302                 ret
303         }
304 }
305 impl Clone for MonitorEvent {
306         fn clone(&self) -> Self {
307                 Self {
308                         inner: Box::into_raw(Box::new(unsafe { &*self.inner }.clone())),
309                         is_owned: true,
310                 }
311         }
312 }
313 #[allow(unused)]
314 /// Used only if an object of this type is returned as a trait impl by a method
315 pub(crate) extern "C" fn MonitorEvent_clone_void(this_ptr: *const c_void) -> *mut c_void {
316         Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeMonitorEvent)).clone() })) as *mut c_void
317 }
318 #[no_mangle]
319 pub extern "C" fn MonitorEvent_clone(orig: &MonitorEvent) -> MonitorEvent {
320         MonitorEvent { inner: Box::into_raw(Box::new(unsafe { &*orig.inner }.clone())), is_owned: true }
321 }
322
323 use lightning::chain::channelmonitor::HTLCUpdate as nativeHTLCUpdateImport;
324 type nativeHTLCUpdate = nativeHTLCUpdateImport;
325
326 /// Simple structure sent back by `chain::Watch` when an HTLC from a forward channel is detected on
327 /// chain. Used to update the corresponding HTLC in the backward channel. Failing to pass the
328 /// preimage claim backward will lead to loss of funds.
329 ///
330 /// [`chain::Watch`]: ../trait.Watch.html
331 #[must_use]
332 #[repr(C)]
333 pub struct HTLCUpdate {
334         /// Nearly everywhere, inner must be non-null, however in places where
335         /// the Rust equivalent takes an Option, it may be set to null to indicate None.
336         pub inner: *mut nativeHTLCUpdate,
337         pub is_owned: bool,
338 }
339
340 impl Drop for HTLCUpdate {
341         fn drop(&mut self) {
342                 if self.is_owned && !self.inner.is_null() {
343                         let _ = unsafe { Box::from_raw(self.inner) };
344                 }
345         }
346 }
347 #[no_mangle]
348 pub extern "C" fn HTLCUpdate_free(this_ptr: HTLCUpdate) { }
349 #[allow(unused)]
350 /// Used only if an object of this type is returned as a trait impl by a method
351 extern "C" fn HTLCUpdate_free_void(this_ptr: *mut c_void) {
352         unsafe { let _ = Box::from_raw(this_ptr as *mut nativeHTLCUpdate); }
353 }
354 #[allow(unused)]
355 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
356 impl HTLCUpdate {
357         pub(crate) fn take_inner(mut self) -> *mut nativeHTLCUpdate {
358                 assert!(self.is_owned);
359                 let ret = self.inner;
360                 self.inner = std::ptr::null_mut();
361                 ret
362         }
363 }
364 impl Clone for HTLCUpdate {
365         fn clone(&self) -> Self {
366                 Self {
367                         inner: Box::into_raw(Box::new(unsafe { &*self.inner }.clone())),
368                         is_owned: true,
369                 }
370         }
371 }
372 #[allow(unused)]
373 /// Used only if an object of this type is returned as a trait impl by a method
374 pub(crate) extern "C" fn HTLCUpdate_clone_void(this_ptr: *const c_void) -> *mut c_void {
375         Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeHTLCUpdate)).clone() })) as *mut c_void
376 }
377 #[no_mangle]
378 pub extern "C" fn HTLCUpdate_clone(orig: &HTLCUpdate) -> HTLCUpdate {
379         HTLCUpdate { inner: Box::into_raw(Box::new(unsafe { &*orig.inner }.clone())), is_owned: true }
380 }
381 #[no_mangle]
382 pub extern "C" fn HTLCUpdate_write(obj: &HTLCUpdate) -> crate::c_types::derived::CVec_u8Z {
383         crate::c_types::serialize_obj(unsafe { &(*(*obj).inner) })
384 }
385 #[no_mangle]
386 pub(crate) extern "C" fn HTLCUpdate_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
387         crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeHTLCUpdate) })
388 }
389 #[no_mangle]
390 pub extern "C" fn HTLCUpdate_read(ser: crate::c_types::u8slice) -> HTLCUpdate {
391         if let Ok(res) = crate::c_types::deserialize_obj(ser) {
392                 HTLCUpdate { inner: Box::into_raw(Box::new(res)), is_owned: true }
393         } else {
394                 HTLCUpdate { inner: std::ptr::null_mut(), is_owned: true }
395         }
396 }
397
398 use lightning::chain::channelmonitor::ChannelMonitor as nativeChannelMonitorImport;
399 type nativeChannelMonitor = nativeChannelMonitorImport<crate::chain::keysinterface::ChannelKeys>;
400
401 /// A ChannelMonitor handles chain events (blocks connected and disconnected) and generates
402 /// on-chain transactions to ensure no loss of funds occurs.
403 ///
404 /// You MUST ensure that no ChannelMonitors for a given channel anywhere contain out-of-date
405 /// information and are actively monitoring the chain.
406 ///
407 /// Pending Events or updated HTLCs which have not yet been read out by
408 /// get_and_clear_pending_monitor_events or get_and_clear_pending_events are serialized to disk and
409 /// reloaded at deserialize-time. Thus, you must ensure that, when handling events, all events
410 /// gotten are fully handled before re-serializing the new state.
411 ///
412 /// Note that the deserializer is only implemented for (Sha256dHash, ChannelMonitor), which
413 /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
414 /// the \"reorg path\" (ie disconnecting blocks until you find a common ancestor from both the
415 /// returned block hash and the the current chain and then reconnecting blocks to get to the
416 /// best chain) upon deserializing the object!
417 #[must_use]
418 #[repr(C)]
419 pub struct ChannelMonitor {
420         /// Nearly everywhere, inner must be non-null, however in places where
421         /// the Rust equivalent takes an Option, it may be set to null to indicate None.
422         pub inner: *mut nativeChannelMonitor,
423         pub is_owned: bool,
424 }
425
426 impl Drop for ChannelMonitor {
427         fn drop(&mut self) {
428                 if self.is_owned && !self.inner.is_null() {
429                         let _ = unsafe { Box::from_raw(self.inner) };
430                 }
431         }
432 }
433 #[no_mangle]
434 pub extern "C" fn ChannelMonitor_free(this_ptr: ChannelMonitor) { }
435 #[allow(unused)]
436 /// Used only if an object of this type is returned as a trait impl by a method
437 extern "C" fn ChannelMonitor_free_void(this_ptr: *mut c_void) {
438         unsafe { let _ = Box::from_raw(this_ptr as *mut nativeChannelMonitor); }
439 }
440 #[allow(unused)]
441 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
442 impl ChannelMonitor {
443         pub(crate) fn take_inner(mut self) -> *mut nativeChannelMonitor {
444                 assert!(self.is_owned);
445                 let ret = self.inner;
446                 self.inner = std::ptr::null_mut();
447                 ret
448         }
449 }
450 #[no_mangle]
451 pub extern "C" fn ChannelMonitor_write(obj: &ChannelMonitor) -> crate::c_types::derived::CVec_u8Z {
452         crate::c_types::serialize_obj(unsafe { &*unsafe { &*obj }.inner })
453 }
454 #[no_mangle]
455 pub(crate) extern "C" fn ChannelMonitor_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
456         crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeChannelMonitor) })
457 }
458 /// Updates a ChannelMonitor on the basis of some new information provided by the Channel
459 /// itself.
460 ///
461 /// panics if the given update is not the next update by update_id.
462 #[must_use]
463 #[no_mangle]
464 pub extern "C" fn ChannelMonitor_update_monitor(this_arg: &mut ChannelMonitor, updates: &crate::chain::channelmonitor::ChannelMonitorUpdate, broadcaster: &crate::chain::chaininterface::BroadcasterInterface, fee_estimator: &crate::chain::chaininterface::FeeEstimator, logger: &crate::util::logger::Logger) -> crate::c_types::derived::CResult_NoneMonitorUpdateErrorZ {
465         let mut ret = unsafe { &mut (*(this_arg.inner as *mut nativeChannelMonitor)) }.update_monitor(unsafe { &*updates.inner }, broadcaster, fee_estimator, logger);
466         let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { 0u8 /*o*/ }), Err(mut e) => crate::c_types::CResultTempl::err( { crate::chain::channelmonitor::MonitorUpdateError { inner: Box::into_raw(Box::new(e)), is_owned: true } }) };
467         local_ret
468 }
469
470 /// Gets the update_id from the latest ChannelMonitorUpdate which was applied to this
471 /// ChannelMonitor.
472 #[must_use]
473 #[no_mangle]
474 pub extern "C" fn ChannelMonitor_get_latest_update_id(this_arg: &ChannelMonitor) -> u64 {
475         let mut ret = unsafe { &*this_arg.inner }.get_latest_update_id();
476         ret
477 }
478
479 /// Gets the funding transaction outpoint of the channel this ChannelMonitor is monitoring for.
480 #[must_use]
481 #[no_mangle]
482 pub extern "C" fn ChannelMonitor_get_funding_txo(this_arg: &ChannelMonitor) -> crate::c_types::derived::C2Tuple_OutPointScriptZ {
483         let mut ret = unsafe { &*this_arg.inner }.get_funding_txo();
484         let (ref orig_ret_0, ref orig_ret_1) = ret; let mut local_ret = (crate::chain::transaction::OutPoint { inner: unsafe { ( (&(*orig_ret_0) as *const _) as *mut _) }, is_owned: false }, orig_ret_1.clone().into_bytes().into()).into();
485         local_ret
486 }
487
488 /// Get the list of HTLCs who's status has been updated on chain. This should be called by
489 /// ChannelManager via [`chain::Watch::release_pending_monitor_events`].
490 ///
491 /// [`chain::Watch::release_pending_monitor_events`]: ../trait.Watch.html#tymethod.release_pending_monitor_events
492 #[must_use]
493 #[no_mangle]
494 pub extern "C" fn ChannelMonitor_get_and_clear_pending_monitor_events(this_arg: &mut ChannelMonitor) -> crate::c_types::derived::CVec_MonitorEventZ {
495         let mut ret = unsafe { &mut (*(this_arg.inner as *mut nativeChannelMonitor)) }.get_and_clear_pending_monitor_events();
496         let mut local_ret = Vec::new(); for item in ret.drain(..) { local_ret.push( { crate::chain::channelmonitor::MonitorEvent { inner: Box::into_raw(Box::new(item)), is_owned: true } }); };
497         local_ret.into()
498 }
499
500 /// Gets the list of pending events which were generated by previous actions, clearing the list
501 /// in the process.
502 ///
503 /// This is called by ChainMonitor::get_and_clear_pending_events() and is equivalent to
504 /// EventsProvider::get_and_clear_pending_events() except that it requires &mut self as we do
505 /// no internal locking in ChannelMonitors.
506 #[must_use]
507 #[no_mangle]
508 pub extern "C" fn ChannelMonitor_get_and_clear_pending_events(this_arg: &mut ChannelMonitor) -> crate::c_types::derived::CVec_EventZ {
509         let mut ret = unsafe { &mut (*(this_arg.inner as *mut nativeChannelMonitor)) }.get_and_clear_pending_events();
510         let mut local_ret = Vec::new(); for item in ret.drain(..) { local_ret.push( { crate::util::events::Event::native_into(item) }); };
511         local_ret.into()
512 }
513
514 /// Used by ChannelManager deserialization to broadcast the latest holder state if its copy of
515 /// the Channel was out-of-date. You may use it to get a broadcastable holder toxic tx in case of
516 /// fallen-behind, i.e when receiving a channel_reestablish with a proof that our counterparty side knows
517 /// a higher revocation secret than the holder commitment number we are aware of. Broadcasting these
518 /// transactions are UNSAFE, as they allow counterparty side to punish you. Nevertheless you may want to
519 /// broadcast them if counterparty don't close channel with his higher commitment transaction after a
520 /// substantial amount of time (a month or even a year) to get back funds. Best may be to contact
521 /// out-of-band the other node operator to coordinate with him if option is available to you.
522 /// In any-case, choice is up to the user.
523 #[must_use]
524 #[no_mangle]
525 pub extern "C" fn ChannelMonitor_get_latest_holder_commitment_txn(this_arg: &mut ChannelMonitor, logger: &crate::util::logger::Logger) -> crate::c_types::derived::CVec_TransactionZ {
526         let mut ret = unsafe { &mut (*(this_arg.inner as *mut nativeChannelMonitor)) }.get_latest_holder_commitment_txn(logger);
527         let mut local_ret = Vec::new(); for item in ret.drain(..) { local_ret.push( { let mut local_ret_0 = ::bitcoin::consensus::encode::serialize(&item); crate::c_types::Transaction::from_vec(local_ret_0) }); };
528         local_ret.into()
529 }
530
531 /// Processes transactions in a newly connected block, which may result in any of the following:
532 /// - update the monitor's state against resolved HTLCs
533 /// - punish the counterparty in the case of seeing a revoked commitment transaction
534 /// - force close the channel and claim/timeout incoming/outgoing HTLCs if near expiration
535 /// - detect settled outputs for later spending
536 /// - schedule and bump any in-flight claims
537 ///
538 /// Returns any new outputs to watch from `txdata`; after called, these are also included in
539 /// [`get_outputs_to_watch`].
540 ///
541 /// [`get_outputs_to_watch`]: #method.get_outputs_to_watch
542 #[must_use]
543 #[no_mangle]
544 pub extern "C" fn ChannelMonitor_block_connected(this_arg: &mut ChannelMonitor, header: *const [u8; 80], mut txdata: crate::c_types::derived::CVec_C2Tuple_usizeTransactionZZ, mut height: u32, mut broadcaster: crate::chain::chaininterface::BroadcasterInterface, mut fee_estimator: crate::chain::chaininterface::FeeEstimator, mut logger: crate::util::logger::Logger) -> crate::c_types::derived::CVec_C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZZ {
545         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 }); };
546         let mut ret = unsafe { &mut (*(this_arg.inner as *mut nativeChannelMonitor)) }.block_connected(&::bitcoin::consensus::encode::deserialize(unsafe { &*header }).unwrap(), &local_txdata.iter().map(|(a, b)| (*a, b)).collect::<Vec<_>>()[..], height, broadcaster, fee_estimator, logger);
547         let mut local_ret = Vec::new(); for 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 item in orig_ret_0_1.drain(..) { local_orig_ret_0_1.push( { let (mut orig_orig_ret_0_1_0_0, mut orig_orig_ret_0_1_0_1) = item; let mut local_orig_ret_0_1_0 = (orig_orig_ret_0_1_0_0, crate::c_types::TxOut::from_rust(orig_orig_ret_0_1_0_1)).into(); local_orig_ret_0_1_0 }); }; let mut local_ret_0 = (crate::c_types::ThirtyTwoBytes { data: orig_ret_0_0.into_inner() }, local_orig_ret_0_1.into()).into(); local_ret_0 }); };
548         local_ret.into()
549 }
550
551 /// Determines if the disconnected block contained any transactions of interest and updates
552 /// appropriately.
553 #[no_mangle]
554 pub extern "C" fn ChannelMonitor_block_disconnected(this_arg: &mut ChannelMonitor, header: *const [u8; 80], mut height: u32, mut broadcaster: crate::chain::chaininterface::BroadcasterInterface, mut fee_estimator: crate::chain::chaininterface::FeeEstimator, mut logger: crate::util::logger::Logger) {
555         unsafe { &mut (*(this_arg.inner as *mut nativeChannelMonitor)) }.block_disconnected(&::bitcoin::consensus::encode::deserialize(unsafe { &*header }).unwrap(), height, broadcaster, fee_estimator, logger)
556 }
557
558 /// `Persist` defines behavior for persisting channel monitors: this could mean
559 /// writing once to disk, and/or uploading to one or more backup services.
560 ///
561 /// Note that for every new monitor, you **must** persist the new `ChannelMonitor`
562 /// to disk/backups. And, on every update, you **must** persist either the
563 /// `ChannelMonitorUpdate` or the updated monitor itself. Otherwise, there is risk
564 /// of situations such as revoking a transaction, then crashing before this
565 /// revocation can be persisted, then unintentionally broadcasting a revoked
566 /// transaction and losing money. This is a risk because previous channel states
567 /// are toxic, so it's important that whatever channel state is persisted is
568 /// kept up-to-date.
569 #[repr(C)]
570 pub struct Persist {
571         pub this_arg: *mut c_void,
572         /// Persist a new channel's data. The data can be stored any way you want, but
573         /// the identifier provided by Rust-Lightning is the channel's outpoint (and
574         /// it is up to you to maintain a correct mapping between the outpoint and the
575         /// stored channel data). Note that you **must** persist every new monitor to
576         /// disk. See the `Persist` trait documentation for more details.
577         ///
578         /// See [`ChannelMonitor::serialize_for_disk`] for writing out a `ChannelMonitor`,
579         /// and [`ChannelMonitorUpdateErr`] for requirements when returning errors.
580         ///
581         /// [`ChannelMonitor::serialize_for_disk`]: struct.ChannelMonitor.html#method.serialize_for_disk
582         /// [`ChannelMonitorUpdateErr`]: enum.ChannelMonitorUpdateErr.html
583         #[must_use]
584         pub persist_new_channel: extern "C" fn (this_arg: *const c_void, id: crate::chain::transaction::OutPoint, data: &crate::chain::channelmonitor::ChannelMonitor) -> crate::c_types::derived::CResult_NoneChannelMonitorUpdateErrZ,
585         /// Update one channel's data. The provided `ChannelMonitor` has already
586         /// applied the given update.
587         ///
588         /// Note that on every update, you **must** persist either the
589         /// `ChannelMonitorUpdate` or the updated monitor itself to disk/backups. See
590         /// the `Persist` trait documentation for more details.
591         ///
592         /// If an implementer chooses to persist the updates only, they need to make
593         /// sure that all the updates are applied to the `ChannelMonitors` *before*
594         /// the set of channel monitors is given to the `ChannelManager`
595         /// deserialization routine. See [`ChannelMonitor::update_monitor`] for
596         /// applying a monitor update to a monitor. If full `ChannelMonitors` are
597         /// persisted, then there is no need to persist individual updates.
598         ///
599         /// Note that there could be a performance tradeoff between persisting complete
600         /// channel monitors on every update vs. persisting only updates and applying
601         /// them in batches. The size of each monitor grows `O(number of state updates)`
602         /// whereas updates are small and `O(1)`.
603         ///
604         /// See [`ChannelMonitor::serialize_for_disk`] for writing out a `ChannelMonitor`,
605         /// [`ChannelMonitorUpdate::write`] for writing out an update, and
606         /// [`ChannelMonitorUpdateErr`] for requirements when returning errors.
607         ///
608         /// [`ChannelMonitor::update_monitor`]: struct.ChannelMonitor.html#impl-1
609         /// [`ChannelMonitor::serialize_for_disk`]: struct.ChannelMonitor.html#method.serialize_for_disk
610         /// [`ChannelMonitorUpdate::write`]: struct.ChannelMonitorUpdate.html#method.write
611         /// [`ChannelMonitorUpdateErr`]: enum.ChannelMonitorUpdateErr.html
612         #[must_use]
613         pub update_persisted_channel: extern "C" fn (this_arg: *const c_void, id: crate::chain::transaction::OutPoint, update: &crate::chain::channelmonitor::ChannelMonitorUpdate, data: &crate::chain::channelmonitor::ChannelMonitor) -> crate::c_types::derived::CResult_NoneChannelMonitorUpdateErrZ,
614         pub free: Option<extern "C" fn(this_arg: *mut c_void)>,
615 }
616 unsafe impl Send for Persist {}
617 unsafe impl Sync for Persist {}
618
619 use lightning::chain::channelmonitor::Persist as rustPersist;
620 impl rustPersist<crate::chain::keysinterface::ChannelKeys> for Persist {
621         fn persist_new_channel(&self, id: lightning::chain::transaction::OutPoint, data: &lightning::chain::channelmonitor::ChannelMonitor<crate::chain::keysinterface::ChannelKeys>) -> Result<(), lightning::chain::channelmonitor::ChannelMonitorUpdateErr> {
622                 let mut ret = (self.persist_new_channel)(self.this_arg, crate::chain::transaction::OutPoint { inner: Box::into_raw(Box::new(id)), is_owned: true }, &crate::chain::channelmonitor::ChannelMonitor { inner: unsafe { (data as *const _) as *mut _ }, is_owned: false });
623                 let mut local_ret = match ret.result_ok { true => Ok( { () /*(*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.result)) })*/ }), false => Err( { (*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.err)) }).into_native() })};
624                 local_ret
625         }
626         fn update_persisted_channel(&self, id: lightning::chain::transaction::OutPoint, update: &lightning::chain::channelmonitor::ChannelMonitorUpdate, data: &lightning::chain::channelmonitor::ChannelMonitor<crate::chain::keysinterface::ChannelKeys>) -> Result<(), lightning::chain::channelmonitor::ChannelMonitorUpdateErr> {
627                 let mut ret = (self.update_persisted_channel)(self.this_arg, crate::chain::transaction::OutPoint { inner: Box::into_raw(Box::new(id)), is_owned: true }, &crate::chain::channelmonitor::ChannelMonitorUpdate { inner: unsafe { (update as *const _) as *mut _ }, is_owned: false }, &crate::chain::channelmonitor::ChannelMonitor { inner: unsafe { (data as *const _) as *mut _ }, is_owned: false });
628                 let mut local_ret = match ret.result_ok { true => Ok( { () /*(*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.result)) })*/ }), false => Err( { (*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.err)) }).into_native() })};
629                 local_ret
630         }
631 }
632
633 // We're essentially a pointer already, or at least a set of pointers, so allow us to be used
634 // directly as a Deref trait in higher-level structs:
635 impl std::ops::Deref for Persist {
636         type Target = Self;
637         fn deref(&self) -> &Self {
638                 self
639         }
640 }
641 /// Calls the free function if one is set
642 #[no_mangle]
643 pub extern "C" fn Persist_free(this_ptr: Persist) { }
644 impl Drop for Persist {
645         fn drop(&mut self) {
646                 if let Some(f) = self.free {
647                         f(self.this_arg);
648                 }
649         }
650 }
651 #[no_mangle]
652 pub extern "C" fn C2Tuple_BlockHashChannelMonitorZ_read(ser: crate::c_types::u8slice, arg: &crate::chain::keysinterface::KeysInterface) -> crate::c_types::derived::CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ {
653         let arg_conv = arg;
654         let res: Result<(bitcoin::hash_types::BlockHash, lightning::chain::channelmonitor::ChannelMonitor<crate::chain::keysinterface::ChannelKeys>), lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj_arg(ser, arg_conv);
655         let mut local_res = match res { Ok(mut o) => crate::c_types::CResultTempl::ok( { let (mut orig_res_0_0, mut orig_res_0_1) = o; let mut local_res_0 = (crate::c_types::ThirtyTwoBytes { data: orig_res_0_0.into_inner() }, crate::chain::channelmonitor::ChannelMonitor { inner: Box::into_raw(Box::new(orig_res_0_1)), is_owned: true }).into(); local_res_0 }), Err(mut e) => crate::c_types::CResultTempl::err( { crate::ln::msgs::DecodeError { inner: Box::into_raw(Box::new(e)), is_owned: true } }) };
656         local_res
657 }