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 //! The logic to monitor for on-chain transactions and create the relevant claim responses lives
12 //! ChannelMonitor objects are generated by ChannelManager in response to relevant
13 //! messages/actions, and MUST be persisted to disk (and, preferably, remotely) before progress can
14 //! be made in responding to certain messages, see [`chain::Watch`] for more.
16 //! Note that ChannelMonitors are an important part of the lightning trust model and a copy of the
17 //! latest ChannelMonitor must always be actively monitoring for chain updates (and no out-of-date
18 //! ChannelMonitors should do so). Thus, if you're building rust-lightning into an HSM or other
19 //! security-domain-separated system design, you should consider having multiple paths for
20 //! ChannelMonitors to get out of the HSM and onto monitoring devices.
22 use std::str::FromStr;
24 use bitcoin::hashes::Hash;
25 use crate::c_types::*;
28 use lightning::chain::channelmonitor::ChannelMonitorUpdate as nativeChannelMonitorUpdateImport;
29 type nativeChannelMonitorUpdate = nativeChannelMonitorUpdateImport;
31 /// An update generated by the underlying Channel itself which contains some new information the
32 /// ChannelMonitor should be made aware of.
35 pub struct ChannelMonitorUpdate {
36 /// A pointer to the opaque Rust object.
38 /// Nearly everywhere, inner must be non-null, however in places where
39 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
40 pub inner: *mut nativeChannelMonitorUpdate,
41 /// Indicates that this is the only struct which contains the same pointer.
43 /// Rust functions which take ownership of an object provided via an argument require
44 /// this to be true and invalidate the object pointed to by inner.
48 impl Drop for ChannelMonitorUpdate {
50 if self.is_owned && !<*mut nativeChannelMonitorUpdate>::is_null(self.inner) {
51 let _ = unsafe { Box::from_raw(self.inner) };
55 /// Frees any resources used by the ChannelMonitorUpdate, if is_owned is set and inner is non-NULL.
57 pub extern "C" fn ChannelMonitorUpdate_free(this_obj: ChannelMonitorUpdate) { }
59 /// Used only if an object of this type is returned as a trait impl by a method
60 extern "C" fn ChannelMonitorUpdate_free_void(this_ptr: *mut c_void) {
61 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeChannelMonitorUpdate); }
64 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
65 impl ChannelMonitorUpdate {
66 pub(crate) fn take_inner(mut self) -> *mut nativeChannelMonitorUpdate {
67 assert!(self.is_owned);
69 self.inner = std::ptr::null_mut();
73 /// The sequence number of this update. Updates *must* be replayed in-order according to this
74 /// sequence number (and updates may panic if they are not). The update_id values are strictly
75 /// increasing and increase by one for each new update, with one exception specified below.
77 /// This sequence number is also used to track up to which points updates which returned
78 /// ChannelMonitorUpdateErr::TemporaryFailure have been applied to all copies of a given
79 /// ChannelMonitor when ChannelManager::channel_monitor_updated is called.
81 /// The only instance where update_id values are not strictly increasing is the case where we
82 /// allow post-force-close updates with a special update ID of [`CLOSED_CHANNEL_UPDATE_ID`]. See
83 /// its docs for more details.
85 pub extern "C" fn ChannelMonitorUpdate_get_update_id(this_ptr: &ChannelMonitorUpdate) -> u64 {
86 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.update_id;
89 /// The sequence number of this update. Updates *must* be replayed in-order according to this
90 /// sequence number (and updates may panic if they are not). The update_id values are strictly
91 /// increasing and increase by one for each new update, with one exception specified below.
93 /// This sequence number is also used to track up to which points updates which returned
94 /// ChannelMonitorUpdateErr::TemporaryFailure have been applied to all copies of a given
95 /// ChannelMonitor when ChannelManager::channel_monitor_updated is called.
97 /// The only instance where update_id values are not strictly increasing is the case where we
98 /// allow post-force-close updates with a special update ID of [`CLOSED_CHANNEL_UPDATE_ID`]. See
99 /// its docs for more details.
101 pub extern "C" fn ChannelMonitorUpdate_set_update_id(this_ptr: &mut ChannelMonitorUpdate, mut val: u64) {
102 unsafe { &mut *this_ptr.inner }.update_id = val;
104 impl Clone for ChannelMonitorUpdate {
105 fn clone(&self) -> Self {
107 inner: if <*mut nativeChannelMonitorUpdate>::is_null(self.inner) { std::ptr::null_mut() } else {
108 Box::into_raw(Box::new(unsafe { &*self.inner }.clone())) },
114 /// Used only if an object of this type is returned as a trait impl by a method
115 pub(crate) extern "C" fn ChannelMonitorUpdate_clone_void(this_ptr: *const c_void) -> *mut c_void {
116 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeChannelMonitorUpdate)).clone() })) as *mut c_void
119 /// Creates a copy of the ChannelMonitorUpdate
120 pub extern "C" fn ChannelMonitorUpdate_clone(orig: &ChannelMonitorUpdate) -> ChannelMonitorUpdate {
124 /// (1) a channel has been force closed and
125 /// (2) we receive a preimage from a forward link that allows us to spend an HTLC output on
126 /// this channel's (the backward link's) broadcasted commitment transaction
127 /// then we allow the `ChannelManager` to send a `ChannelMonitorUpdate` with this update ID,
128 /// with the update providing said payment preimage. No other update types are allowed after
132 pub static CLOSED_CHANNEL_UPDATE_ID: u64 = lightning::chain::channelmonitor::CLOSED_CHANNEL_UPDATE_ID;
134 /// Serialize the ChannelMonitorUpdate object into a byte array which can be read by ChannelMonitorUpdate_read
135 pub extern "C" fn ChannelMonitorUpdate_write(obj: &ChannelMonitorUpdate) -> crate::c_types::derived::CVec_u8Z {
136 crate::c_types::serialize_obj(unsafe { &*unsafe { &*obj }.inner })
139 pub(crate) extern "C" fn ChannelMonitorUpdate_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
140 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeChannelMonitorUpdate) })
143 /// Read a ChannelMonitorUpdate from a byte array, created by ChannelMonitorUpdate_write
144 pub extern "C" fn ChannelMonitorUpdate_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_ChannelMonitorUpdateDecodeErrorZ {
145 let res = crate::c_types::deserialize_obj(ser);
146 let mut local_res = match res { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::lightning::chain::channelmonitor::ChannelMonitorUpdate { inner: Box::into_raw(Box::new(o)), is_owned: true } }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::ln::msgs::DecodeError { inner: Box::into_raw(Box::new(e)), is_owned: true } }).into() };
149 /// An error enum representing a failure to persist a channel monitor update.
153 pub enum ChannelMonitorUpdateErr {
154 /// Used to indicate a temporary failure (eg connection to a watchtower or remote backup of
155 /// our state failed, but is expected to succeed at some point in the future).
157 /// Such a failure will \"freeze\" a channel, preventing us from revoking old states or
158 /// submitting new commitment transactions to the counterparty. Once the update(s) which failed
159 /// have been successfully applied, ChannelManager::channel_monitor_updated can be used to
160 /// restore the channel to an operational state.
162 /// Note that a given ChannelManager will *never* re-generate a given ChannelMonitorUpdate. If
163 /// you return a TemporaryFailure you must ensure that it is written to disk safely before
164 /// writing out the latest ChannelManager state.
166 /// Even when a channel has been \"frozen\" updates to the ChannelMonitor can continue to occur
167 /// (eg if an inbound HTLC which we forwarded was claimed upstream resulting in us attempting
168 /// to claim it on this channel) and those updates must be applied wherever they can be. At
169 /// least one such updated ChannelMonitor must be persisted otherwise PermanentFailure should
170 /// be returned to get things on-chain ASAP using only the in-memory copy. Obviously updates to
171 /// the channel which would invalidate previous ChannelMonitors are not made when a channel has
174 /// Note that even if updates made after TemporaryFailure succeed you must still call
175 /// channel_monitor_updated to ensure you have the latest monitor and re-enable normal channel
178 /// Note that the update being processed here will not be replayed for you when you call
179 /// ChannelManager::channel_monitor_updated, so you must store the update itself along
180 /// with the persisted ChannelMonitor on your own local disk prior to returning a
181 /// TemporaryFailure. You may, of course, employ a journaling approach, storing only the
182 /// ChannelMonitorUpdate on disk without updating the monitor itself, replaying the journal at
185 /// For deployments where a copy of ChannelMonitors and other local state are backed up in a
186 /// remote location (with local copies persisted immediately), it is anticipated that all
187 /// updates will return TemporaryFailure until the remote copies could be updated.
189 /// Used to indicate no further channel monitor updates will be allowed (eg we've moved on to a
190 /// different watchtower and cannot update with all watchtowers that were previously informed
191 /// of this channel).
193 /// At reception of this error, ChannelManager will force-close the channel and return at
194 /// least a final ChannelMonitorUpdate::ChannelForceClosed which must be delivered to at
195 /// least one ChannelMonitor copy. Revocation secret MUST NOT be released and offchain channel
196 /// update must be rejected.
198 /// This failure may also signal a failure to update the local persisted copy of one of
199 /// the channel monitor instance.
201 /// Note that even when you fail a holder commitment transaction update, you must store the
202 /// update to ensure you can claim from it in case of a duplicate copy of this ChannelMonitor
203 /// broadcasts it (e.g distributed channel-monitor deployment)
205 /// In case of distributed watchtowers deployment, the new version must be written to disk, as
206 /// state may have been stored but rejected due to a block forcing a commitment broadcast. This
207 /// storage is used to claim outputs of rejected state confirmed onchain by another watchtower,
208 /// lagging behind on block processing.
211 use lightning::chain::channelmonitor::ChannelMonitorUpdateErr as nativeChannelMonitorUpdateErr;
212 impl ChannelMonitorUpdateErr {
214 pub(crate) fn to_native(&self) -> nativeChannelMonitorUpdateErr {
216 ChannelMonitorUpdateErr::TemporaryFailure => nativeChannelMonitorUpdateErr::TemporaryFailure,
217 ChannelMonitorUpdateErr::PermanentFailure => nativeChannelMonitorUpdateErr::PermanentFailure,
221 pub(crate) fn into_native(self) -> nativeChannelMonitorUpdateErr {
223 ChannelMonitorUpdateErr::TemporaryFailure => nativeChannelMonitorUpdateErr::TemporaryFailure,
224 ChannelMonitorUpdateErr::PermanentFailure => nativeChannelMonitorUpdateErr::PermanentFailure,
228 pub(crate) fn from_native(native: &nativeChannelMonitorUpdateErr) -> Self {
230 nativeChannelMonitorUpdateErr::TemporaryFailure => ChannelMonitorUpdateErr::TemporaryFailure,
231 nativeChannelMonitorUpdateErr::PermanentFailure => ChannelMonitorUpdateErr::PermanentFailure,
235 pub(crate) fn native_into(native: nativeChannelMonitorUpdateErr) -> Self {
237 nativeChannelMonitorUpdateErr::TemporaryFailure => ChannelMonitorUpdateErr::TemporaryFailure,
238 nativeChannelMonitorUpdateErr::PermanentFailure => ChannelMonitorUpdateErr::PermanentFailure,
242 /// Creates a copy of the ChannelMonitorUpdateErr
244 pub extern "C" fn ChannelMonitorUpdateErr_clone(orig: &ChannelMonitorUpdateErr) -> ChannelMonitorUpdateErr {
248 use lightning::chain::channelmonitor::MonitorUpdateError as nativeMonitorUpdateErrorImport;
249 type nativeMonitorUpdateError = nativeMonitorUpdateErrorImport;
251 /// General Err type for ChannelMonitor actions. Generally, this implies that the data provided is
252 /// inconsistent with the ChannelMonitor being called. eg for ChannelMonitor::update_monitor this
253 /// means you tried to update a monitor for a different channel or the ChannelMonitorUpdate was
255 /// Contains a developer-readable error message.
258 pub struct MonitorUpdateError {
259 /// A pointer to the opaque Rust object.
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 nativeMonitorUpdateError,
264 /// Indicates that this is the only struct which contains the same pointer.
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.
271 impl Drop for MonitorUpdateError {
273 if self.is_owned && !<*mut nativeMonitorUpdateError>::is_null(self.inner) {
274 let _ = unsafe { Box::from_raw(self.inner) };
278 /// Frees any resources used by the MonitorUpdateError, if is_owned is set and inner is non-NULL.
280 pub extern "C" fn MonitorUpdateError_free(this_obj: MonitorUpdateError) { }
282 /// Used only if an object of this type is returned as a trait impl by a method
283 extern "C" fn MonitorUpdateError_free_void(this_ptr: *mut c_void) {
284 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeMonitorUpdateError); }
287 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
288 impl MonitorUpdateError {
289 pub(crate) fn take_inner(mut self) -> *mut nativeMonitorUpdateError {
290 assert!(self.is_owned);
291 let ret = self.inner;
292 self.inner = std::ptr::null_mut();
296 impl Clone for MonitorUpdateError {
297 fn clone(&self) -> Self {
299 inner: if <*mut nativeMonitorUpdateError>::is_null(self.inner) { std::ptr::null_mut() } else {
300 Box::into_raw(Box::new(unsafe { &*self.inner }.clone())) },
306 /// Used only if an object of this type is returned as a trait impl by a method
307 pub(crate) extern "C" fn MonitorUpdateError_clone_void(this_ptr: *const c_void) -> *mut c_void {
308 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeMonitorUpdateError)).clone() })) as *mut c_void
311 /// Creates a copy of the MonitorUpdateError
312 pub extern "C" fn MonitorUpdateError_clone(orig: &MonitorUpdateError) -> MonitorUpdateError {
315 /// An event to be processed by the ChannelManager.
319 pub enum MonitorEvent {
320 /// A monitor event containing an HTLCUpdate.
321 HTLCEvent(crate::lightning::chain::channelmonitor::HTLCUpdate),
322 /// A monitor event that the Channel's commitment transaction was broadcasted.
323 CommitmentTxBroadcasted(crate::lightning::chain::transaction::OutPoint),
325 use lightning::chain::channelmonitor::MonitorEvent as nativeMonitorEvent;
328 pub(crate) fn to_native(&self) -> nativeMonitorEvent {
330 MonitorEvent::HTLCEvent (ref a, ) => {
331 let mut a_nonref = (*a).clone();
332 nativeMonitorEvent::HTLCEvent (
333 *unsafe { Box::from_raw(a_nonref.take_inner()) },
336 MonitorEvent::CommitmentTxBroadcasted (ref a, ) => {
337 let mut a_nonref = (*a).clone();
338 nativeMonitorEvent::CommitmentTxBroadcasted (
339 *unsafe { Box::from_raw(a_nonref.take_inner()) },
345 pub(crate) fn into_native(self) -> nativeMonitorEvent {
347 MonitorEvent::HTLCEvent (mut a, ) => {
348 nativeMonitorEvent::HTLCEvent (
349 *unsafe { Box::from_raw(a.take_inner()) },
352 MonitorEvent::CommitmentTxBroadcasted (mut a, ) => {
353 nativeMonitorEvent::CommitmentTxBroadcasted (
354 *unsafe { Box::from_raw(a.take_inner()) },
360 pub(crate) fn from_native(native: &nativeMonitorEvent) -> Self {
362 nativeMonitorEvent::HTLCEvent (ref a, ) => {
363 let mut a_nonref = (*a).clone();
364 MonitorEvent::HTLCEvent (
365 crate::lightning::chain::channelmonitor::HTLCUpdate { inner: Box::into_raw(Box::new(a_nonref)), is_owned: true },
368 nativeMonitorEvent::CommitmentTxBroadcasted (ref a, ) => {
369 let mut a_nonref = (*a).clone();
370 MonitorEvent::CommitmentTxBroadcasted (
371 crate::lightning::chain::transaction::OutPoint { inner: Box::into_raw(Box::new(a_nonref)), is_owned: true },
377 pub(crate) fn native_into(native: nativeMonitorEvent) -> Self {
379 nativeMonitorEvent::HTLCEvent (mut a, ) => {
380 MonitorEvent::HTLCEvent (
381 crate::lightning::chain::channelmonitor::HTLCUpdate { inner: Box::into_raw(Box::new(a)), is_owned: true },
384 nativeMonitorEvent::CommitmentTxBroadcasted (mut a, ) => {
385 MonitorEvent::CommitmentTxBroadcasted (
386 crate::lightning::chain::transaction::OutPoint { inner: Box::into_raw(Box::new(a)), is_owned: true },
392 /// Frees any resources used by the MonitorEvent
394 pub extern "C" fn MonitorEvent_free(this_ptr: MonitorEvent) { }
395 /// Creates a copy of the MonitorEvent
397 pub extern "C" fn MonitorEvent_clone(orig: &MonitorEvent) -> MonitorEvent {
401 use lightning::chain::channelmonitor::HTLCUpdate as nativeHTLCUpdateImport;
402 type nativeHTLCUpdate = nativeHTLCUpdateImport;
404 /// Simple structure sent back by `chain::Watch` when an HTLC from a forward channel is detected on
405 /// chain. Used to update the corresponding HTLC in the backward channel. Failing to pass the
406 /// preimage claim backward will lead to loss of funds.
409 pub struct HTLCUpdate {
410 /// A pointer to the opaque Rust object.
412 /// Nearly everywhere, inner must be non-null, however in places where
413 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
414 pub inner: *mut nativeHTLCUpdate,
415 /// Indicates that this is the only struct which contains the same pointer.
417 /// Rust functions which take ownership of an object provided via an argument require
418 /// this to be true and invalidate the object pointed to by inner.
422 impl Drop for HTLCUpdate {
424 if self.is_owned && !<*mut nativeHTLCUpdate>::is_null(self.inner) {
425 let _ = unsafe { Box::from_raw(self.inner) };
429 /// Frees any resources used by the HTLCUpdate, if is_owned is set and inner is non-NULL.
431 pub extern "C" fn HTLCUpdate_free(this_obj: HTLCUpdate) { }
433 /// Used only if an object of this type is returned as a trait impl by a method
434 extern "C" fn HTLCUpdate_free_void(this_ptr: *mut c_void) {
435 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeHTLCUpdate); }
438 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
440 pub(crate) fn take_inner(mut self) -> *mut nativeHTLCUpdate {
441 assert!(self.is_owned);
442 let ret = self.inner;
443 self.inner = std::ptr::null_mut();
447 impl Clone for HTLCUpdate {
448 fn clone(&self) -> Self {
450 inner: if <*mut nativeHTLCUpdate>::is_null(self.inner) { std::ptr::null_mut() } else {
451 Box::into_raw(Box::new(unsafe { &*self.inner }.clone())) },
457 /// Used only if an object of this type is returned as a trait impl by a method
458 pub(crate) extern "C" fn HTLCUpdate_clone_void(this_ptr: *const c_void) -> *mut c_void {
459 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeHTLCUpdate)).clone() })) as *mut c_void
462 /// Creates a copy of the HTLCUpdate
463 pub extern "C" fn HTLCUpdate_clone(orig: &HTLCUpdate) -> HTLCUpdate {
467 /// Serialize the HTLCUpdate object into a byte array which can be read by HTLCUpdate_read
468 pub extern "C" fn HTLCUpdate_write(obj: &HTLCUpdate) -> crate::c_types::derived::CVec_u8Z {
469 crate::c_types::serialize_obj(unsafe { &*unsafe { &*obj }.inner })
472 pub(crate) extern "C" fn HTLCUpdate_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
473 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeHTLCUpdate) })
476 /// Read a HTLCUpdate from a byte array, created by HTLCUpdate_write
477 pub extern "C" fn HTLCUpdate_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_HTLCUpdateDecodeErrorZ {
478 let res = crate::c_types::deserialize_obj(ser);
479 let mut local_res = match res { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::lightning::chain::channelmonitor::HTLCUpdate { inner: Box::into_raw(Box::new(o)), is_owned: true } }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::ln::msgs::DecodeError { inner: Box::into_raw(Box::new(e)), is_owned: true } }).into() };
482 /// Number of blocks we wait on seeing a HTLC output being solved before we fail corresponding inbound
483 /// HTLCs. This prevents us from failing backwards and then getting a reorg resulting in us losing money.
486 pub static ANTI_REORG_DELAY: u32 = lightning::chain::channelmonitor::ANTI_REORG_DELAY;
488 use lightning::chain::channelmonitor::ChannelMonitor as nativeChannelMonitorImport;
489 type nativeChannelMonitor = nativeChannelMonitorImport<crate::lightning::chain::keysinterface::Sign>;
491 /// A ChannelMonitor handles chain events (blocks connected and disconnected) and generates
492 /// on-chain transactions to ensure no loss of funds occurs.
494 /// You MUST ensure that no ChannelMonitors for a given channel anywhere contain out-of-date
495 /// information and are actively monitoring the chain.
497 /// Pending Events or updated HTLCs which have not yet been read out by
498 /// get_and_clear_pending_monitor_events or get_and_clear_pending_events are serialized to disk and
499 /// reloaded at deserialize-time. Thus, you must ensure that, when handling events, all events
500 /// gotten are fully handled before re-serializing the new state.
502 /// Note that the deserializer is only implemented for (BlockHash, ChannelMonitor), which
503 /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
504 /// the \"reorg path\" (ie disconnecting blocks until you find a common ancestor from both the
505 /// returned block hash and the the current chain and then reconnecting blocks to get to the
506 /// best chain) upon deserializing the object!
509 pub struct ChannelMonitor {
510 /// A pointer to the opaque Rust object.
512 /// Nearly everywhere, inner must be non-null, however in places where
513 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
514 pub inner: *mut nativeChannelMonitor,
515 /// Indicates that this is the only struct which contains the same pointer.
517 /// Rust functions which take ownership of an object provided via an argument require
518 /// this to be true and invalidate the object pointed to by inner.
522 impl Drop for ChannelMonitor {
524 if self.is_owned && !<*mut nativeChannelMonitor>::is_null(self.inner) {
525 let _ = unsafe { Box::from_raw(self.inner) };
529 /// Frees any resources used by the ChannelMonitor, if is_owned is set and inner is non-NULL.
531 pub extern "C" fn ChannelMonitor_free(this_obj: ChannelMonitor) { }
533 /// Used only if an object of this type is returned as a trait impl by a method
534 extern "C" fn ChannelMonitor_free_void(this_ptr: *mut c_void) {
535 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeChannelMonitor); }
538 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
539 impl ChannelMonitor {
540 pub(crate) fn take_inner(mut self) -> *mut nativeChannelMonitor {
541 assert!(self.is_owned);
542 let ret = self.inner;
543 self.inner = std::ptr::null_mut();
548 /// Serialize the ChannelMonitor object into a byte array which can be read by ChannelMonitor_read
549 pub extern "C" fn ChannelMonitor_write(obj: &ChannelMonitor) -> crate::c_types::derived::CVec_u8Z {
550 crate::c_types::serialize_obj(unsafe { &*unsafe { &*obj }.inner })
553 pub(crate) extern "C" fn ChannelMonitor_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
554 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeChannelMonitor) })
556 /// Updates a ChannelMonitor on the basis of some new information provided by the Channel
559 /// panics if the given update is not the next update by update_id.
562 pub extern "C" fn ChannelMonitor_update_monitor(this_arg: &ChannelMonitor, updates: &crate::lightning::chain::channelmonitor::ChannelMonitorUpdate, broadcaster: &crate::lightning::chain::chaininterface::BroadcasterInterface, fee_estimator: &crate::lightning::chain::chaininterface::FeeEstimator, logger: &crate::lightning::util::logger::Logger) -> crate::c_types::derived::CResult_NoneMonitorUpdateErrorZ {
563 let mut ret = unsafe { &*this_arg.inner }.update_monitor(unsafe { &*updates.inner }, broadcaster, fee_estimator, logger);
564 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::chain::channelmonitor::MonitorUpdateError { inner: Box::into_raw(Box::new(e)), is_owned: true } }).into() };
568 /// Gets the update_id from the latest ChannelMonitorUpdate which was applied to this
572 pub extern "C" fn ChannelMonitor_get_latest_update_id(this_arg: &ChannelMonitor) -> u64 {
573 let mut ret = unsafe { &*this_arg.inner }.get_latest_update_id();
577 /// Gets the funding transaction outpoint of the channel this ChannelMonitor is monitoring for.
580 pub extern "C" fn ChannelMonitor_get_funding_txo(this_arg: &ChannelMonitor) -> crate::c_types::derived::C2Tuple_OutPointScriptZ {
581 let mut ret = unsafe { &*this_arg.inner }.get_funding_txo();
582 let (mut orig_ret_0, mut orig_ret_1) = ret; let mut local_ret = (crate::lightning::chain::transaction::OutPoint { inner: Box::into_raw(Box::new(orig_ret_0)), is_owned: true }, orig_ret_1.into_bytes().into()).into();
586 /// Gets a list of txids, with their output scripts (in the order they appear in the
587 /// transaction), which we must learn about spends of via block_connected().
590 pub extern "C" fn ChannelMonitor_get_outputs_to_watch(this_arg: &ChannelMonitor) -> crate::c_types::derived::CVec_C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZZ {
591 let mut ret = unsafe { &*this_arg.inner }.get_outputs_to_watch();
592 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( { 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, orig_orig_ret_0_1_0_1.into_bytes().into()).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 }); };
596 /// Loads the funding txo and outputs to watch into the given `chain::Filter` by repeatedly
597 /// calling `chain::Filter::register_output` and `chain::Filter::register_tx` until all outputs
598 /// have been registered.
600 pub extern "C" fn ChannelMonitor_load_outputs_to_watch(this_arg: &ChannelMonitor, filter: &crate::lightning::chain::Filter) {
601 unsafe { &*this_arg.inner }.load_outputs_to_watch(filter)
604 /// Get the list of HTLCs who's status has been updated on chain. This should be called by
605 /// ChannelManager via [`chain::Watch::release_pending_monitor_events`].
608 pub extern "C" fn ChannelMonitor_get_and_clear_pending_monitor_events(this_arg: &ChannelMonitor) -> crate::c_types::derived::CVec_MonitorEventZ {
609 let mut ret = unsafe { &*this_arg.inner }.get_and_clear_pending_monitor_events();
610 let mut local_ret = Vec::new(); for mut item in ret.drain(..) { local_ret.push( { crate::lightning::chain::channelmonitor::MonitorEvent::native_into(item) }); };
614 /// Gets the list of pending events which were generated by previous actions, clearing the list
617 /// This is called by ChainMonitor::get_and_clear_pending_events() and is equivalent to
618 /// EventsProvider::get_and_clear_pending_events() except that it requires &mut self as we do
619 /// no internal locking in ChannelMonitors.
622 pub extern "C" fn ChannelMonitor_get_and_clear_pending_events(this_arg: &ChannelMonitor) -> crate::c_types::derived::CVec_EventZ {
623 let mut ret = unsafe { &*this_arg.inner }.get_and_clear_pending_events();
624 let mut local_ret = Vec::new(); for mut item in ret.drain(..) { local_ret.push( { crate::lightning::util::events::Event::native_into(item) }); };
628 /// Used by ChannelManager deserialization to broadcast the latest holder state if its copy of
629 /// the Channel was out-of-date. You may use it to get a broadcastable holder toxic tx in case of
630 /// fallen-behind, i.e when receiving a channel_reestablish with a proof that our counterparty side knows
631 /// a higher revocation secret than the holder commitment number we are aware of. Broadcasting these
632 /// transactions are UNSAFE, as they allow counterparty side to punish you. Nevertheless you may want to
633 /// broadcast them if counterparty don't close channel with his higher commitment transaction after a
634 /// substantial amount of time (a month or even a year) to get back funds. Best may be to contact
635 /// out-of-band the other node operator to coordinate with him if option is available to you.
636 /// In any-case, choice is up to the user.
639 pub extern "C" fn ChannelMonitor_get_latest_holder_commitment_txn(this_arg: &ChannelMonitor, logger: &crate::lightning::util::logger::Logger) -> crate::c_types::derived::CVec_TransactionZ {
640 let mut ret = unsafe { &*this_arg.inner }.get_latest_holder_commitment_txn(logger);
641 let mut local_ret = Vec::new(); for mut item in ret.drain(..) { local_ret.push( { crate::c_types::Transaction::from_bitcoin(&item) }); };
645 /// Processes transactions in a newly connected block, which may result in any of the following:
646 /// - update the monitor's state against resolved HTLCs
647 /// - punish the counterparty in the case of seeing a revoked commitment transaction
648 /// - force close the channel and claim/timeout incoming/outgoing HTLCs if near expiration
649 /// - detect settled outputs for later spending
650 /// - schedule and bump any in-flight claims
652 /// Returns any new outputs to watch from `txdata`; after called, these are also included in
653 /// [`get_outputs_to_watch`].
655 /// [`get_outputs_to_watch`]: #method.get_outputs_to_watch
658 pub extern "C" fn ChannelMonitor_block_connected(this_arg: &ChannelMonitor, header: *const [u8; 80], mut txdata: crate::c_types::derived::CVec_C2Tuple_usizeTransactionZZ, mut height: u32, mut broadcaster: crate::lightning::chain::chaininterface::BroadcasterInterface, mut fee_estimator: crate::lightning::chain::chaininterface::FeeEstimator, mut logger: crate::lightning::util::logger::Logger) -> crate::c_types::derived::CVec_TransactionOutputsZ {
659 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 }); };
660 let mut ret = unsafe { &*this_arg.inner }.block_connected(&::bitcoin::consensus::encode::deserialize(unsafe { &*header }).unwrap(), &local_txdata.iter().map(|(a, b)| (*a, b)).collect::<Vec<_>>()[..], height, broadcaster, fee_estimator, logger);
661 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( { 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 }); };
665 /// Determines if the disconnected block contained any transactions of interest and updates
668 pub extern "C" fn ChannelMonitor_block_disconnected(this_arg: &ChannelMonitor, header: *const [u8; 80], mut height: u32, mut broadcaster: crate::lightning::chain::chaininterface::BroadcasterInterface, mut fee_estimator: crate::lightning::chain::chaininterface::FeeEstimator, mut logger: crate::lightning::util::logger::Logger) {
669 unsafe { &*this_arg.inner }.block_disconnected(&::bitcoin::consensus::encode::deserialize(unsafe { &*header }).unwrap(), height, broadcaster, fee_estimator, logger)
672 /// Processes transactions confirmed in a block with the given header and height, returning new
673 /// outputs to watch. See [`block_connected`] for details.
675 /// Used instead of [`block_connected`] by clients that are notified of transactions rather than
676 /// blocks. See [`chain::Confirm`] for calling expectations.
678 /// [`block_connected`]: Self::block_connected
681 pub extern "C" fn ChannelMonitor_transactions_confirmed(this_arg: &ChannelMonitor, header: *const [u8; 80], mut txdata: crate::c_types::derived::CVec_C2Tuple_usizeTransactionZZ, mut height: u32, mut broadcaster: crate::lightning::chain::chaininterface::BroadcasterInterface, mut fee_estimator: crate::lightning::chain::chaininterface::FeeEstimator, mut logger: crate::lightning::util::logger::Logger) -> crate::c_types::derived::CVec_TransactionOutputsZ {
682 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 }); };
683 let mut ret = unsafe { &*this_arg.inner }.transactions_confirmed(&::bitcoin::consensus::encode::deserialize(unsafe { &*header }).unwrap(), &local_txdata.iter().map(|(a, b)| (*a, b)).collect::<Vec<_>>()[..], height, broadcaster, fee_estimator, logger);
684 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( { 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 }); };
688 /// Processes a transaction that was reorganized out of the chain.
690 /// Used instead of [`block_disconnected`] by clients that are notified of transactions rather
691 /// than blocks. See [`chain::Confirm`] for calling expectations.
693 /// [`block_disconnected`]: Self::block_disconnected
695 pub extern "C" fn ChannelMonitor_transaction_unconfirmed(this_arg: &ChannelMonitor, txid: *const [u8; 32], mut broadcaster: crate::lightning::chain::chaininterface::BroadcasterInterface, mut fee_estimator: crate::lightning::chain::chaininterface::FeeEstimator, mut logger: crate::lightning::util::logger::Logger) {
696 unsafe { &*this_arg.inner }.transaction_unconfirmed(&::bitcoin::hash_types::Txid::from_slice(&unsafe { &*txid }[..]).unwrap(), broadcaster, fee_estimator, logger)
699 /// Updates the monitor with the current best chain tip, returning new outputs to watch. See
700 /// [`block_connected`] for details.
702 /// Used instead of [`block_connected`] by clients that are notified of transactions rather than
703 /// blocks. See [`chain::Confirm`] for calling expectations.
705 /// [`block_connected`]: Self::block_connected
708 pub extern "C" fn ChannelMonitor_best_block_updated(this_arg: &ChannelMonitor, header: *const [u8; 80], mut height: u32, mut broadcaster: crate::lightning::chain::chaininterface::BroadcasterInterface, mut fee_estimator: crate::lightning::chain::chaininterface::FeeEstimator, mut logger: crate::lightning::util::logger::Logger) -> crate::c_types::derived::CVec_TransactionOutputsZ {
709 let mut ret = unsafe { &*this_arg.inner }.best_block_updated(&::bitcoin::consensus::encode::deserialize(unsafe { &*header }).unwrap(), height, broadcaster, fee_estimator, logger);
710 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( { 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 }); };
714 /// Returns the set of txids that should be monitored for re-organization out of the chain.
717 pub extern "C" fn ChannelMonitor_get_relevant_txids(this_arg: &ChannelMonitor) -> crate::c_types::derived::CVec_TxidZ {
718 let mut ret = unsafe { &*this_arg.inner }.get_relevant_txids();
719 let mut local_ret = Vec::new(); for mut item in ret.drain(..) { local_ret.push( { crate::c_types::ThirtyTwoBytes { data: item.into_inner() } }); };
723 /// `Persist` defines behavior for persisting channel monitors: this could mean
724 /// writing once to disk, and/or uploading to one or more backup services.
726 /// Note that for every new monitor, you **must** persist the new `ChannelMonitor`
727 /// to disk/backups. And, on every update, you **must** persist either the
728 /// `ChannelMonitorUpdate` or the updated monitor itself. Otherwise, there is risk
729 /// of situations such as revoking a transaction, then crashing before this
730 /// revocation can be persisted, then unintentionally broadcasting a revoked
731 /// transaction and losing money. This is a risk because previous channel states
732 /// are toxic, so it's important that whatever channel state is persisted is
736 /// An opaque pointer which is passed to your function implementations as an argument.
737 /// This has no meaning in the LDK, and can be NULL or any other value.
738 pub this_arg: *mut c_void,
739 /// Persist a new channel's data. The data can be stored any way you want, but
740 /// the identifier provided by Rust-Lightning is the channel's outpoint (and
741 /// it is up to you to maintain a correct mapping between the outpoint and the
742 /// stored channel data). Note that you **must** persist every new monitor to
743 /// disk. See the `Persist` trait documentation for more details.
745 /// See [`ChannelMonitor::write`] for writing out a `ChannelMonitor`,
746 /// and [`ChannelMonitorUpdateErr`] for requirements when returning errors.
748 pub persist_new_channel: extern "C" fn (this_arg: *const c_void, id: crate::lightning::chain::transaction::OutPoint, data: &crate::lightning::chain::channelmonitor::ChannelMonitor) -> crate::c_types::derived::CResult_NoneChannelMonitorUpdateErrZ,
749 /// Update one channel's data. The provided `ChannelMonitor` has already
750 /// applied the given update.
752 /// Note that on every update, you **must** persist either the
753 /// `ChannelMonitorUpdate` or the updated monitor itself to disk/backups. See
754 /// the `Persist` trait documentation for more details.
756 /// If an implementer chooses to persist the updates only, they need to make
757 /// sure that all the updates are applied to the `ChannelMonitors` *before*
758 /// the set of channel monitors is given to the `ChannelManager`
759 /// deserialization routine. See [`ChannelMonitor::update_monitor`] for
760 /// applying a monitor update to a monitor. If full `ChannelMonitors` are
761 /// persisted, then there is no need to persist individual updates.
763 /// Note that there could be a performance tradeoff between persisting complete
764 /// channel monitors on every update vs. persisting only updates and applying
765 /// them in batches. The size of each monitor grows `O(number of state updates)`
766 /// whereas updates are small and `O(1)`.
768 /// See [`ChannelMonitor::write`] for writing out a `ChannelMonitor`,
769 /// [`ChannelMonitorUpdate::write`] for writing out an update, and
770 /// [`ChannelMonitorUpdateErr`] for requirements when returning errors.
772 pub update_persisted_channel: extern "C" fn (this_arg: *const c_void, id: crate::lightning::chain::transaction::OutPoint, update: &crate::lightning::chain::channelmonitor::ChannelMonitorUpdate, data: &crate::lightning::chain::channelmonitor::ChannelMonitor) -> crate::c_types::derived::CResult_NoneChannelMonitorUpdateErrZ,
773 /// Frees any resources associated with this object given its this_arg pointer.
774 /// Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
775 pub free: Option<extern "C" fn(this_arg: *mut c_void)>,
777 unsafe impl Send for Persist {}
778 unsafe impl Sync for Persist {}
780 use lightning::chain::channelmonitor::Persist as rustPersist;
781 impl rustPersist<crate::lightning::chain::keysinterface::Sign> for Persist {
782 fn persist_new_channel(&self, mut id: lightning::chain::transaction::OutPoint, mut data: &lightning::chain::channelmonitor::ChannelMonitor<crate::lightning::chain::keysinterface::Sign>) -> Result<(), lightning::chain::channelmonitor::ChannelMonitorUpdateErr> {
783 let mut ret = (self.persist_new_channel)(self.this_arg, crate::lightning::chain::transaction::OutPoint { inner: Box::into_raw(Box::new(id)), is_owned: true }, &crate::lightning::chain::channelmonitor::ChannelMonitor { inner: unsafe { (data as *const _) as *mut _ }, is_owned: false });
784 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() })};
787 fn update_persisted_channel(&self, mut id: lightning::chain::transaction::OutPoint, mut update: &lightning::chain::channelmonitor::ChannelMonitorUpdate, mut data: &lightning::chain::channelmonitor::ChannelMonitor<crate::lightning::chain::keysinterface::Sign>) -> Result<(), lightning::chain::channelmonitor::ChannelMonitorUpdateErr> {
788 let mut ret = (self.update_persisted_channel)(self.this_arg, crate::lightning::chain::transaction::OutPoint { inner: Box::into_raw(Box::new(id)), is_owned: true }, &crate::lightning::chain::channelmonitor::ChannelMonitorUpdate { inner: unsafe { (update as *const _) as *mut _ }, is_owned: false }, &crate::lightning::chain::channelmonitor::ChannelMonitor { inner: unsafe { (data as *const _) as *mut _ }, is_owned: false });
789 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() })};
794 // We're essentially a pointer already, or at least a set of pointers, so allow us to be used
795 // directly as a Deref trait in higher-level structs:
796 impl std::ops::Deref for Persist {
798 fn deref(&self) -> &Self {
802 /// Calls the free function if one is set
804 pub extern "C" fn Persist_free(this_ptr: Persist) { }
805 impl Drop for Persist {
807 if let Some(f) = self.free {
813 /// Read a C2Tuple_BlockHashChannelMonitorZ from a byte array, created by C2Tuple_BlockHashChannelMonitorZ_write
814 pub extern "C" fn C2Tuple_BlockHashChannelMonitorZ_read(ser: crate::c_types::u8slice, arg: &crate::lightning::chain::keysinterface::KeysInterface) -> crate::c_types::derived::CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ {
816 let res: Result<(bitcoin::hash_types::BlockHash, lightning::chain::channelmonitor::ChannelMonitor<crate::lightning::chain::keysinterface::Sign>), lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj_arg(ser, arg_conv);
817 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::lightning::chain::channelmonitor::ChannelMonitor { inner: Box::into_raw(Box::new(orig_res_0_1)), is_owned: true }).into(); local_res_0 }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::ln::msgs::DecodeError { inner: Box::into_raw(Box::new(e)), is_owned: true } }).into() };